diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 998aa1b8d..bcd7b4f70 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -39,7 +39,7 @@ jobs: with: webroot: ${{ github.workspace }} execute: /build-all.cfm - luceeVersion: 6.1.0.238-SNAPSHOT + luceeVersion: 6.2.0.164-SNAPSHOT # redis, chart, lucene, form. ajax, chart extensions: 60772C12-F179-D555-8E2CD2B4F7428718;version=3.0.0.54-SNAPSHOT,D46B46A9-A0E3-44E1-D972A04AC3A8DC10,EFDEB172-F52E-4D84-9CD1A1F561B3DFC8,FAD67145-E3AE-30F8-1C11A6CCF544F0B7,6E2CB28F-98FB-4B51-B6BE6C64ADF35473,DF28D0A4-6748-44B9-A2FDC12E4E2E4D38 - name: Upload Artifact diff --git a/builders/html/templates/category.cfm b/builders/html/templates/category.cfm index cab6315bd..0237cdd4a 100644 --- a/builders/html/templates/category.cfm +++ b/builders/html/templates/category.cfm @@ -8,13 +8,24 @@ local.pages = args.docTree.sortPagesByType( local.pages ); local.currentPageType = ""; - local.pageTypeTitles = { - "function" = "Functions", - "_method" = "Methods", - "_object" = "Objects", - "tag" = "Tags", - "category" = "Categories", - }; + // this enforces the sub category order + local.pageTypeTitles = [ + "function" = { title="Functions", pages=0 }, + "tag" = { title="Tags", pages=0 }, + "_method" = { title="Methods", pages=0 }, + "_object" = { title="Objects", pages=0 }, + "category" = { title="Categories", pages=0 }, + "page" = { title="Guides",pages=0 } + ]; + + local.missingPageTypes = {}; + loop array="#local.pages#" index="local.i" item="local.page" { + if ( !structKeyExists(local.pageTypeTitles, local.page.getPageType() ) ) { + request.logger (text="Unknown page type: [ #local.page.getPageType()# ] page [#local.page.getSourceFile()#] defaulting to [page.md]", type="WARN"); + local.page.setPageType("page"); + } + local.pageTypeTitles[local.page.getPageType()].pages++; + } @@ -25,18 +36,17 @@

There are no pages tagged with this category.

- - - - - - -

#( local.pageTypeTitles[ local.page.getPageType() ] ?: "Guides" )#

+ + +

