Merge branch 'master' of https://github.com/lucee/lucee-docs

.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

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++;
+	}
 </cfscript>
 
 
@@ -25,18 +36,17 @@
 	<cfif not pages.len()>
 		<p><em>There are no pages tagged with this category.</em></p>
 	<cfelse>
-		<cfloop array="#local.pages#" index="local.i" item="local.page">
-			<cfif local.page.getPageType() != local.currentPageType>
-				<cfif local.currentPageType.len()>
-					</ul>
-				</cfif>
-				<cfset local.currentPageType = local.page.getPageType()>
-				<h2>#( local.pageTypeTitles[ local.page.getPageType() ] ?: "Guides" )#</h2>
+		<cfloop collection="#local.pageTypeTitles#" key="local.pageTypeKey" value="local.pageType">
+			<cfif local.pageType.pages gt 0>
+				<h2>#( local.pageType.title )#</h2>
 				<ul class="list-unstyled">
+				<cfloop array="#local.pages#" index="local.i" item="local.page">
+					<cfif local.pageTypeKey eq local.page.getPageType()>
+						<li>[[#htmleditformat(local.page.getId())#]] #htmleditformat( getMetaDescription(local.page, local.page.getBody()) )#</li>
+					</cfif>
+				</cfloop>
+				</ul>
 			</cfif>
-
-			<li>[[#htmleditformat(local.page.getId())#]] #htmleditformat( getMetaDescription(local.page, local.page.getBody()) )#</li>
 		</cfloop>
-		</ul>
 	</cfif>
 </cfoutput>

builders/html/templates/changelog.cfm

@@ -84,6 +84,8 @@
 
 	#getEditLink(path=local.changeLog.getSourceFile(), edit=args.edit)#
 	#_markdownToHtml( local.changeLog.getBody() )#
+
+	<p>Generated from <b>#server.lucee.version#</b></p>
 </cfoutput>
 
 <ul>

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
 

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

docs/03.reference/01.functions/gatewayaction/_arguments/action.md

@@ -0,0 +1 @@
+action to execute, possible values are [start,stop and restart]

docs/03.reference/01.functions/gatewayaction/_arguments/gatewayID.md

@@ -0,0 +1 @@
+Identifier of the gateway to do the action on.

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.

docs/03.reference/01.functions/gatewayaction/_arguments/waitForIt.md

@@ -0,0 +1 @@
+Wait for the process to end (starting, stopping or restarting)

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.

docs/03.reference/01.functions/gatewaystate/_arguments/gatewayID.md

@@ -0,0 +1 @@
+Identifier of the gateway to get info for.

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.

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

docs/03.reference/01.functions/javacast/_arguments/javaSettings.md

@@ -0,0 +1 @@
+javasettings to use to load the class

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.

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"
+}
+]);
+```

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].

docs/03.reference/01.functions/s3createbucket/_arguments/acl.md

@@ -0,0 +1 @@
+an array of struct where each struct represents an ACL grant

docs/03.reference/01.functions/s3createbucket/_arguments/bucketName.md

@@ -0,0 +1 @@
+Name of the bucket to create

docs/03.reference/01.functions/s3createbucket/_arguments/host.md

@@ -0,0 +1 @@
+the provider to connect, if not set Amazon AWS is used.

docs/03.reference/01.functions/s3createbucket/_arguments/location.md

@@ -0,0 +1 @@
+location of the S3 storage.

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].

docs/03.reference/01.functions/s3createbucket/_arguments/timeout.md

@@ -0,0 +1 @@
+timeout for this execution

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.

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.
+deletes a bucket, this function is deprecated, use instead [[function-S3Delete]].

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].

docs/03.reference/01.functions/s3download/_arguments/bucketName.md

@@ -0,0 +1 @@
+Name of the bucket to download.

docs/03.reference/01.functions/s3download/_arguments/charset.md

@@ -0,0 +1 @@
+charset to use to store the content.

docs/03.reference/01.functions/s3download/_arguments/host.md

@@ -0,0 +1 @@
+The provider to connect, if not set Amazon AWS is used.

docs/03.reference/01.functions/s3download/_arguments/objectName.md

@@ -0,0 +1 @@
+Name of the object to download.

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].

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.

docs/03.reference/01.functions/s3download/_arguments/timeout.md

@@ -0,0 +1 @@
+timeout for this execution

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).

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].

docs/03.reference/01.functions/s3getversioninfo/_arguments/bucketName.md

@@ -0,0 +1 @@
+Name of the bucket to get info for.

docs/03.reference/01.functions/s3getversioninfo/_arguments/host.md

@@ -0,0 +1 @@
+The provider to connect to. If not set, Amazon AWS is used.

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.

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].

docs/03.reference/01.functions/s3getversioninfo/_arguments/timeout.md

@@ -0,0 +1 @@
+Timeout for this execution (in milliseconds).

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.

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.

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].

docs/03.reference/01.functions/s3upload/_arguments/acl.md

@@ -0,0 +1 @@
+an array of struct where each struct represents an ACL grant

docs/03.reference/01.functions/s3upload/_arguments/bucketName.md

@@ -0,0 +1 @@
+Name of the bucket of your object to write

docs/03.reference/01.functions/s3upload/_arguments/host.md

@@ -0,0 +1 @@
+the provider to connect, if not set Amazon AWS is used.

docs/03.reference/01.functions/s3upload/_arguments/location.md

@@ -0,0 +1 @@
+location of the S3 storage.

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

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].

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".

docs/03.reference/01.functions/s3upload/_arguments/timeout.md

@@ -0,0 +1 @@
+timeout for this execution

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.

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.

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.

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.

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.

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.

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.

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.