Merge branch 'master' into remove-whitespace

.github/workflows/main.yml

@@ -11,6 +11,7 @@ on:
 jobs:
   # This workflow contains a single job called "build"
   build:
+    if: github.repository == 'lucee/lucee-docs'
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
     # Steps represent a sequence of tasks that will be executed as part of the job
@@ -38,9 +39,9 @@ jobs:
         with:
           webroot: ${{ github.workspace }}
           execute: /build-all.cfm
-          luceeVersion: 6.0.0.346-BETA
+          luceeVersion: 6.0.0.499-SNAPSHOT
           # redis, chart, lucene, form. ajax, chart
-          extensions: 60772C12-F179-D555-8E2CD2B4F7428718,D46B46A9-A0E3-44E1-D972A04AC3A8DC10,EFDEB172-F52E-4D84-9CD1A1F561B3DFC8,FAD67145-E3AE-30F8-1C11A6CCF544F0B7,6E2CB28F-98FB-4B51-B6BE6C64ADF35473,DF28D0A4-6748-44B9-A2FDC12E4E2E4D38
+          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
         uses: actions/upload-artifact@v3
         with:

README.md

@@ -17,7 +17,7 @@ The only optional dependency required is [CommandBox](https://www.ortussolutions
 
 CommandBox is only required to run the build process via the command line, or if you don't setup a virtual server with an existing local Lucee install.
 
-Ensure that commandbox is installed and that the `box` command is in your path.
+Ensure that CommandBox is installed and that the `box` command is in your path.
 
 ### Building the static documentation output
 
@@ -42,18 +42,18 @@ We have provided a utility server whose purpose is to run locally to help while
 
 This will spin up a server using CommandBox on port 4040 and open it in your browser. You should also see a tray icon that will allow you to stop the server. Changes to the source docs should trigger an internal rebuild of the documentation tree which may take a little longer than regular requests to the documentation.
 
-When running locally there are the following urls available (these URLs below are for a commandbox instance, substitute them with the URL for your virtual host if appropriate)
+When running locally there are the following URLs available (these URLs below are for a CommandBox instance, substitute them with the URL for your virtual host if appropriate)
 
 * [Lucee documentation home](http://127.0.0.1:4040/)
 * [Build all documentation](http://127.0.0.1:4040/build_docs/all/)
-* [Build html documentation](http://127.0.0.1:4040/build_docs/html/)
+* [Build HTML documentation](http://127.0.0.1:4040/build_docs/html/)
 * [Build dash documentation](http://127.0.0.1:4040/build_docs/dash/)
 * [Import any new tags or functions](http://127.0.0.1:4040/build_docs/import/)
-* [View static html docs](http://127.0.0.1:4040/static/) (you need to have built the html documentation first)
+* [View static HTML docs](http://127.0.0.1:4040/static/) (you need to have built the HTML documentation first)
 
 ## Working with the bundled JS and CSS files
 
-The build process for the JS and CSS bundles are found under /builders/html/assets and uses Sass and [Grunt](https://gruntjs.com/).
+The build process for the JS and CSS bundles are found under `/builders/html/assets` and uses Sass and [Grunt](https://gruntjs.com/).
 
 Just run npm install, then run grunt.
 
@@ -63,7 +63,7 @@ as the docs are statically deployed via Cloudfront and versioning of these files
 
 ## Contributing
 
-There is a lot of work to do and we appreciate contribution in all forms. The issues list can be found and expanded upon here: [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD)
+There is a lot of work to do, and we appreciate contribution in all forms. The issues list can be found and expanded upon here: [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD)
 
 Ask questions or post suggestions over on the [Lucee mailing List](https://dev.lucee.org/c/documentation) under the documentation category.
 
@@ -73,7 +73,7 @@ The workflow for contributions is:
 
 * Submit the contributor's agreement: <https://docs.lucee.org/guides/get-involved/contributing-contributors-agreement.html>
 * Fork lucee-docs on GitHub.
-* Make your changes in the master branch.
+* Make your changes in a new feature branch.
 * Push your changes to your GitHub repo.
 * Create a pull request.
 

api/build/BuildProperties.cfc

@@ -17,6 +17,6 @@ component accessors=true {
 	property name="issueTrackerLink" 		default=
 	"https://luceeserver.atlassian.net/secure/QuickSearch.jspa?jql=#urlEncodedFormat('text ~ "')#{search}#urlEncodedFormat('" ORDER BY updated')#";
 	property name="testCasesLink" 		default=
-	"https://github.com/search?q={search}+repo%3Alucee%2FLucee+path%3A%2Ftest&type=code";
+	"https://github.com/search?q={search}+repo%3Alucee%2FLucee+path%3A%2Ftest%2F%2A%2A&type=code";
 }
 

builders/html/assets/trycf/js/code-editor3.js

@@ -45,7 +45,7 @@ angular.module("code.editor", []).directive("codeEditor", function ($timeout) {
     '		<div class="modal fade" style="display:none;" tabindex="-1" role="dialog">' +
     '		  <div class="modal-dialog">' +
     '		    <div class="modal-content">' +
-    '		      <div class="modal-header page-header">' +
+    '		      <div class="modal-header page-header" style="margin: 5px;">' +
     '		        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>' +
     '		        <h4 class="modal-title">Editor Preferences</h4>' +
     "		      </div>" +
@@ -91,10 +91,9 @@ angular.module("code.editor", []).directive("codeEditor", function ($timeout) {
     "		        </div>" +
     '				<label class="control-label">Change CFML Engine</label>' +
     "		        <div>" +
-    '		         <select id="engine" class="form-control">' +
-    '		             <option value="lucee">Lucee 5.LATEST</option>' +
-    '		             <option value="lucee4">Lucee 4.5.LATEST</option>' +
-    "		             </select>" +
+    '		             <label class="radio-inline"><input type="radio" name="engine" class="luceeEngine" value="lucee6-beta">Lucee 6.BETA</label>' +
+    '		             <label class="radio-inline"><input type="radio" name="engine" class="luceeEngine" value="lucee">Lucee 5.LATEST</label>' +
+    '		             <label class="radio-inline"><input type="radio" name="engine" class="luceeEngine" value="lucee4">Lucee 4.5.LATEST</label>' +
     "		        </div>" +
     "		      </div>" +
     '		      <div class="modal-footer">' +
@@ -140,7 +139,10 @@ angular.module("code.editor", []).directive("codeEditor", function ($timeout) {
       scope.setupCodeGist = attrs.setupCodeGist;
       scope.asserts = attrs.asserts;
       scope.saveGist = saveGist;
-      scope.engines = { lucee4: "Lucee 4.5", lucee: "Lucee 5" };
+      scope.engines = { lucee4: "Lucee 4.5",
+        lucee: "Lucee 5",
+        "lucee6-beta": "Lucee 6 BETA"
+      };
       scope.engine = attrs.engine || "lucee";
       scope.basepath = attrs.basepath || "/gist/";
       var editor = element.find(".code-editor"),
@@ -207,6 +209,7 @@ angular.module("code.editor", []).directive("codeEditor", function ($timeout) {
         urlPool = {
           lucee4: ["https://lucee4-sbx.trycf.com/lucee4/getremote.cfm"],
           lucee: ["https://lucee5-sbx.trycf.com/lucee5/getremote.cfm"],
+          "lucee6-beta": ["https://lucee6-sbx.trycf.com/lucee/getremote.cfm"]
         },
         url =
           attrs.url ||
@@ -251,7 +254,7 @@ angular.module("code.editor", []).directive("codeEditor", function ($timeout) {
         });
         var langTools = ace.require("ace/ext/language_tools");
       }
-      element.find("#engine").val(scope.engine);
+      element.find("input.luceeEngine[type='radio'][value='" + scope.engine + "']").prop('checked',true);
       scope.$watch("code", function () {
         if (!isMobileDevice()) {
           session.setValue(scope.code);
@@ -364,7 +367,7 @@ angular.module("code.editor", []).directive("codeEditor", function ($timeout) {
           aceEditor.setTheme("ace/theme/" + $(this).val());
         });
       }
-      element.find("#engine").on("change", function (e) {
+      element.find(".luceeEngine").on("change", function (e) {
         scope.engine = $(this).val();
         displayEngine();
         url =

builders/html/templates/function.cfm

@@ -177,5 +177,8 @@
 		#_markdownToHtml( local.fn.getExamples() )#
 	<cfelse>
 		<em>There are currently no examples for this function</em>
+		<cfscript>
+			request.logger (text="No examples for function " & local.fn.getName(), type="WARN");
+		</cfscript>
 	</cfif>
 </cfoutput>

builders/html/templates/tag.cfm

@@ -22,6 +22,9 @@
 		</cfscript>
 		<p><strong>Status:</strong> #local.status#</p>
 	</cfif>
+	<cfif len(local.tag.getIntroduced()) gt 0>
+		<p><strong>Introduced:</strong> #local.tag.getIntroduced()#</p>
+	</cfif>
 	<cfif len(local.tag.getSrcExtension()) gt 0>
 		<p><strong>Requires Extension: </strong> #local.tag.getSrcExtension().name#</p>
 	</cfif>
@@ -141,5 +144,8 @@
 		#_markdownToHtml( local.tag.getExamples() )#
 	<cfelse>
 		<em>There are currently no examples for this tag.</em>
+		<cfscript>
+			request.logger (text="No examples for tag " & local.tag.getName(), type="WARN");
+		</cfscript>
 	</cfif>
 </cfoutput>

docs/00.home/homepage.md

@@ -21,15 +21,19 @@ To find out more about getting involved as a developer with Lucee, checkout our
 - Our mailing list / forum is over at [https://dev.lucee.org/](https://dev.lucee.org/)
 - [[tutorial-reporting-bugs]]
 
+## Lucee 5.4
+
+Lucee 5.4 is the [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.
+
 ## Lucee 6.0
 
-[Lucee 6](https://dev.lucee.org/tag/lucee-6) is the next major release of Lucee, currently in [development](https://luceeserver.atlassian.net/jira/software/c/projects/LDEV/boards/10?sprint=58).
+[Lucee 6](https://dev.lucee.org/tag/lucee-6) is the next major release of Lucee, currently in [development](https://luceeserver.atlassian.net/jira/software/c/projects/LDEV/boards/10?sprint=58).  See the [Lucee 6 category](https://dev.lucee.org/tag/lucee-6) on our developer forum.
 
 Highlights include, reduced size, faster startup, single context mode, json based configuration and much more.
 
 ## Lucee 5.3
 
-Lucee 5.3 is the [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.
+Lucee 5.3 now in maintenance mode and no longer actively developed. It will only be releasing critical bugfixes and security updates.
 
 ## Lucee 4.5
 

docs/03.reference/01.functions/applicationpathcacheclear/function.md

@@ -1,5 +1,5 @@
 ---
-title: applicationPathCacheClear
+title: ApplicationPathCacheClear
 id: function-applicationpathcacheclear
 categories:
 - application

docs/03.reference/01.functions/argon2checkhash/function.md

@@ -1,5 +1,5 @@
 ---
-title: argon2checkhash
+title: Argon2CheckHash
 id: function-argon2checkhash
 related:
 categories:

docs/03.reference/01.functions/arraynew/function.md

@@ -7,4 +7,4 @@ categories:
 - array
 ---
 
-create a new array. shorthand syntax is [].
+create a new array. Shorthand syntax is [].

docs/03.reference/01.functions/arrayremoveduplicates/_examples.md

@@ -0,0 +1,6 @@
+```luceescript+trycf
+arrayWithDupes=[ "Swansea Jack", "Bob the Railway Dog", "Banjo", "Cosmo", "Canelo", "Waghya", "Banjo", "Gelert", "Bob the Railway Dog", "Waghya", "Banjo", "Gelert" ];
+dump( arrayWithDupes );
+arrayWithoutDupes= arrayRemoveDuplicates( arrayWithDupes );
+dump( arrayWithoutDupes );
+```

docs/03.reference/01.functions/arrayremoveduplicates/function.md

@@ -1,5 +1,5 @@
 ---
-title: arrayremoveduplicates
+title: ArrayRemoveDuplicates
 id: function-arrayremoveduplicates
 related:
 categories:

docs/03.reference/01.functions/arraysplice/function.md

@@ -1,5 +1,5 @@
 ---
-title: arraysplice
+title: ArraySplice
 id: function-arraysplice
 related:
 categories:

docs/03.reference/01.functions/arraytostruct/_examples.md

@@ -3,6 +3,8 @@
 ```luceescript+trycf
 arr = ['a','b','c','d','e','f','g'];
 dump(arrayToStruct(arr));
+if (listFirst(server.lucee.version,".") gte 6)
+    dump(arrayToStruct(arr, true));
 
 //member function
 dump(arr.toStruct());
@@ -22,4 +24,4 @@ dump(arrayToStruct(arr));
 
 //member function
 dump(arr.toStruct());
-```
+```

docs/03.reference/01.functions/binarydecode/_arguments/precise.md

@@ -1 +1 @@
-if set to true the input must follow the rule for that encoding a 100%, the decryptor will not try to interpret inputs that are not a 100% correct. This should be used to avoud false positives.
+if set to true the input must follow the rule for that encoding a 100%, the decryptor will not try to interpret inputs that are not a 100% correct. This should be used to avoid false positives.

docs/03.reference/01.functions/cacheregionnew/function.md

@@ -9,4 +9,4 @@ description: 'This function exists solely for the purpose of compatibility with
 
 This function exists solely for the purpose of compatibility with other CFML Engines.
 
-We strongly recommend not to use this function. to create a cache connection either declare it in your Application.cfc or create it via the in the Administrator interface.
+We strongly recommend not to use this function. To create a cache connection either declare it in your Application.cfc or create it via the in the Administrator interface.

docs/03.reference/01.functions/cleartimezone/function.md

@@ -1,5 +1,5 @@
 ---
-title: clearTimeZone
+title: ClearTimeZone
 id: function-clearTimeZone
 categories:
 - datetime

docs/03.reference/01.functions/componentlistpackage/function.md

@@ -1,5 +1,5 @@
 ---
-title: componentlistpackage
+title: ComponentListPackage
 id: function-componentlistpackage
 related:
 categories:

docs/03.reference/01.functions/configimport/_arguments/flushExistingData.md

@@ -0,0 +1 @@
+if true that existing data get replaced with the given data, if set to false they get updated.

docs/03.reference/01.functions/configimport/function.md

@@ -1,5 +1,5 @@
 ---
-title: configImport
+title: ConfigImport
 id: function-configimport
 related:
 categories:

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

@@ -0,0 +1 @@
+charset to use to read the XML file, if not defined, Lucee will use the default resource charset.

docs/03.reference/01.functions/configtranslate/_arguments/mode.md

@@ -0,0 +1 @@
+Only used when type is set to [server], should be the resulting json set for single or multi mode.

docs/03.reference/01.functions/configtranslate/_arguments/source.md

@@ -0,0 +1 @@
+Path to the Lucee XML file (lucee-server.xml or lucee-web.xml.cfm) file or the data itself as a String.

docs/03.reference/01.functions/configtranslate/_arguments/target.md

@@ -0,0 +1 @@
+Path to the Lucee XML file (lucee-server.xml or lucee-web.xml.cfm) file or the data itself as a String.

docs/03.reference/01.functions/configtranslate/_arguments/type.md

@@ -0,0 +1 @@
+Config Context to manipulate, server or web context.

docs/03.reference/01.functions/configtranslate/function.md

@@ -0,0 +1,8 @@
+---
+title: configTranslate
+id: function-configtranslate
+related:
+categories:
+---
+
+translate an old Lucee XML configuration to the new JSON configuration

docs/03.reference/01.functions/createuniqueid/_arguments/type.md

@@ -1 +1 @@
-If the string "counter" is passed then then it's only unique for this instance in this lifecycle, otherwise the returned value will be a 22 character UUID, encoded as a URL-safe Base64.
+If the string "counter" is passed then it's only unique for this instance in this lifecycle, otherwise the returned value will be a 22 character UUID, encoded as a URL-safe Base64.

docs/03.reference/01.functions/datetimeformat/_arguments/mask.md

@@ -48,4 +48,6 @@ The following masks can be used to format the full date and time and may not be
 - medium: equivalent to "mmm d, yyyy h:nn:ss tt"
 - long: medium followed by three-letter time zone; i.e. "mmmm d, yyyy h:nn:ss tt zzz"
 - full: equivalent to "dddd, mmmm d, yyyy h:nn:ss tt zz"
-- ISO8601/ISO: equivalent to "yyyy-mm-dd'T'HH:nn:ssXXX"
+- ISO8601/ISO: equivalent to "yyyy-mm-dd'T'HH:nn:ssXXX"
+- epoch: Total seconds of a given date (Example:1567517664) (added in Lucee 6.0.0.83)
+- epochms: Total millseconds of a given date (Example:1567517664000) (added in Lucee 6.0.0.83)

docs/03.reference/01.functions/decrypt/_arguments/precise.md

@@ -1 +1 @@
-if set to true the input must follow the rule for that encoding a 100%, the decryptor will not try to interpret inputs that are not a 100% correct. This should be used to avoud false positives.
+if set to true the input must follow the rule for that encoding a 100%, the decryptor will not try to interpret inputs that are not a 100% correct. This should be used to avoid false positives.

docs/03.reference/01.functions/decryptbinary/_examples.md

@@ -1 +1,16 @@
-*There are currently no examples for this function.*
+```luceescript+trycf
+	// binary data
+	data = toBinary("abcd");
+
+	// generate the key
+	key = generateSecretKey("AES");
+
+	// encrypt string
+	encryptValue = encryptBinary(data, key);
+	writeDump(encryptValue);
+
+	// decrypt string
+	decryptValue = decryptBinary(encryptValue, key);
+	writeDump(decryptValue);
+
+```

docs/03.reference/01.functions/directoryinfo/_examples.md

@@ -0,0 +1,3 @@
+```luceescript+trycf
+dump( directoryinfo( GetTempDirectory() ) );
+```

docs/03.reference/01.functions/directoryinfo/function.md

@@ -1,5 +1,5 @@
 ---
-title: directoryinfo
+title: DirectoryInfo
 id: function-directoryinfo
 related:
 categories:

docs/03.reference/01.functions/dump/_arguments/format.md

@@ -1,6 +1,6 @@
 specify the output format of the dump, the following formats are supported:
 
-- simple: - a simple html output (no JavaScript or CSS)
-- text (default output="console"): plain text output (no html)
-- html (default output="browser"): regular output with html/CSS/JavaScript
-- classic: classic view with html/CSS/JavaScript
+- simple: - a simple HTML output (no JavaScript or CSS)
+- text (default output="console"): plain text output (no HTML)
+- html (default output="browser"): regular output with HTML/CSS/JavaScript
+- classic: classic view with HTML/CSS/JavaScript

docs/03.reference/01.functions/encodeforldap/_examples.md

@@ -1 +1,4 @@
-*There are currently no examples for this function.*
+```luceescript+trycf
+encode = encodeForLDAP("I ** love * lucee");
+dump(encode);
+```

docs/03.reference/01.functions/encodeforsql/_examples.md

@@ -0,0 +1,17 @@
+```luceescript+trycf
+// example of an url variable:
+// http://some.example.domain/dogs.cfm?name=lassie
+url.name="lassie";
+SQLQuery="SELECT * FROM dogs WHERE name='#url.name#';";
+dump( SQLQuery );
+
+// example of an url sql injection:
+// http://some.example.domain/dogs.cfm?name='%20or%20'1'='1
+url.name= "' or '1'='1";
+SQLQuery="SELECT * FROM dogs WHERE name='#url.name#';";
+dump( SQLQuery );
+
+// example of preventing sql injection with encodeForSQL in MySQL:
+SQLQuery="SELECT * FROM dogs WHERE name='#encodeForSQL( url.name, 'mySql' )#';";
+dump( SQLQuery );
+```