#( local.pageType.title )#

    + + +
  • [[#htmleditformat(local.page.getId())#]] #htmleditformat( getMetaDescription(local.page, local.page.getBody()) )#
    • +     +     +
- -
  • [[#htmleditformat(local.page.getId())#]] #htmleditformat( getMetaDescription(local.page, local.page.getBody()) )#
    •  -     \ No newline at end of file diff --git a/builders/html/templates/changelog.cfm b/builders/html/templates/changelog.cfm index 184d19109..469d59e80 100644 --- a/builders/html/templates/changelog.cfm +++ b/builders/html/templates/changelog.cfm @@ -84,6 +84,8 @@ #getEditLink(path=local.changeLog.getSourceFile(), edit=args.edit)# #_markdownToHtml( local.changeLog.getBody() )# + +

    Generated from #server.lucee.version#

      diff --git a/docs/00.home/homepage.md b/docs/00.home/homepage.md index ee4998c6b..f03f6160c 100644 --- a/docs/00.home/homepage.md +++ b/docs/00.home/homepage.md @@ -16,11 +16,16 @@ Our documentation is an open source and community driven effort. It is also a co To find out more about getting involved as a developer with Lucee, checkout our [Git Repo](https://github.com/lucee/Lucee/blob/6.0/CONTRIBUTING.md) +## Lucee 6.2 + +Lucee 6.2 is our upcoming next major release, including enhanced Java and Maven integration, with even better runtime performance. + ## Lucee 6.1 Lucee 6.1 is current stable release of Lucee. -Targeting better performance and reduced memory usuage, Lucee 6.1 has full support for Java 11 and 21. +Targeting better performance and reduced memory usage, Lucee 6.1 introduces full support for Java 17 and 21, as well as Java 11. +Java 8 is no longer officially supported. ## Lucee 6.0 @@ -34,6 +39,8 @@ As a Major Release, Lucee 6 does include some potential **BREAKING CHANGES**, fo Lucee 5.4 is our [LTS stable release](https://lucee.org/downloads.html) and is recommended for production systems. More details are available in the [Lucee 5](/guides/lucee-5.html) section of these docs. +Only Java 8 and 11 are supported, there are various changes in Java 21 including date time handling which are not addressed in 5.4, time to upgrade! + As a LTS release, Lucee 5.4 will receive security updates and critical regression fixes until 2026, **but is no longer actively maintained.** ## Getting help @@ -43,7 +50,7 @@ As a LTS release, Lucee 5.4 will receive security updates and critical regressio ## Lucee 5.3 -Lucee 5.3 (and older) now is no longer actively developed. It's time to upgrade to 5.4 LTS or 6 (reommended) +Lucee 5.3 (and older) now is no longer actively developed. It's time to upgrade to 5.4 LTS or 6 (recommended) ## Lucee 4.5 diff --git a/docs/03.reference/01.functions/deserializejson/_arguments/format.md b/docs/03.reference/01.functions/deserializejson/_arguments/format.md new file mode 100644 index 000000000..8f03d44d0 --- /dev/null +++ b/docs/03.reference/01.functions/deserializejson/_arguments/format.md @@ -0,0 +1,4 @@ +The format of the input string. Possible values are: + +- **json**: Standard JSON format +- **json5**: JSON5 format which allows additional features such as comments and unquoted keys \ No newline at end of file diff --git a/docs/03.reference/01.functions/gatewayaction/_arguments/action.md b/docs/03.reference/01.functions/gatewayaction/_arguments/action.md new file mode 100644 index 000000000..dc71ee33e --- /dev/null +++ b/docs/03.reference/01.functions/gatewayaction/_arguments/action.md @@ -0,0 +1 @@ +action to execute, possible values are [start,stop and restart] \ No newline at end of file diff --git a/docs/03.reference/01.functions/gatewayaction/_arguments/gatewayID.md b/docs/03.reference/01.functions/gatewayaction/_arguments/gatewayID.md new file mode 100644 index 000000000..74d5ed8d3 --- /dev/null +++ b/docs/03.reference/01.functions/gatewayaction/_arguments/gatewayID.md @@ -0,0 +1 @@ +Identifier of the gateway to do the action on. \ No newline at end of file diff --git a/docs/03.reference/01.functions/gatewayaction/_arguments/timeout.md b/docs/03.reference/01.functions/gatewayaction/_arguments/timeout.md new file mode 100644 index 000000000..14c93baef --- /dev/null +++ b/docs/03.reference/01.functions/gatewayaction/_arguments/timeout.md @@ -0,0 +1 @@ +in case `waitForIt` is set to `true`, this defines how long we wait for the process to end, default is one second. \ No newline at end of file diff --git a/docs/03.reference/01.functions/gatewayaction/_arguments/waitForIt.md b/docs/03.reference/01.functions/gatewayaction/_arguments/waitForIt.md new file mode 100644 index 000000000..808ed7873 --- /dev/null +++ b/docs/03.reference/01.functions/gatewayaction/_arguments/waitForIt.md @@ -0,0 +1 @@ +Wait for the process to end (starting, stopping or restarting) \ No newline at end of file diff --git a/docs/03.reference/01.functions/gatewayaction/_returnTypeDesc.md b/docs/03.reference/01.functions/gatewayaction/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/gatewayaction/_usageNotes.md b/docs/03.reference/01.functions/gatewayaction/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/gatewayaction/function.md b/docs/03.reference/01.functions/gatewayaction/function.md new file mode 100644 index 000000000..44d70ac52 --- /dev/null +++ b/docs/03.reference/01.functions/gatewayaction/function.md @@ -0,0 +1,8 @@ +--- +title: GatewayAction +id: function-gatewayaction +categories: +- gateways +--- + +Executes a specifc action for a gateway instance. diff --git a/docs/03.reference/01.functions/gatewaystate/_arguments/gatewayID.md b/docs/03.reference/01.functions/gatewaystate/_arguments/gatewayID.md new file mode 100644 index 000000000..856fef037 --- /dev/null +++ b/docs/03.reference/01.functions/gatewaystate/_arguments/gatewayID.md @@ -0,0 +1 @@ +Identifier of the gateway to get info for. \ No newline at end of file diff --git a/docs/03.reference/01.functions/gatewaystate/_returnTypeDesc.md b/docs/03.reference/01.functions/gatewaystate/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/gatewaystate/_usageNotes.md b/docs/03.reference/01.functions/gatewaystate/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/gatewaystate/function.md b/docs/03.reference/01.functions/gatewaystate/function.md new file mode 100644 index 000000000..d3c21f71a --- /dev/null +++ b/docs/03.reference/01.functions/gatewaystate/function.md @@ -0,0 +1,8 @@ +--- +title: GatewayState +id: function-gatewaystate +categories: +- gateways +--- + +Return the current state for the given gateway id. diff --git a/docs/03.reference/01.functions/isjson/_arguments/format.md b/docs/03.reference/01.functions/isjson/_arguments/format.md new file mode 100644 index 000000000..8f03d44d0 --- /dev/null +++ b/docs/03.reference/01.functions/isjson/_arguments/format.md @@ -0,0 +1,4 @@ +The format of the input string. Possible values are: + +- **json**: Standard JSON format +- **json5**: JSON5 format which allows additional features such as comments and unquoted keys \ No newline at end of file diff --git a/docs/03.reference/01.functions/javacast/_arguments/javaSettings.md b/docs/03.reference/01.functions/javacast/_arguments/javaSettings.md new file mode 100644 index 000000000..7e207e0d9 --- /dev/null +++ b/docs/03.reference/01.functions/javacast/_arguments/javaSettings.md @@ -0,0 +1 @@ +javasettings to use to load the class \ No newline at end of file diff --git a/docs/03.reference/01.functions/mavenload/_arguments/input.md b/docs/03.reference/01.functions/mavenload/_arguments/input.md new file mode 100644 index 000000000..0b595632a --- /dev/null +++ b/docs/03.reference/01.functions/mavenload/_arguments/input.md @@ -0,0 +1 @@ +A struct or an array of structs specifying the Maven coordinates, including groupId, artifactId, and version. \ No newline at end of file diff --git a/docs/03.reference/01.functions/mavenload/_returnTypeDesc.md b/docs/03.reference/01.functions/mavenload/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/mavenload/_usageNotes.md b/docs/03.reference/01.functions/mavenload/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/mavenload/function.md b/docs/03.reference/01.functions/mavenload/function.md new file mode 100644 index 000000000..874a1296b --- /dev/null +++ b/docs/03.reference/01.functions/mavenload/function.md @@ -0,0 +1,32 @@ +--- +title: MavenLoad +id: function-mavenload +related: +- function-createobject +categories: +- classloading +- dependencies +- jars +- java +- maven +--- + +Loads all JAR files from one or more Maven endpoints and makes them available for use within the Lucee server environment. +This function can be used to load dependencies, including transitive ones, for example at server startup. + +### Example Usage of MavenLoad Function + +The `MavenLoad` function allows you to load JAR files from Maven repositories, including all transitive dependencies. +This is particularly useful during server startup to ensure that all required libraries are available. + +#### Example Input as an Array of Structs: + +```cfml +mavenLoad([ +{ +"groupId": "org.slf4j", +"artifactId": "slf4j-api", +"version": "1.7.32" +} +]); +``` diff --git a/docs/03.reference/01.functions/s3createbucket/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3createbucket/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3createbucket/_arguments/accessKeyId.md @@ -0,0 +1 @@ +S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid]. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3createbucket/_arguments/acl.md b/docs/03.reference/01.functions/s3createbucket/_arguments/acl.md new file mode 100644 index 000000000..344224b91 --- /dev/null +++ b/docs/03.reference/01.functions/s3createbucket/_arguments/acl.md @@ -0,0 +1 @@ +an array of struct where each struct represents an ACL grant \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3createbucket/_arguments/bucketName.md b/docs/03.reference/01.functions/s3createbucket/_arguments/bucketName.md new file mode 100644 index 000000000..f2251ed81 --- /dev/null +++ b/docs/03.reference/01.functions/s3createbucket/_arguments/bucketName.md @@ -0,0 +1 @@ +Name of the bucket to create \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3createbucket/_arguments/host.md b/docs/03.reference/01.functions/s3createbucket/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3createbucket/_arguments/host.md @@ -0,0 +1 @@ +the provider to connect, if not set Amazon AWS is used. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3createbucket/_arguments/location.md b/docs/03.reference/01.functions/s3createbucket/_arguments/location.md new file mode 100644 index 000000000..8192280ae --- /dev/null +++ b/docs/03.reference/01.functions/s3createbucket/_arguments/location.md @@ -0,0 +1 @@ +location of the S3 storage. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3createbucket/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3createbucket/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3createbucket/_arguments/secretAccessKey.md @@ -0,0 +1 @@ +S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey]. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3createbucket/_arguments/timeout.md b/docs/03.reference/01.functions/s3createbucket/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3createbucket/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3createbucket/_returnTypeDesc.md b/docs/03.reference/01.functions/s3createbucket/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3createbucket/_usageNotes.md b/docs/03.reference/01.functions/s3createbucket/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3createbucket/function.md b/docs/03.reference/01.functions/s3createbucket/function.md new file mode 100644 index 000000000..f21e0cad8 --- /dev/null +++ b/docs/03.reference/01.functions/s3createbucket/function.md @@ -0,0 +1,9 @@ +--- +title: s3createbucket +id: function-s3createbucket +related: +categories: +- s3 +--- + +Creates a bucket on S3. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3deletebucket/function.md b/docs/03.reference/01.functions/s3deletebucket/function.md index bcd655a52..3a05f158f 100644 --- a/docs/03.reference/01.functions/s3deletebucket/function.md +++ b/docs/03.reference/01.functions/s3deletebucket/function.md @@ -2,7 +2,7 @@ title: s3deletebucket id: function-s3deletebucket related: -categories: +- function-s3delete --- -deletes a bucket, this function is deprecated, use instead S3Delete. \ No newline at end of file +deletes a bucket, this function is deprecated, use instead [[function-S3Delete]]. diff --git a/docs/03.reference/01.functions/s3download/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3download/_arguments/accessKeyId.md new file mode 100644 index 000000000..31eb00436 --- /dev/null +++ b/docs/03.reference/01.functions/s3download/_arguments/accessKeyId.md @@ -0,0 +1 @@ +S3 `accessKeyId`, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid]. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3download/_arguments/bucketName.md b/docs/03.reference/01.functions/s3download/_arguments/bucketName.md new file mode 100644 index 000000000..c51a2090b --- /dev/null +++ b/docs/03.reference/01.functions/s3download/_arguments/bucketName.md @@ -0,0 +1 @@ +Name of the bucket to download. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3download/_arguments/charset.md b/docs/03.reference/01.functions/s3download/_arguments/charset.md new file mode 100644 index 000000000..dd342745e --- /dev/null +++ b/docs/03.reference/01.functions/s3download/_arguments/charset.md @@ -0,0 +1 @@ +charset to use to store the content. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3download/_arguments/host.md b/docs/03.reference/01.functions/s3download/_arguments/host.md new file mode 100644 index 000000000..f2b3e9e1b --- /dev/null +++ b/docs/03.reference/01.functions/s3download/_arguments/host.md @@ -0,0 +1 @@ +The provider to connect, if not set Amazon AWS is used. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3download/_arguments/objectName.md b/docs/03.reference/01.functions/s3download/_arguments/objectName.md new file mode 100644 index 000000000..cce534391 --- /dev/null +++ b/docs/03.reference/01.functions/s3download/_arguments/objectName.md @@ -0,0 +1 @@ +Name of the object to download. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3download/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3download/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3download/_arguments/secretAccessKey.md @@ -0,0 +1 @@ +S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey]. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3download/_arguments/target.md b/docs/03.reference/01.functions/s3download/_arguments/target.md new file mode 100644 index 000000000..860869099 --- /dev/null +++ b/docs/03.reference/01.functions/s3download/_arguments/target.md @@ -0,0 +1,13 @@ +Optional. Defines the target where the downloaded data will be directed. + +If a file path is provided, the data is saved to that path, the file path must be provided with help of the function "fileOpen" like this [fileOpen(path,"write")]. + +If a closure or function is given, it will be invoked with parts of the downloaded data as its argument. +The function should accept a single argument named 'line' for line-by-line processing, +'string{Number}' for string blocks of a specified size, +or 'binary{Number}' for binary blocks of a specified size. + +The function should return a boolean value: returning false will stop further reading from S3, +while true will continue the process. + +If this argument is omitted, the function returns the downloaded data directly. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3download/_arguments/timeout.md b/docs/03.reference/01.functions/s3download/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3download/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3download/_returnTypeDesc.md b/docs/03.reference/01.functions/s3download/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3download/_usageNotes.md b/docs/03.reference/01.functions/s3download/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3download/function.md b/docs/03.reference/01.functions/s3download/function.md new file mode 100644 index 000000000..4ae2e30c1 --- /dev/null +++ b/docs/03.reference/01.functions/s3download/function.md @@ -0,0 +1,9 @@ +--- +title: s3download +id: function-s3download +categories: +- s3 +--- + +Downloads an object from an S3 bucket. +It can save the object to a specified path, return its content directly, or process the content in parts through a provided closure or UDF (User-Defined Function). diff --git a/docs/03.reference/01.functions/s3getversioninfo/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3getversioninfo/_arguments/accessKeyId.md new file mode 100644 index 000000000..b973ecdab --- /dev/null +++ b/docs/03.reference/01.functions/s3getversioninfo/_arguments/accessKeyId.md @@ -0,0 +1 @@ +S3 accessKeyId. If not defined, checks the system property/environment variable for [lucee.s3.accesskeyid]. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getversioninfo/_arguments/bucketName.md b/docs/03.reference/01.functions/s3getversioninfo/_arguments/bucketName.md new file mode 100644 index 000000000..9642f0777 --- /dev/null +++ b/docs/03.reference/01.functions/s3getversioninfo/_arguments/bucketName.md @@ -0,0 +1 @@ +Name of the bucket to get info for. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getversioninfo/_arguments/host.md b/docs/03.reference/01.functions/s3getversioninfo/_arguments/host.md new file mode 100644 index 000000000..1cb1e0f3e --- /dev/null +++ b/docs/03.reference/01.functions/s3getversioninfo/_arguments/host.md @@ -0,0 +1 @@ +The provider to connect to. If not set, Amazon AWS is used. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getversioninfo/_arguments/objectName.md b/docs/03.reference/01.functions/s3getversioninfo/_arguments/objectName.md new file mode 100644 index 000000000..d6cd7d98d --- /dev/null +++ b/docs/03.reference/01.functions/s3getversioninfo/_arguments/objectName.md @@ -0,0 +1 @@ +Name of the object (path) within the bucket to get info for. If not defined, info of the bucket is returned. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getversioninfo/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3getversioninfo/_arguments/secretAccessKey.md new file mode 100644 index 000000000..3a9041a72 --- /dev/null +++ b/docs/03.reference/01.functions/s3getversioninfo/_arguments/secretAccessKey.md @@ -0,0 +1 @@ +S3 secretAccessKey. If not defined, checks the system property/environment variable for [lucee.s3.secretaccesskey]. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getversioninfo/_arguments/timeout.md b/docs/03.reference/01.functions/s3getversioninfo/_arguments/timeout.md new file mode 100644 index 000000000..2e472cf89 --- /dev/null +++ b/docs/03.reference/01.functions/s3getversioninfo/_arguments/timeout.md @@ -0,0 +1 @@ +Timeout for this execution (in milliseconds). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getversioninfo/_returnTypeDesc.md b/docs/03.reference/01.functions/s3getversioninfo/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3getversioninfo/_usageNotes.md b/docs/03.reference/01.functions/s3getversioninfo/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3getversioninfo/function.md b/docs/03.reference/01.functions/s3getversioninfo/function.md new file mode 100644 index 000000000..c2822ef06 --- /dev/null +++ b/docs/03.reference/01.functions/s3getversioninfo/function.md @@ -0,0 +1,9 @@ +--- +title: s3getversioninfo +id: function-s3getversioninfo +related: +categories: +- s3 +--- + +Returns version information as a query for a specific object or bucket. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3listbucket/_arguments/blockfactor.md b/docs/03.reference/01.functions/s3listbucket/_arguments/blockfactor.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3listbucket/_arguments/listener.md b/docs/03.reference/01.functions/s3listbucket/_arguments/listener.md new file mode 100644 index 000000000..5cbf0cc81 --- /dev/null +++ b/docs/03.reference/01.functions/s3listbucket/_arguments/listener.md @@ -0,0 +1,9 @@ +Optional. Defines the target where the downloaded data will be directed. +If a file path is provided, the data is saved to that path, the file path must be provided with help of the function "fileOpen" like this [fileOpen(path,"write")]. +If a closure or function is given, it will be invoked with parts of the downloaded data as its argument. +The function should accept a single argument named 'line' for line-by-line processing, +'string{Number}' for string blocks of a specified size, +or 'binary{Number}' for binary blocks of a specified size. +The function should return a boolean value: returning false will stop further reading from S3, +while true will continue the process. +If this argument is omitted, the function returns the downloaded data directly. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3upload/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/_arguments/accessKeyId.md @@ -0,0 +1 @@ +S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid]. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_arguments/acl.md b/docs/03.reference/01.functions/s3upload/_arguments/acl.md new file mode 100644 index 000000000..344224b91 --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/_arguments/acl.md @@ -0,0 +1 @@ +an array of struct where each struct represents an ACL grant \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_arguments/bucketName.md b/docs/03.reference/01.functions/s3upload/_arguments/bucketName.md new file mode 100644 index 000000000..3fd15f982 --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/_arguments/bucketName.md @@ -0,0 +1 @@ +Name of the bucket of your object to write \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_arguments/host.md b/docs/03.reference/01.functions/s3upload/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/_arguments/host.md @@ -0,0 +1 @@ +the provider to connect, if not set Amazon AWS is used. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_arguments/location.md b/docs/03.reference/01.functions/s3upload/_arguments/location.md new file mode 100644 index 000000000..8192280ae --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/_arguments/location.md @@ -0,0 +1 @@ +location of the S3 storage. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_arguments/objectName.md b/docs/03.reference/01.functions/s3upload/_arguments/objectName.md new file mode 100644 index 000000000..3f4371fca --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/_arguments/objectName.md @@ -0,0 +1 @@ +Name of the object (path) within the bucket of your object to write \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3upload/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/_arguments/secretAccessKey.md @@ -0,0 +1 @@ +S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey]. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_arguments/source.md b/docs/03.reference/01.functions/s3upload/_arguments/source.md new file mode 100644 index 000000000..12eadbc61 --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/_arguments/source.md @@ -0,0 +1 @@ +Source file to write to S3. A string path to a file or a object created with the function "fileOpen". \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_arguments/timeout.md b/docs/03.reference/01.functions/s3upload/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3upload/_returnTypeDesc.md b/docs/03.reference/01.functions/s3upload/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3upload/_usageNotes.md b/docs/03.reference/01.functions/s3upload/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3upload/function.md b/docs/03.reference/01.functions/s3upload/function.md new file mode 100644 index 000000000..2702bed5b --- /dev/null +++ b/docs/03.reference/01.functions/s3upload/function.md @@ -0,0 +1,9 @@ +--- +title: s3upload +id: function-s3upload +related: +categories: +- s3 +--- + +Uploads a file to S3. \ No newline at end of file diff --git a/docs/03.reference/02.tags/component/_attributes/accessors.md b/docs/03.reference/02.tags/component/_attributes/accessors.md new file mode 100644 index 000000000..d387b6ec1 --- /dev/null +++ b/docs/03.reference/02.tags/component/_attributes/accessors.md @@ -0,0 +1 @@ +If set to true, enables implicit getters and setters for the component's properties. For persistent CFCs, accessors are always enabled. \ No newline at end of file diff --git a/docs/03.reference/02.tags/component/_attributes/implements.md b/docs/03.reference/02.tags/component/_attributes/implements.md new file mode 100644 index 000000000..69175eb18 --- /dev/null +++ b/docs/03.reference/02.tags/component/_attributes/implements.md @@ -0,0 +1 @@ +Lists the interfaces that the component implements, specifying the set of functions that the component must provide. \ No newline at end of file diff --git a/docs/03.reference/02.tags/component/_attributes/modifier.md b/docs/03.reference/02.tags/component/_attributes/modifier.md new file mode 100644 index 000000000..03e2fc49e --- /dev/null +++ b/docs/03.reference/02.tags/component/_attributes/modifier.md @@ -0,0 +1 @@ +Defines the type of component: `none` for a regular component, `abstract` for a component that cannot be instantiated directly and must be extended, or `final` for a component that cannot be extended by other components. \ No newline at end of file diff --git a/docs/03.reference/02.tags/function/_attributes/consumes.md b/docs/03.reference/02.tags/function/_attributes/consumes.md new file mode 100644 index 000000000..b77d16f5e --- /dev/null +++ b/docs/03.reference/02.tags/function/_attributes/consumes.md @@ -0,0 +1 @@ +A comma-separated list of acceptable MIME types that the function can accept or consume. If no value is specified, all MIME types are consumed by default. Use this attribute to control the types of content the function can handle. This attribute overrides the `consumes` attribute at the component level. \ No newline at end of file diff --git a/docs/03.reference/02.tags/function/_attributes/httpmethod.md b/docs/03.reference/02.tags/function/_attributes/httpmethod.md new file mode 100644 index 000000000..fe4dd2e2f --- /dev/null +++ b/docs/03.reference/02.tags/function/_attributes/httpmethod.md @@ -0,0 +1,10 @@ +Specifies the HTTP method to use when calling the function as part of a RESTful service. Accepted values include: + +- `GET`: Requests information from the server. +- `POST`: Sends information to the server for processing. +- `PUT`: Requests the server to store the message body at the specified URL. +- `DELETE`: Requests the server to delete the specified URL. +- `HEAD`: Similar to GET but without a response body. +- `OPTIONS`: Requests information about the communication options available for the server or the specified URL. + +If not specified, the `GET` method is used by default. \ No newline at end of file diff --git a/docs/03.reference/02.tags/function/_attributes/produces.md b/docs/03.reference/02.tags/function/_attributes/produces.md new file mode 100644 index 000000000..b8e91fdb0 --- /dev/null +++ b/docs/03.reference/02.tags/function/_attributes/produces.md @@ -0,0 +1 @@ +A comma-separated list of MIME types that the function can produce. The function will respond with the most acceptable media type as declared by the client. This attribute overrides the `produces` attribute at the component level. \ No newline at end of file diff --git a/docs/03.reference/02.tags/function/_attributes/restpath.md b/docs/03.reference/02.tags/function/_attributes/restpath.md new file mode 100644 index 000000000..bc4e3a390 --- /dev/null +++ b/docs/03.reference/02.tags/function/_attributes/restpath.md @@ -0,0 +1 @@ +Defines a sub-resource path for the function when used as part of a RESTful web service. The path is case-sensitive and should avoid special characters. Regular expressions can be included in the path. \ No newline at end of file diff --git a/docs/03.reference/02.tags/import/tag.md b/docs/03.reference/02.tags/import/tag.md index d68fd8e76..533a2e330 100644 --- a/docs/03.reference/02.tags/import/tag.md +++ b/docs/03.reference/02.tags/import/tag.md @@ -2,7 +2,10 @@ title: id: tag-import related: +- function-createobject +- function-mavenload categories: +- java --- -To import a JSP Taglibrary or a CFML Custom Tag Directory \ No newline at end of file +To import a JSP Taglibrary or a CFML Custom Tag Directory diff --git a/docs/03.reference/05.objects/string/deserializejson/_arguments/format.md b/docs/03.reference/05.objects/string/deserializejson/_arguments/format.md new file mode 100644 index 000000000..8f03d44d0 --- /dev/null +++ b/docs/03.reference/05.objects/string/deserializejson/_arguments/format.md @@ -0,0 +1,4 @@ +The format of the input string. Possible values are: + +- **json**: Standard JSON format +- **json5**: JSON5 format which allows additional features such as comments and unquoted keys \ No newline at end of file diff --git a/docs/03.reference/130.changelog/changelog.md b/docs/03.reference/130.changelog/changelog.md index c22aef8b4..c0bd2a62b 100644 --- a/docs/03.reference/130.changelog/changelog.md +++ b/docs/03.reference/130.changelog/changelog.md @@ -1,6 +1,9 @@ --- -title: Lucee Change Log, new Tags & Functions, Arguments and Attributes +title: Lucee Changelog, new Tags & Functions, Arguments and Attributes id: changelog +categories: +- compat +- core menuTitle: Change Log --- diff --git a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/08.Configuring-SES-url-on-windows/page.md b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/08.Configuring-SES-url-on-windows/page.md index dbb2356d7..6f79f1dd3 100644 --- a/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/08.Configuring-SES-url-on-windows/page.md +++ b/docs/04.guides/02.installing-lucee/10.lucee-server-adminstration-windows/08.Configuring-SES-url-on-windows/page.md @@ -31,7 +31,7 @@ If your site doesn't have something in the URL to key off of, then you're going /*=ajp13 -However, at this point IIS will be pretty useless. The only thing it will be doing is handing off requests to Tomcat. You may want to consider removing IIS and just [[utilizing-tomcat-built-in-web-server]]. +However, at this point IIS will be pretty useless. The only thing it will be doing is handing off requests to Tomcat. You may want to consider removing IIS and just [[windows-utilizing-tomcat-built-in-web-server]]. ### Configuring Tomcat ### diff --git a/docs/04.guides/04.cookbooks/24.Query-Handling/page.md b/docs/04.guides/04.cookbooks/24.Query-Handling/page.md index 0078bd7f2..c2f21a7bf 100644 --- a/docs/04.guides/04.cookbooks/24.Query-Handling/page.md +++ b/docs/04.guides/04.cookbooks/24.Query-Handling/page.md @@ -44,7 +44,7 @@ Passing values with [[tag-QueryParam]] has two advantages: ### Params ### -Here we use params as part of [[tag-cfquery]] tag, used to pass the value with SQL statement. +Here we use params as part of [[tag-query]] tag, used to pass the value with SQL statement. Pass the params value with struct diff --git a/docs/04.guides/13.Various/05.command-line-interface/page.md b/docs/04.guides/13.Various/05.command-line-interface/page.md index bf06a9b2a..d9311f649 100644 --- a/docs/04.guides/13.Various/05.command-line-interface/page.md +++ b/docs/04.guides/13.Various/05.command-line-interface/page.md @@ -12,7 +12,7 @@ Right now, at the beginning, we would like to lay a solid foundation for the fut To this end, feel free to hop into the user group and join the conversation! -### Download ### +### Commandbox ### The CLI is currently available for Windows (win32 version), Linux and OS X (bin version). @@ -26,8 +26,6 @@ It is available with or without a JRE, and there is an experimental "CLI Express [https://commandbox.ortusbooks.com/getting-started-guide](https://commandbox.ortusbooks.com/getting-started-guide) -[https://commandbox.ortusbooks.com/getting-started-guide](https://commandbox.ortusbooks.com/getting-started-guide) - ### Installation ### Call lucee or lucee.exe (depending on OS) directly, or put it somewhere in your system path, or modify your system path to include the executable's location. diff --git a/docs/05.categories/090.esapi/category.md b/docs/05.categories/090.esapi/category.md index 455c7764f..17683a51f 100644 --- a/docs/05.categories/090.esapi/category.md +++ b/docs/05.categories/090.esapi/category.md @@ -1,7 +1,8 @@ --- title: Encode/Decode id: category-esapi -related: +categories: +- category-core --- -Enterprise Security API +Used to prevent XSS, these functions use the ESAPI (Enterprise Security API) library to safely handle user input. diff --git a/docs/recipes/ai-for-documentation.md b/docs/recipes/ai-for-documentation.md index ec55f9a20..06985dcf8 100644 --- a/docs/recipes/ai-for-documentation.md +++ b/docs/recipes/ai-for-documentation.md @@ -38,6 +38,7 @@ To enable AI in the Documentation tab of the Monitor, set up a compatible AI con Below are example configurations to enable AI functionality in the Documentation tab, important here is the `default` setting. **OpenAI (ChatGPT) Configuration Example:** + ```json "ai": { "docChatGPT": { diff --git a/docs/recipes/ai.md b/docs/recipes/ai.md index a677d20e2..25a776aff 100644 --- a/docs/recipes/ai.md +++ b/docs/recipes/ai.md @@ -19,6 +19,7 @@ Lucee 6.2 includes experimental support for AI integration, which will be finali In Lucee 6.2, AI connections can be configured similarly to datasources or caches, either in the Lucee Administrator or directly in `.CFConfig.json`. Here are sample configurations: **OpenAI (ChatGPT) Example:** + ```json "ai": { "mychatgpt": { @@ -36,6 +37,7 @@ In Lucee 6.2, AI connections can be configured similarly to datasources or cache ``` **Google Gemini Example:** + ```json "ai": { "mygemini": { @@ -51,6 +53,7 @@ In Lucee 6.2, AI connections can be configured similarly to datasources or cache ``` **Ollama (Local) Example:** + ```json "ai": { "gemma2": { @@ -68,6 +71,7 @@ In Lucee 6.2, AI connections can be configured similarly to datasources or cache In these examples, ChatGPT from OpenAI, Gemini from Google, and Ollama for local use are set up. The `OpenAIEngine` allows configuration for `openai` or `ollama` types and can also connect to any service using the OpenAI REST interface by specifying a URL: **OpenAI REST Interface Example:** + ```json "ai": { "lucy": { @@ -110,6 +114,7 @@ You can interact with AI directly via Lucee functions and tags. At the moment, these functions use the prefix `Lucee` to avoid conflicts with existing functions in your code. With Lucee 7, we plan to remove the prefix (but still support it as an alias). **Direct Interaction Example:** + ```javascript // start a session with a specic AI endpoint slim = LuceeCreateAISession(name:'gemma2', systemMessage:"Answer as Slim Shady."); @@ -136,7 +141,7 @@ This feature is still a work in progress, and we are working to improve the qual ### Monitor Documentation Tab In the Monitor's Documentation tab, AI can answer questions about Lucee based on retrieval-augmented generation (RAG) with available documentation and links to related documents. -This feature is also in development for enhanced input quality (read more about Monitor Documentation here https://github.com/lucee/lucee-docs/blob/master/docs/recipes/monitoring-debugging.md). +This feature is also in development for enhanced input quality (read more about [https://github.com/lucee/lucee-docs/blob/master/docs/recipes/monitoring-debugging.md](Monitor Documentation) ). ## Future Development diff --git a/docs/recipes/breaking-changes-6-1.md b/docs/recipes/breaking-changes-6-1.md index 0246dcf2c..92a3784e8 100644 --- a/docs/recipes/breaking-changes-6-1.md +++ b/docs/recipes/breaking-changes-6-1.md @@ -1,5 +1,4 @@ -