From 0eb84e6d222eddb380820ab3cec48265cd70336b Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 19:51:00 +0200 Subject: [PATCH 01/16] import new tags and functions from 6.1.0.235-RC --- .../01.functions/createulid/_arguments/input1.md | 1 + .../01.functions/createulid/_arguments/input2.md | 1 + .../01.functions/createulid/_arguments/type.md | 1 + .../01.functions/createulid/_returnTypeDesc.md | 0 .../01.functions/createulid/_usageNotes.md | 0 docs/03.reference/01.functions/createulid/function.md | 8 ++++++++ .../generatersakeys/_arguments/key_size.md | 1 + .../01.functions/isflushed/_returnTypeDesc.md | 0 .../03.reference/01.functions/isflushed/_usageNotes.md | 0 docs/03.reference/01.functions/isflushed/function.md | 8 ++++++++ .../01.functions/isxml/_arguments/xmlFeatures.md | 1 + .../01.functions/lslcase/_arguments/locale.md | 1 + .../01.functions/lslcase/_arguments/string.md | 1 + .../01.functions/lslcase/_returnTypeDesc.md | 0 docs/03.reference/01.functions/lslcase/_usageNotes.md | 0 docs/03.reference/01.functions/lslcase/function.md | 8 ++++++++ .../01.functions/lsucase/_arguments/locale.md | 1 + .../01.functions/lsucase/_arguments/string.md | 1 + .../01.functions/lsucase/_returnTypeDesc.md | 0 docs/03.reference/01.functions/lsucase/_usageNotes.md | 0 docs/03.reference/01.functions/lsucase/function.md | 10 ++++++++++ .../01.functions/s3addacl/_arguments/accessKeyId.md | 1 + .../01.functions/s3addacl/_arguments/aclObject.md | 1 + .../s3addacl/_arguments/bucketNameOrPath.md | 1 + .../01.functions/s3addacl/_arguments/host.md | 1 + .../01.functions/s3addacl/_arguments/objectName.md | 1 + .../s3addacl/_arguments/secretAccessKey.md | 1 + .../01.functions/s3addacl/_arguments/timeout.md | 1 + .../01.functions/s3addacl/_returnTypeDesc.md | 0 docs/03.reference/01.functions/s3addacl/_usageNotes.md | 0 docs/03.reference/01.functions/s3addacl/function.md | 8 ++++++++ .../01.functions/s3clearbucket/_arguments/host.md | 1 + .../01.functions/s3copy/_arguments/host.md | 1 + .../01.functions/s3delete/_arguments/accessKeyId.md | 1 + .../01.functions/s3delete/_arguments/bucketName.md | 1 + .../01.functions/s3delete/_arguments/force.md | 1 + .../01.functions/s3delete/_arguments/host.md | 1 + .../01.functions/s3delete/_arguments/objectName.md | 1 + .../s3delete/_arguments/secretAccessKey.md | 1 + .../01.functions/s3delete/_arguments/timeout.md | 1 + .../01.functions/s3delete/_returnTypeDesc.md | 0 docs/03.reference/01.functions/s3delete/_usageNotes.md | 0 docs/03.reference/01.functions/s3delete/function.md | 8 ++++++++ .../s3deletebucket/_arguments/accessKeyId.md | 1 + .../s3deletebucket/_arguments/bucketName.md | 1 + .../01.functions/s3deletebucket/_arguments/force.md | 1 + .../01.functions/s3deletebucket/_arguments/host.md | 1 + .../s3deletebucket/_arguments/secretAccessKey.md | 1 + .../01.functions/s3deletebucket/_arguments/timeout.md | 1 + .../01.functions/s3deletebucket/_returnTypeDesc.md | 0 .../01.functions/s3deletebucket/_usageNotes.md | 0 .../01.functions/s3deletebucket/function.md | 8 ++++++++ .../01.functions/s3exists/_arguments/host.md | 1 + .../s3generatepresignedurl/_arguments/checksum.md | 1 + .../s3generatepresignedurl/_arguments/disposition.md | 1 + .../s3generatepresignedurl/_arguments/encoding.md | 1 + .../s3generatepresignedurl/_arguments/host.md | 1 + .../s3generatepresignedurl/_arguments/httpMethod.md | 1 + .../_arguments/responseHeaders.md | 1 + .../s3generatepresignedurl/_arguments/sseAlgorithm.md | 1 + .../_arguments/sseCustomerKey.md | 1 + .../s3generatepresignedurl/_arguments/type.md | 1 + .../s3generatepresignedurl/_arguments/version.md | 1 + .../s3generatepresignedurl/_arguments/zeroByte.md | 1 + .../01.functions/s3generateuri/_arguments/host.md | 1 + .../01.functions/s3getacl/_arguments/accessKeyId.md | 1 + .../s3getacl/_arguments/bucketNameOrPath.md | 1 + .../01.functions/s3getacl/_arguments/host.md | 1 + .../01.functions/s3getacl/_arguments/objectName.md | 1 + .../s3getacl/_arguments/secretAccessKey.md | 1 + .../01.functions/s3getacl/_arguments/timeout.md | 1 + .../01.functions/s3getacl/_returnTypeDesc.md | 0 docs/03.reference/01.functions/s3getacl/_usageNotes.md | 0 docs/03.reference/01.functions/s3getacl/function.md | 8 ++++++++ .../s3getmetadata/_arguments/accessKeyId.md | 1 + .../s3getmetadata/_arguments/bucketNameOrPath.md | 1 + .../01.functions/s3getmetadata/_arguments/host.md | 1 + .../s3getmetadata/_arguments/objectName.md | 1 + .../s3getmetadata/_arguments/secretAccessKey.md | 1 + .../01.functions/s3getmetadata/_arguments/timeout.md | 1 + .../01.functions/s3getmetadata/_returnTypeDesc.md | 0 .../01.functions/s3getmetadata/_usageNotes.md | 0 .../01.functions/s3getmetadata/function.md | 8 ++++++++ .../01.functions/s3listbucket/_arguments/host.md | 1 + .../s3listbuckets/_arguments/accessKeyId.md | 1 + .../01.functions/s3listbuckets/_arguments/host.md | 1 + .../s3listbuckets/_arguments/secretAccessKey.md | 1 + .../01.functions/s3listbuckets/_arguments/timeout.md | 1 + .../01.functions/s3listbuckets/_returnTypeDesc.md | 0 .../01.functions/s3listbuckets/_usageNotes.md | 0 .../01.functions/s3listbuckets/function.md | 8 ++++++++ .../01.functions/s3move/_arguments/host.md | 1 + .../01.functions/s3read/_arguments/host.md | 1 + .../01.functions/s3readbinary/_arguments/host.md | 1 + .../01.functions/s3setacl/_arguments/accessKeyId.md | 1 + .../01.functions/s3setacl/_arguments/aclObject.md | 1 + .../s3setacl/_arguments/bucketNameOrPath.md | 1 + .../01.functions/s3setacl/_arguments/host.md | 1 + .../01.functions/s3setacl/_arguments/objectName.md | 1 + .../s3setacl/_arguments/secretAccessKey.md | 1 + .../01.functions/s3setacl/_arguments/timeout.md | 1 + .../01.functions/s3setacl/_returnTypeDesc.md | 0 docs/03.reference/01.functions/s3setacl/_usageNotes.md | 0 docs/03.reference/01.functions/s3setacl/function.md | 8 ++++++++ .../s3setmetadata/_arguments/accessKeyId.md | 1 + .../s3setmetadata/_arguments/bucketNameOrPath.md | 1 + .../01.functions/s3setmetadata/_arguments/host.md | 1 + .../01.functions/s3setmetadata/_arguments/metadata.md | 0 .../s3setmetadata/_arguments/objectName.md | 1 + .../s3setmetadata/_arguments/secretAccessKey.md | 1 + .../01.functions/s3setmetadata/_arguments/timeout.md | 1 + .../01.functions/s3setmetadata/_returnTypeDesc.md | 0 .../01.functions/s3setmetadata/_usageNotes.md | 0 .../01.functions/s3setmetadata/function.md | 8 ++++++++ .../01.functions/s3write/_arguments/host.md | 1 + .../01.functions/throw/_arguments/cause.md | 1 + .../01.functions/valueref/_arguments/ref.md | 1 + .../01.functions/valueref/_returnTypeDesc.md | 0 docs/03.reference/01.functions/valueref/_usageNotes.md | 0 docs/03.reference/01.functions/valueref/function.md | 8 ++++++++ .../application/_attributes/debuggingdatabase.md | 0 .../02.tags/application/_attributes/debuggingdump.md | 0 .../application/_attributes/debuggingexception.md | 0 .../application/_attributes/debuggingimplicitaccess.md | 0 .../application/_attributes/debuggingqueryusage.md | 0 .../application/_attributes/debuggingtemplate.md | 0 .../02.tags/application/_attributes/debuggingthread.md | 0 .../02.tags/application/_attributes/debuggingtimer.md | 0 .../application/_attributes/debuggingtracing.md | 0 .../02.tags/application/_attributes/showdebug.md | 1 + .../02.tags/application/_attributes/showdoc.md | 1 + .../02.tags/application/_attributes/showmetric.md | 1 + .../02.tags/cookie/_attributes/partitioned.md | 1 + docs/03.reference/02.tags/dump/_attributes/flush.md | 1 + .../02.tags/flush/_attributes/throwonerror.md | 1 + .../02.tags/ftp/_attributes/actionparam.md | 1 + docs/03.reference/02.tags/http/_attributes/autocert.md | 3 +++ docs/03.reference/02.tags/ldap/_attributes/usetls.md | 1 + docs/03.reference/02.tags/setting/_attributes/show.md | 2 ++ .../02.tags/setting/_attributes/showdebug.md | 2 ++ .../02.tags/setting/_attributes/showdoc.md | 2 ++ .../02.tags/setting/_attributes/showmetric.md | 2 ++ docs/03.reference/02.tags/throw/_attributes/cause.md | 1 + 143 files changed, 206 insertions(+) create mode 100644 docs/03.reference/01.functions/createulid/_arguments/input1.md create mode 100644 docs/03.reference/01.functions/createulid/_arguments/input2.md create mode 100644 docs/03.reference/01.functions/createulid/_arguments/type.md create mode 100644 docs/03.reference/01.functions/createulid/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/createulid/_usageNotes.md create mode 100644 docs/03.reference/01.functions/createulid/function.md create mode 100644 docs/03.reference/01.functions/generatersakeys/_arguments/key_size.md create mode 100644 docs/03.reference/01.functions/isflushed/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/isflushed/_usageNotes.md create mode 100644 docs/03.reference/01.functions/isflushed/function.md create mode 100644 docs/03.reference/01.functions/isxml/_arguments/xmlFeatures.md create mode 100644 docs/03.reference/01.functions/lslcase/_arguments/locale.md create mode 100644 docs/03.reference/01.functions/lslcase/_arguments/string.md create mode 100644 docs/03.reference/01.functions/lslcase/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/lslcase/_usageNotes.md create mode 100644 docs/03.reference/01.functions/lslcase/function.md create mode 100644 docs/03.reference/01.functions/lsucase/_arguments/locale.md create mode 100644 docs/03.reference/01.functions/lsucase/_arguments/string.md create mode 100644 docs/03.reference/01.functions/lsucase/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/lsucase/_usageNotes.md create mode 100644 docs/03.reference/01.functions/lsucase/function.md create mode 100644 docs/03.reference/01.functions/s3addacl/_arguments/accessKeyId.md create mode 100644 docs/03.reference/01.functions/s3addacl/_arguments/aclObject.md create mode 100644 docs/03.reference/01.functions/s3addacl/_arguments/bucketNameOrPath.md create mode 100644 docs/03.reference/01.functions/s3addacl/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3addacl/_arguments/objectName.md create mode 100644 docs/03.reference/01.functions/s3addacl/_arguments/secretAccessKey.md create mode 100644 docs/03.reference/01.functions/s3addacl/_arguments/timeout.md create mode 100644 docs/03.reference/01.functions/s3addacl/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/s3addacl/_usageNotes.md create mode 100644 docs/03.reference/01.functions/s3addacl/function.md create mode 100644 docs/03.reference/01.functions/s3clearbucket/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3copy/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3delete/_arguments/accessKeyId.md create mode 100644 docs/03.reference/01.functions/s3delete/_arguments/bucketName.md create mode 100644 docs/03.reference/01.functions/s3delete/_arguments/force.md create mode 100644 docs/03.reference/01.functions/s3delete/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3delete/_arguments/objectName.md create mode 100644 docs/03.reference/01.functions/s3delete/_arguments/secretAccessKey.md create mode 100644 docs/03.reference/01.functions/s3delete/_arguments/timeout.md create mode 100644 docs/03.reference/01.functions/s3delete/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/s3delete/_usageNotes.md create mode 100644 docs/03.reference/01.functions/s3delete/function.md create mode 100644 docs/03.reference/01.functions/s3deletebucket/_arguments/accessKeyId.md create mode 100644 docs/03.reference/01.functions/s3deletebucket/_arguments/bucketName.md create mode 100644 docs/03.reference/01.functions/s3deletebucket/_arguments/force.md create mode 100644 docs/03.reference/01.functions/s3deletebucket/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3deletebucket/_arguments/secretAccessKey.md create mode 100644 docs/03.reference/01.functions/s3deletebucket/_arguments/timeout.md create mode 100644 docs/03.reference/01.functions/s3deletebucket/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/s3deletebucket/_usageNotes.md create mode 100644 docs/03.reference/01.functions/s3deletebucket/function.md create mode 100644 docs/03.reference/01.functions/s3exists/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/checksum.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/disposition.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/encoding.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/httpMethod.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/responseHeaders.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/sseAlgorithm.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/sseCustomerKey.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/type.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/version.md create mode 100644 docs/03.reference/01.functions/s3generatepresignedurl/_arguments/zeroByte.md create mode 100644 docs/03.reference/01.functions/s3generateuri/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3getacl/_arguments/accessKeyId.md create mode 100644 docs/03.reference/01.functions/s3getacl/_arguments/bucketNameOrPath.md create mode 100644 docs/03.reference/01.functions/s3getacl/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3getacl/_arguments/objectName.md create mode 100644 docs/03.reference/01.functions/s3getacl/_arguments/secretAccessKey.md create mode 100644 docs/03.reference/01.functions/s3getacl/_arguments/timeout.md create mode 100644 docs/03.reference/01.functions/s3getacl/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/s3getacl/_usageNotes.md create mode 100644 docs/03.reference/01.functions/s3getacl/function.md create mode 100644 docs/03.reference/01.functions/s3getmetadata/_arguments/accessKeyId.md create mode 100644 docs/03.reference/01.functions/s3getmetadata/_arguments/bucketNameOrPath.md create mode 100644 docs/03.reference/01.functions/s3getmetadata/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3getmetadata/_arguments/objectName.md create mode 100644 docs/03.reference/01.functions/s3getmetadata/_arguments/secretAccessKey.md create mode 100644 docs/03.reference/01.functions/s3getmetadata/_arguments/timeout.md create mode 100644 docs/03.reference/01.functions/s3getmetadata/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/s3getmetadata/_usageNotes.md create mode 100644 docs/03.reference/01.functions/s3getmetadata/function.md create mode 100644 docs/03.reference/01.functions/s3listbucket/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3listbuckets/_arguments/accessKeyId.md create mode 100644 docs/03.reference/01.functions/s3listbuckets/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3listbuckets/_arguments/secretAccessKey.md create mode 100644 docs/03.reference/01.functions/s3listbuckets/_arguments/timeout.md create mode 100644 docs/03.reference/01.functions/s3listbuckets/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/s3listbuckets/_usageNotes.md create mode 100644 docs/03.reference/01.functions/s3listbuckets/function.md create mode 100644 docs/03.reference/01.functions/s3move/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3read/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3readbinary/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3setacl/_arguments/accessKeyId.md create mode 100644 docs/03.reference/01.functions/s3setacl/_arguments/aclObject.md create mode 100644 docs/03.reference/01.functions/s3setacl/_arguments/bucketNameOrPath.md create mode 100644 docs/03.reference/01.functions/s3setacl/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3setacl/_arguments/objectName.md create mode 100644 docs/03.reference/01.functions/s3setacl/_arguments/secretAccessKey.md create mode 100644 docs/03.reference/01.functions/s3setacl/_arguments/timeout.md create mode 100644 docs/03.reference/01.functions/s3setacl/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/s3setacl/_usageNotes.md create mode 100644 docs/03.reference/01.functions/s3setacl/function.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/_arguments/accessKeyId.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/_arguments/bucketNameOrPath.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/_arguments/host.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/_arguments/metadata.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/_arguments/objectName.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/_arguments/secretAccessKey.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/_arguments/timeout.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/_usageNotes.md create mode 100644 docs/03.reference/01.functions/s3setmetadata/function.md create mode 100644 docs/03.reference/01.functions/s3write/_arguments/host.md create mode 100644 docs/03.reference/01.functions/throw/_arguments/cause.md create mode 100644 docs/03.reference/01.functions/valueref/_arguments/ref.md create mode 100644 docs/03.reference/01.functions/valueref/_returnTypeDesc.md create mode 100644 docs/03.reference/01.functions/valueref/_usageNotes.md create mode 100644 docs/03.reference/01.functions/valueref/function.md create mode 100644 docs/03.reference/02.tags/application/_attributes/debuggingdatabase.md create mode 100644 docs/03.reference/02.tags/application/_attributes/debuggingdump.md create mode 100644 docs/03.reference/02.tags/application/_attributes/debuggingexception.md create mode 100644 docs/03.reference/02.tags/application/_attributes/debuggingimplicitaccess.md create mode 100644 docs/03.reference/02.tags/application/_attributes/debuggingqueryusage.md create mode 100644 docs/03.reference/02.tags/application/_attributes/debuggingtemplate.md create mode 100644 docs/03.reference/02.tags/application/_attributes/debuggingthread.md create mode 100644 docs/03.reference/02.tags/application/_attributes/debuggingtimer.md create mode 100644 docs/03.reference/02.tags/application/_attributes/debuggingtracing.md create mode 100644 docs/03.reference/02.tags/application/_attributes/showdebug.md create mode 100644 docs/03.reference/02.tags/application/_attributes/showdoc.md create mode 100644 docs/03.reference/02.tags/application/_attributes/showmetric.md create mode 100644 docs/03.reference/02.tags/cookie/_attributes/partitioned.md create mode 100644 docs/03.reference/02.tags/dump/_attributes/flush.md create mode 100644 docs/03.reference/02.tags/flush/_attributes/throwonerror.md create mode 100644 docs/03.reference/02.tags/ftp/_attributes/actionparam.md create mode 100644 docs/03.reference/02.tags/http/_attributes/autocert.md create mode 100644 docs/03.reference/02.tags/ldap/_attributes/usetls.md create mode 100644 docs/03.reference/02.tags/setting/_attributes/show.md create mode 100644 docs/03.reference/02.tags/setting/_attributes/showdebug.md create mode 100644 docs/03.reference/02.tags/setting/_attributes/showdoc.md create mode 100644 docs/03.reference/02.tags/setting/_attributes/showmetric.md create mode 100644 docs/03.reference/02.tags/throw/_attributes/cause.md diff --git a/docs/03.reference/01.functions/createulid/_arguments/input1.md b/docs/03.reference/01.functions/createulid/_arguments/input1.md new file mode 100644 index 000000000..fa1b98b4b --- /dev/null +++ b/docs/03.reference/01.functions/createulid/_arguments/input1.md @@ -0,0 +1 @@ +Used in conjunction with the 'hash' type, this numeric input contributes to the generation of a deterministic ULID by influencing its random component. \ No newline at end of file diff --git a/docs/03.reference/01.functions/createulid/_arguments/input2.md b/docs/03.reference/01.functions/createulid/_arguments/input2.md new file mode 100644 index 000000000..501d407a5 --- /dev/null +++ b/docs/03.reference/01.functions/createulid/_arguments/input2.md @@ -0,0 +1 @@ +Similar to 'input1', this string input is utilized only in the 'hash' mode to further seed the ULID's random component, enabling the creation of a deterministic ULID based on the hash of the inputs. \ No newline at end of file diff --git a/docs/03.reference/01.functions/createulid/_arguments/type.md b/docs/03.reference/01.functions/createulid/_arguments/type.md new file mode 100644 index 000000000..5b3ab4f0f --- /dev/null +++ b/docs/03.reference/01.functions/createulid/_arguments/type.md @@ -0,0 +1 @@ +Specifies the generation mode of the ULID. If not defined, a standard ULID is generated. 'monotonic' ensures ULIDs increase monotonically, suitable for ensuring order in rapid generation scenarios. 'hash' mode generates a ULID based on hashing the provided inputs, useful for creating deterministic identifiers. \ No newline at end of file diff --git a/docs/03.reference/01.functions/createulid/_returnTypeDesc.md b/docs/03.reference/01.functions/createulid/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/createulid/_usageNotes.md b/docs/03.reference/01.functions/createulid/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/createulid/function.md b/docs/03.reference/01.functions/createulid/function.md new file mode 100644 index 000000000..5ea4576af --- /dev/null +++ b/docs/03.reference/01.functions/createulid/function.md @@ -0,0 +1,8 @@ +--- +title: createulid +id: function-createulid +related: +categories: +--- + +Generates a ULID (Universally Unique Lexicographically Sortable Identifier), a 128-bit identifier where the first 48 bits are a timestamp representing milliseconds since the Unix Epoch (1970-01-01), ensuring temporal ordering. The remaining 80 bits are populated by a secure random number generator, contributing to the identifier's uniqueness. The output is a 26-character string in its canonical representation. This function can operate in three modes specified by the 'type' argument: 'empty' for standard ULID generation, 'monotonic' to ensure sequential IDs even in rapid succession, and 'hash' to generate a ULID based on hashed input values. \ No newline at end of file diff --git a/docs/03.reference/01.functions/generatersakeys/_arguments/key_size.md b/docs/03.reference/01.functions/generatersakeys/_arguments/key_size.md new file mode 100644 index 000000000..f413a64f7 --- /dev/null +++ b/docs/03.reference/01.functions/generatersakeys/_arguments/key_size.md @@ -0,0 +1 @@ +Number of bits to use for the generated Keys. \ No newline at end of file diff --git a/docs/03.reference/01.functions/isflushed/_returnTypeDesc.md b/docs/03.reference/01.functions/isflushed/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/isflushed/_usageNotes.md b/docs/03.reference/01.functions/isflushed/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/isflushed/function.md b/docs/03.reference/01.functions/isflushed/function.md new file mode 100644 index 000000000..f64e50e53 --- /dev/null +++ b/docs/03.reference/01.functions/isflushed/function.md @@ -0,0 +1,8 @@ +--- +title: isflushed +id: function-isflushed +related: +categories: +--- + +returns true if the response stream was already flushed. \ No newline at end of file diff --git a/docs/03.reference/01.functions/isxml/_arguments/xmlFeatures.md b/docs/03.reference/01.functions/isxml/_arguments/xmlFeatures.md new file mode 100644 index 000000000..5319efeca --- /dev/null +++ b/docs/03.reference/01.functions/isxml/_arguments/xmlFeatures.md @@ -0,0 +1 @@ +A struct of xmlFeatures directives to override defaults \ No newline at end of file diff --git a/docs/03.reference/01.functions/lslcase/_arguments/locale.md b/docs/03.reference/01.functions/lslcase/_arguments/locale.md new file mode 100644 index 000000000..52da60b83 --- /dev/null +++ b/docs/03.reference/01.functions/lslcase/_arguments/locale.md @@ -0,0 +1 @@ +Optional. Allows specifying a different locale for the conversion, superseding the page's default locale. This argument accepts a locale identifier, such as "fr-CA" for Canadian French or "de-DE" for German in Germany. \ No newline at end of file diff --git a/docs/03.reference/01.functions/lslcase/_arguments/string.md b/docs/03.reference/01.functions/lslcase/_arguments/string.md new file mode 100644 index 000000000..676eedb99 --- /dev/null +++ b/docs/03.reference/01.functions/lslcase/_arguments/string.md @@ -0,0 +1 @@ +The string to be converted to lowercase. This parameter can accept either a string literal or a variable that holds the string content. \ No newline at end of file diff --git a/docs/03.reference/01.functions/lslcase/_returnTypeDesc.md b/docs/03.reference/01.functions/lslcase/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/lslcase/_usageNotes.md b/docs/03.reference/01.functions/lslcase/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/lslcase/function.md b/docs/03.reference/01.functions/lslcase/function.md new file mode 100644 index 000000000..8e527a7a3 --- /dev/null +++ b/docs/03.reference/01.functions/lslcase/function.md @@ -0,0 +1,8 @@ +--- +title: lslcase +id: function-lslcase +related: +categories: +--- + +Converts the alphabetic characters in a specified string to lowercase, respecting locale-specific casing rules. This is particularly important for languages where the standard lowercase conversion rules do not apply, ensuring accurate and culturally correct text processing. The function defaults to the current page's locale if no locale is specified. \ No newline at end of file diff --git a/docs/03.reference/01.functions/lsucase/_arguments/locale.md b/docs/03.reference/01.functions/lsucase/_arguments/locale.md new file mode 100644 index 000000000..48ebab4bc --- /dev/null +++ b/docs/03.reference/01.functions/lsucase/_arguments/locale.md @@ -0,0 +1 @@ +Optional. Specifies the locale to use for the conversion, overriding the default locale of the page. This should be a locale code string (e.g., "en-US" for American English or "tr-TR" for Turkish). \ No newline at end of file diff --git a/docs/03.reference/01.functions/lsucase/_arguments/string.md b/docs/03.reference/01.functions/lsucase/_arguments/string.md new file mode 100644 index 000000000..1d6fedce3 --- /dev/null +++ b/docs/03.reference/01.functions/lsucase/_arguments/string.md @@ -0,0 +1 @@ +The string to be converted to uppercase. This can be a direct string value or a variable that contains the string. \ No newline at end of file diff --git a/docs/03.reference/01.functions/lsucase/_returnTypeDesc.md b/docs/03.reference/01.functions/lsucase/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/lsucase/_usageNotes.md b/docs/03.reference/01.functions/lsucase/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/lsucase/function.md b/docs/03.reference/01.functions/lsucase/function.md new file mode 100644 index 000000000..e32c1d78d --- /dev/null +++ b/docs/03.reference/01.functions/lsucase/function.md @@ -0,0 +1,10 @@ +--- +title: lsucase +id: function-lsucase +related: +categories: +--- + +Converts the alphabetic characters in a specified string to uppercase, +respecting locale-specific casing rules. This is particularly important for languages where the standard lowercase conversion rules do not apply, +ensuring accurate and culturally correct text processing. The function defaults to the current page's locale if no locale is specified. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3addacl/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3addacl/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3addacl/_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/s3addacl/_arguments/aclObject.md b/docs/03.reference/01.functions/s3addacl/_arguments/aclObject.md new file mode 100644 index 000000000..344224b91 --- /dev/null +++ b/docs/03.reference/01.functions/s3addacl/_arguments/aclObject.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/s3addacl/_arguments/bucketNameOrPath.md b/docs/03.reference/01.functions/s3addacl/_arguments/bucketNameOrPath.md new file mode 100644 index 000000000..84333db21 --- /dev/null +++ b/docs/03.reference/01.functions/s3addacl/_arguments/bucketNameOrPath.md @@ -0,0 +1 @@ +This can be the bucketname or a virtual filesystem path for a file/directory (example "s3://mybucket/myobject.txt"). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3addacl/_arguments/host.md b/docs/03.reference/01.functions/s3addacl/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3addacl/_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/s3addacl/_arguments/objectName.md b/docs/03.reference/01.functions/s3addacl/_arguments/objectName.md new file mode 100644 index 000000000..c20eaf586 --- /dev/null +++ b/docs/03.reference/01.functions/s3addacl/_arguments/objectName.md @@ -0,0 +1 @@ +Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3addacl/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3addacl/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3addacl/_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/s3addacl/_arguments/timeout.md b/docs/03.reference/01.functions/s3addacl/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3addacl/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3addacl/_returnTypeDesc.md b/docs/03.reference/01.functions/s3addacl/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3addacl/_usageNotes.md b/docs/03.reference/01.functions/s3addacl/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3addacl/function.md b/docs/03.reference/01.functions/s3addacl/function.md new file mode 100644 index 000000000..77036f455 --- /dev/null +++ b/docs/03.reference/01.functions/s3addacl/function.md @@ -0,0 +1,8 @@ +--- +title: s3addacl +id: function-s3addacl +related: +categories: +--- + +Adds ACL to existing ACL for object or bucket. You can provide the endpoint as a bucket/object defintion (S3AddACL(bucket:"mybucket",object:"myobject.txt",acl:data) ) or as a virtual filesystem path (S3AddACL(path:"s3://mybucket/myobject.txt",acl:data) ). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3clearbucket/_arguments/host.md b/docs/03.reference/01.functions/s3clearbucket/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3clearbucket/_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/s3copy/_arguments/host.md b/docs/03.reference/01.functions/s3copy/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3copy/_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/s3delete/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3delete/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3delete/_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/s3delete/_arguments/bucketName.md b/docs/03.reference/01.functions/s3delete/_arguments/bucketName.md new file mode 100644 index 000000000..3abdc2bb9 --- /dev/null +++ b/docs/03.reference/01.functions/s3delete/_arguments/bucketName.md @@ -0,0 +1 @@ +Name of the bucket to delete. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3delete/_arguments/force.md b/docs/03.reference/01.functions/s3delete/_arguments/force.md new file mode 100644 index 000000000..c83ec2090 --- /dev/null +++ b/docs/03.reference/01.functions/s3delete/_arguments/force.md @@ -0,0 +1 @@ +Also delete bucket if it has content. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3delete/_arguments/host.md b/docs/03.reference/01.functions/s3delete/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3delete/_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/s3delete/_arguments/objectName.md b/docs/03.reference/01.functions/s3delete/_arguments/objectName.md new file mode 100644 index 000000000..c439b565f --- /dev/null +++ b/docs/03.reference/01.functions/s3delete/_arguments/objectName.md @@ -0,0 +1 @@ +Name of the object to delete, if not defined the bucket itself is deleted. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3delete/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3delete/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3delete/_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/s3delete/_arguments/timeout.md b/docs/03.reference/01.functions/s3delete/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3delete/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3delete/_returnTypeDesc.md b/docs/03.reference/01.functions/s3delete/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3delete/_usageNotes.md b/docs/03.reference/01.functions/s3delete/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3delete/function.md b/docs/03.reference/01.functions/s3delete/function.md new file mode 100644 index 000000000..d9688df42 --- /dev/null +++ b/docs/03.reference/01.functions/s3delete/function.md @@ -0,0 +1,8 @@ +--- +title: s3delete +id: function-s3delete +related: +categories: +--- + +deletes a bucket or an object within a bucket. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3deletebucket/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3deletebucket/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3deletebucket/_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/s3deletebucket/_arguments/bucketName.md b/docs/03.reference/01.functions/s3deletebucket/_arguments/bucketName.md new file mode 100644 index 000000000..956103719 --- /dev/null +++ b/docs/03.reference/01.functions/s3deletebucket/_arguments/bucketName.md @@ -0,0 +1 @@ +Name of the bucket to list objects from. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3deletebucket/_arguments/force.md b/docs/03.reference/01.functions/s3deletebucket/_arguments/force.md new file mode 100644 index 000000000..c83ec2090 --- /dev/null +++ b/docs/03.reference/01.functions/s3deletebucket/_arguments/force.md @@ -0,0 +1 @@ +Also delete bucket if it has content. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3deletebucket/_arguments/host.md b/docs/03.reference/01.functions/s3deletebucket/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3deletebucket/_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/s3deletebucket/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3deletebucket/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3deletebucket/_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/s3deletebucket/_arguments/timeout.md b/docs/03.reference/01.functions/s3deletebucket/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3deletebucket/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3deletebucket/_returnTypeDesc.md b/docs/03.reference/01.functions/s3deletebucket/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3deletebucket/_usageNotes.md b/docs/03.reference/01.functions/s3deletebucket/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3deletebucket/function.md b/docs/03.reference/01.functions/s3deletebucket/function.md new file mode 100644 index 000000000..bcd655a52 --- /dev/null +++ b/docs/03.reference/01.functions/s3deletebucket/function.md @@ -0,0 +1,8 @@ +--- +title: s3deletebucket +id: function-s3deletebucket +related: +categories: +--- + +deletes a bucket, this function is deprecated, use instead S3Delete. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3exists/_arguments/host.md b/docs/03.reference/01.functions/s3exists/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3exists/_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/s3generatepresignedurl/_arguments/checksum.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/checksum.md new file mode 100644 index 000000000..5d4396c20 --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/checksum.md @@ -0,0 +1 @@ +The base64 encoded MD5 checksum of the object's content. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/disposition.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/disposition.md new file mode 100644 index 000000000..3e1e3b990 --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/disposition.md @@ -0,0 +1 @@ +Specifies presentational information for the object, like "attachment; filename=\"filename.pdf\"". \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/encoding.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/encoding.md new file mode 100644 index 000000000..bc6f470d1 --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/encoding.md @@ -0,0 +1 @@ +Specifies content encodings applied to the object, like gzip. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/host.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_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/s3generatepresignedurl/_arguments/httpMethod.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/httpMethod.md new file mode 100644 index 000000000..0ef49b982 --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/httpMethod.md @@ -0,0 +1 @@ +The desired HTTP method (e.g., GET, PUT). Defaults to GET. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/responseHeaders.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/responseHeaders.md new file mode 100644 index 000000000..daf723b38 --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/responseHeaders.md @@ -0,0 +1 @@ +Struct of custom response headers for custom metadata prefixed with "x-amz-meta-" (prefix is optional, function will add it if missed). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/sseAlgorithm.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/sseAlgorithm.md new file mode 100644 index 000000000..dcf8d848c --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/sseAlgorithm.md @@ -0,0 +1 @@ +The desired server-side encryption algorithm, valid values are AES256 or KMS. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/sseCustomerKey.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/sseCustomerKey.md new file mode 100644 index 000000000..fd679b4a7 --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/sseCustomerKey.md @@ -0,0 +1 @@ +The server-side encryption customer-provided key. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/type.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/type.md new file mode 100644 index 000000000..c8b4be149 --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/type.md @@ -0,0 +1 @@ +The MIME type of the object (e.g., "text/plain"). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/version.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/version.md new file mode 100644 index 000000000..a08f3858e --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/version.md @@ -0,0 +1 @@ +The version ID of the object if versioning is enabled. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/zeroByte.md b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/zeroByte.md new file mode 100644 index 000000000..672ecfa82 --- /dev/null +++ b/docs/03.reference/01.functions/s3generatepresignedurl/_arguments/zeroByte.md @@ -0,0 +1 @@ +A flag to specify if the object has zero-byte content. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3generateuri/_arguments/host.md b/docs/03.reference/01.functions/s3generateuri/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3generateuri/_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/s3getacl/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3getacl/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3getacl/_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/s3getacl/_arguments/bucketNameOrPath.md b/docs/03.reference/01.functions/s3getacl/_arguments/bucketNameOrPath.md new file mode 100644 index 000000000..84333db21 --- /dev/null +++ b/docs/03.reference/01.functions/s3getacl/_arguments/bucketNameOrPath.md @@ -0,0 +1 @@ +This can be the bucketname or a virtual filesystem path for a file/directory (example "s3://mybucket/myobject.txt"). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getacl/_arguments/host.md b/docs/03.reference/01.functions/s3getacl/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3getacl/_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/s3getacl/_arguments/objectName.md b/docs/03.reference/01.functions/s3getacl/_arguments/objectName.md new file mode 100644 index 000000000..c20eaf586 --- /dev/null +++ b/docs/03.reference/01.functions/s3getacl/_arguments/objectName.md @@ -0,0 +1 @@ +Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getacl/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3getacl/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3getacl/_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/s3getacl/_arguments/timeout.md b/docs/03.reference/01.functions/s3getacl/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3getacl/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getacl/_returnTypeDesc.md b/docs/03.reference/01.functions/s3getacl/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3getacl/_usageNotes.md b/docs/03.reference/01.functions/s3getacl/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3getacl/function.md b/docs/03.reference/01.functions/s3getacl/function.md new file mode 100644 index 000000000..be7097bcc --- /dev/null +++ b/docs/03.reference/01.functions/s3getacl/function.md @@ -0,0 +1,8 @@ +--- +title: s3getacl +id: function-s3getacl +related: +categories: +--- + +Returns an array of structures, with each structure representing an ACL (Access Control List) grant. You can provide the endpoint as a bucket/object defintion (S3GetACL(bucket:"mybucket",object:"myobject.txt") ) or as a virtual filesystem path (S3GetACL(path:"s3://mybucket/myobject.txt") ). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getmetadata/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3getmetadata/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3getmetadata/_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/s3getmetadata/_arguments/bucketNameOrPath.md b/docs/03.reference/01.functions/s3getmetadata/_arguments/bucketNameOrPath.md new file mode 100644 index 000000000..84333db21 --- /dev/null +++ b/docs/03.reference/01.functions/s3getmetadata/_arguments/bucketNameOrPath.md @@ -0,0 +1 @@ +This can be the bucketname or a virtual filesystem path for a file/directory (example "s3://mybucket/myobject.txt"). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getmetadata/_arguments/host.md b/docs/03.reference/01.functions/s3getmetadata/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3getmetadata/_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/s3getmetadata/_arguments/objectName.md b/docs/03.reference/01.functions/s3getmetadata/_arguments/objectName.md new file mode 100644 index 000000000..c20eaf586 --- /dev/null +++ b/docs/03.reference/01.functions/s3getmetadata/_arguments/objectName.md @@ -0,0 +1 @@ +Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getmetadata/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3getmetadata/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3getmetadata/_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/s3getmetadata/_arguments/timeout.md b/docs/03.reference/01.functions/s3getmetadata/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3getmetadata/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getmetadata/_returnTypeDesc.md b/docs/03.reference/01.functions/s3getmetadata/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3getmetadata/_usageNotes.md b/docs/03.reference/01.functions/s3getmetadata/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3getmetadata/function.md b/docs/03.reference/01.functions/s3getmetadata/function.md new file mode 100644 index 000000000..997a5a8f5 --- /dev/null +++ b/docs/03.reference/01.functions/s3getmetadata/function.md @@ -0,0 +1,8 @@ +--- +title: s3getmetadata +id: function-s3getmetadata +related: +categories: +--- + +Returns the metadata related to the object or bucket. You can provide the endpoint as a bucket/object defintion (S3GetMetaData(bucket:"mybucket",object:"myobject.txt") ) or as a virtual filesystem path (S3GetMetaData(path:"s3://mybucket/myobject.txt") ). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3listbucket/_arguments/host.md b/docs/03.reference/01.functions/s3listbucket/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3listbucket/_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/s3listbuckets/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3listbuckets/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3listbuckets/_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/s3listbuckets/_arguments/host.md b/docs/03.reference/01.functions/s3listbuckets/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3listbuckets/_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/s3listbuckets/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3listbuckets/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3listbuckets/_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/s3listbuckets/_arguments/timeout.md b/docs/03.reference/01.functions/s3listbuckets/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3listbuckets/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3listbuckets/_returnTypeDesc.md b/docs/03.reference/01.functions/s3listbuckets/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3listbuckets/_usageNotes.md b/docs/03.reference/01.functions/s3listbuckets/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3listbuckets/function.md b/docs/03.reference/01.functions/s3listbuckets/function.md new file mode 100644 index 000000000..af56c1b38 --- /dev/null +++ b/docs/03.reference/01.functions/s3listbuckets/function.md @@ -0,0 +1,8 @@ +--- +title: s3listbuckets +id: function-s3listbuckets +related: +categories: +--- + +List all buckets \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3move/_arguments/host.md b/docs/03.reference/01.functions/s3move/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3move/_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/s3read/_arguments/host.md b/docs/03.reference/01.functions/s3read/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3read/_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/s3readbinary/_arguments/host.md b/docs/03.reference/01.functions/s3readbinary/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3readbinary/_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/s3setacl/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3setacl/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3setacl/_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/s3setacl/_arguments/aclObject.md b/docs/03.reference/01.functions/s3setacl/_arguments/aclObject.md new file mode 100644 index 000000000..344224b91 --- /dev/null +++ b/docs/03.reference/01.functions/s3setacl/_arguments/aclObject.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/s3setacl/_arguments/bucketNameOrPath.md b/docs/03.reference/01.functions/s3setacl/_arguments/bucketNameOrPath.md new file mode 100644 index 000000000..84333db21 --- /dev/null +++ b/docs/03.reference/01.functions/s3setacl/_arguments/bucketNameOrPath.md @@ -0,0 +1 @@ +This can be the bucketname or a virtual filesystem path for a file/directory (example "s3://mybucket/myobject.txt"). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3setacl/_arguments/host.md b/docs/03.reference/01.functions/s3setacl/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3setacl/_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/s3setacl/_arguments/objectName.md b/docs/03.reference/01.functions/s3setacl/_arguments/objectName.md new file mode 100644 index 000000000..c20eaf586 --- /dev/null +++ b/docs/03.reference/01.functions/s3setacl/_arguments/objectName.md @@ -0,0 +1 @@ +Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3setacl/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3setacl/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3setacl/_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/s3setacl/_arguments/timeout.md b/docs/03.reference/01.functions/s3setacl/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3setacl/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3setacl/_returnTypeDesc.md b/docs/03.reference/01.functions/s3setacl/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3setacl/_usageNotes.md b/docs/03.reference/01.functions/s3setacl/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3setacl/function.md b/docs/03.reference/01.functions/s3setacl/function.md new file mode 100644 index 000000000..1701c3cc3 --- /dev/null +++ b/docs/03.reference/01.functions/s3setacl/function.md @@ -0,0 +1,8 @@ +--- +title: s3setacl +id: function-s3setacl +related: +categories: +--- + +Sets ACL to existing ACL for object or bucket. You can provide the endpoint as a bucket/object defintion (S3SetACL(bucket:"mybucket",object:"myobject.txt",acl:data) ) or as a virtual filesystem path (S3SetACL(path:"s3://mybucket/myobject.txt",acl:data) ). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3setmetadata/_arguments/accessKeyId.md b/docs/03.reference/01.functions/s3setmetadata/_arguments/accessKeyId.md new file mode 100644 index 000000000..eea1fc4c2 --- /dev/null +++ b/docs/03.reference/01.functions/s3setmetadata/_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/s3setmetadata/_arguments/bucketNameOrPath.md b/docs/03.reference/01.functions/s3setmetadata/_arguments/bucketNameOrPath.md new file mode 100644 index 000000000..84333db21 --- /dev/null +++ b/docs/03.reference/01.functions/s3setmetadata/_arguments/bucketNameOrPath.md @@ -0,0 +1 @@ +This can be the bucketname or a virtual filesystem path for a file/directory (example "s3://mybucket/myobject.txt"). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3setmetadata/_arguments/host.md b/docs/03.reference/01.functions/s3setmetadata/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3setmetadata/_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/s3setmetadata/_arguments/metadata.md b/docs/03.reference/01.functions/s3setmetadata/_arguments/metadata.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3setmetadata/_arguments/objectName.md b/docs/03.reference/01.functions/s3setmetadata/_arguments/objectName.md new file mode 100644 index 000000000..c20eaf586 --- /dev/null +++ b/docs/03.reference/01.functions/s3setmetadata/_arguments/objectName.md @@ -0,0 +1 @@ +Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument. \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3setmetadata/_arguments/secretAccessKey.md b/docs/03.reference/01.functions/s3setmetadata/_arguments/secretAccessKey.md new file mode 100644 index 000000000..312fc8ab7 --- /dev/null +++ b/docs/03.reference/01.functions/s3setmetadata/_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/s3setmetadata/_arguments/timeout.md b/docs/03.reference/01.functions/s3setmetadata/_arguments/timeout.md new file mode 100644 index 000000000..3029d930d --- /dev/null +++ b/docs/03.reference/01.functions/s3setmetadata/_arguments/timeout.md @@ -0,0 +1 @@ +timeout for this execution \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3setmetadata/_returnTypeDesc.md b/docs/03.reference/01.functions/s3setmetadata/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3setmetadata/_usageNotes.md b/docs/03.reference/01.functions/s3setmetadata/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/s3setmetadata/function.md b/docs/03.reference/01.functions/s3setmetadata/function.md new file mode 100644 index 000000000..430252c70 --- /dev/null +++ b/docs/03.reference/01.functions/s3setmetadata/function.md @@ -0,0 +1,8 @@ +--- +title: s3setmetadata +id: function-s3setmetadata +related: +categories: +--- + +Sets the metadata on bucket or object. You can provide the endpoint as a bucket/object defintion (S3SetMetaData(bucket:"mybucket",object:"myobject.txt",metadata:data) ) or as a virtual filesystem path (S3SetMetaData(path:"s3://mybucket/myobject.txt",metadata:data) ). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3write/_arguments/host.md b/docs/03.reference/01.functions/s3write/_arguments/host.md new file mode 100644 index 000000000..b29b77120 --- /dev/null +++ b/docs/03.reference/01.functions/s3write/_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/throw/_arguments/cause.md b/docs/03.reference/01.functions/throw/_arguments/cause.md new file mode 100644 index 000000000..283a31d60 --- /dev/null +++ b/docs/03.reference/01.functions/throw/_arguments/cause.md @@ -0,0 +1 @@ +The cause of the exception created with this tag. This can be a cfcatch block or a native java exception. \ No newline at end of file diff --git a/docs/03.reference/01.functions/valueref/_arguments/ref.md b/docs/03.reference/01.functions/valueref/_arguments/ref.md new file mode 100644 index 000000000..d49a6dfa9 --- /dev/null +++ b/docs/03.reference/01.functions/valueref/_arguments/ref.md @@ -0,0 +1 @@ +udf returning the value \ No newline at end of file diff --git a/docs/03.reference/01.functions/valueref/_returnTypeDesc.md b/docs/03.reference/01.functions/valueref/_returnTypeDesc.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/valueref/_usageNotes.md b/docs/03.reference/01.functions/valueref/_usageNotes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/01.functions/valueref/function.md b/docs/03.reference/01.functions/valueref/function.md new file mode 100644 index 000000000..b80afd2b4 --- /dev/null +++ b/docs/03.reference/01.functions/valueref/function.md @@ -0,0 +1,8 @@ +--- +title: valueref +id: function-valueref +related: +categories: +--- + +creates a reference to a UDF that acts like a simple value. \ No newline at end of file diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingdatabase.md b/docs/03.reference/02.tags/application/_attributes/debuggingdatabase.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingdump.md b/docs/03.reference/02.tags/application/_attributes/debuggingdump.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingexception.md b/docs/03.reference/02.tags/application/_attributes/debuggingexception.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingimplicitaccess.md b/docs/03.reference/02.tags/application/_attributes/debuggingimplicitaccess.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingqueryusage.md b/docs/03.reference/02.tags/application/_attributes/debuggingqueryusage.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingtemplate.md b/docs/03.reference/02.tags/application/_attributes/debuggingtemplate.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingthread.md b/docs/03.reference/02.tags/application/_attributes/debuggingthread.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingtimer.md b/docs/03.reference/02.tags/application/_attributes/debuggingtimer.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingtracing.md b/docs/03.reference/02.tags/application/_attributes/debuggingtracing.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/03.reference/02.tags/application/_attributes/showdebug.md b/docs/03.reference/02.tags/application/_attributes/showdebug.md new file mode 100644 index 000000000..3a76e7d41 --- /dev/null +++ b/docs/03.reference/02.tags/application/_attributes/showdebug.md @@ -0,0 +1 @@ +Show debug output at the end of teh webpage or not. \ No newline at end of file diff --git a/docs/03.reference/02.tags/application/_attributes/showdoc.md b/docs/03.reference/02.tags/application/_attributes/showdoc.md new file mode 100644 index 000000000..75e5784d5 --- /dev/null +++ b/docs/03.reference/02.tags/application/_attributes/showdoc.md @@ -0,0 +1 @@ +Show documentation output at the end of teh webpage or not. \ No newline at end of file diff --git a/docs/03.reference/02.tags/application/_attributes/showmetric.md b/docs/03.reference/02.tags/application/_attributes/showmetric.md new file mode 100644 index 000000000..7ca5c6628 --- /dev/null +++ b/docs/03.reference/02.tags/application/_attributes/showmetric.md @@ -0,0 +1 @@ +Show metric output at the end of teh webpage or not. \ No newline at end of file diff --git a/docs/03.reference/02.tags/cookie/_attributes/partitioned.md b/docs/03.reference/02.tags/cookie/_attributes/partitioned.md new file mode 100644 index 000000000..be4fbacf2 --- /dev/null +++ b/docs/03.reference/02.tags/cookie/_attributes/partitioned.md @@ -0,0 +1 @@ +Used to isolate third party cookies, requires path="/" and secure="true". \ No newline at end of file diff --git a/docs/03.reference/02.tags/dump/_attributes/flush.md b/docs/03.reference/02.tags/dump/_attributes/flush.md new file mode 100644 index 000000000..a13b84ac6 --- /dev/null +++ b/docs/03.reference/02.tags/dump/_attributes/flush.md @@ -0,0 +1 @@ +flushes the response stream after the dump \ No newline at end of file diff --git a/docs/03.reference/02.tags/flush/_attributes/throwonerror.md b/docs/03.reference/02.tags/flush/_attributes/throwonerror.md new file mode 100644 index 000000000..a2382c6c3 --- /dev/null +++ b/docs/03.reference/02.tags/flush/_attributes/throwonerror.md @@ -0,0 +1 @@ +If set to false, any exceptions thrown by the servlet engine, such as those resulting from a client disconnection, will be suppressed. \ No newline at end of file diff --git a/docs/03.reference/02.tags/ftp/_attributes/actionparam.md b/docs/03.reference/02.tags/ftp/_attributes/actionparam.md new file mode 100644 index 000000000..c8ed36e82 --- /dev/null +++ b/docs/03.reference/02.tags/ftp/_attributes/actionparam.md @@ -0,0 +1 @@ +used with action="quote" to execute custom ftp commands \ No newline at end of file diff --git a/docs/03.reference/02.tags/http/_attributes/autocert.md b/docs/03.reference/02.tags/http/_attributes/autocert.md new file mode 100644 index 000000000..6f8968bb7 --- /dev/null +++ b/docs/03.reference/02.tags/http/_attributes/autocert.md @@ -0,0 +1,3 @@ +When set to true, this attribute enables the automatic installation of SSL certificates for HTTPS connections, +ensuring the request can proceed without SSL certificate errors. +This is particularly useful for environments where certificates may not be pre-installed or are dynamically updated. \ No newline at end of file diff --git a/docs/03.reference/02.tags/ldap/_attributes/usetls.md b/docs/03.reference/02.tags/ldap/_attributes/usetls.md new file mode 100644 index 000000000..14a2841e2 --- /dev/null +++ b/docs/03.reference/02.tags/ldap/_attributes/usetls.md @@ -0,0 +1 @@ +use a secure connection. (but try secure="CFSSL_BASIC" instead) \ No newline at end of file diff --git a/docs/03.reference/02.tags/setting/_attributes/show.md b/docs/03.reference/02.tags/setting/_attributes/show.md new file mode 100644 index 000000000..0677a3c1f --- /dev/null +++ b/docs/03.reference/02.tags/setting/_attributes/show.md @@ -0,0 +1,2 @@ +Yes or No. When set to No, show suppresses monitor information that would +otherwise display at the end of the generated page. \ No newline at end of file diff --git a/docs/03.reference/02.tags/setting/_attributes/showdebug.md b/docs/03.reference/02.tags/setting/_attributes/showdebug.md new file mode 100644 index 000000000..55fdbeaf8 --- /dev/null +++ b/docs/03.reference/02.tags/setting/_attributes/showdebug.md @@ -0,0 +1,2 @@ +Yes or No. When set to No, showDebug suppresses debugging information that would +otherwise display at the end of the generated page. \ No newline at end of file diff --git a/docs/03.reference/02.tags/setting/_attributes/showdoc.md b/docs/03.reference/02.tags/setting/_attributes/showdoc.md new file mode 100644 index 000000000..49e20b027 --- /dev/null +++ b/docs/03.reference/02.tags/setting/_attributes/showdoc.md @@ -0,0 +1,2 @@ +Yes or No. When set to No, showDoc suppresses documentation/reference information that would +otherwise display at the end of the generated page. \ No newline at end of file diff --git a/docs/03.reference/02.tags/setting/_attributes/showmetric.md b/docs/03.reference/02.tags/setting/_attributes/showmetric.md new file mode 100644 index 000000000..130659527 --- /dev/null +++ b/docs/03.reference/02.tags/setting/_attributes/showmetric.md @@ -0,0 +1,2 @@ +Yes or No. When set to No, showMetric suppresses metric information that would +otherwise display at the end of the generated page. \ No newline at end of file diff --git a/docs/03.reference/02.tags/throw/_attributes/cause.md b/docs/03.reference/02.tags/throw/_attributes/cause.md new file mode 100644 index 000000000..53b978c94 --- /dev/null +++ b/docs/03.reference/02.tags/throw/_attributes/cause.md @@ -0,0 +1 @@ +the cause of the exception created with this tag. This can be a cfcatch block or a native java exception. \ No newline at end of file From eb98edb227f58db104c8c798061c0527a6622115 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 19:58:06 +0200 Subject: [PATCH 02/16] fix imported spelling --- docs/03.reference/01.functions/s3addacl/function.md | 2 +- docs/03.reference/01.functions/s3getacl/function.md | 2 +- docs/03.reference/01.functions/s3getmetadata/function.md | 2 +- docs/03.reference/01.functions/s3setacl/function.md | 2 +- docs/03.reference/01.functions/s3setmetadata/function.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/03.reference/01.functions/s3addacl/function.md b/docs/03.reference/01.functions/s3addacl/function.md index 77036f455..669c6afb1 100644 --- a/docs/03.reference/01.functions/s3addacl/function.md +++ b/docs/03.reference/01.functions/s3addacl/function.md @@ -5,4 +5,4 @@ related: categories: --- -Adds ACL to existing ACL for object or bucket. You can provide the endpoint as a bucket/object defintion (S3AddACL(bucket:"mybucket",object:"myobject.txt",acl:data) ) or as a virtual filesystem path (S3AddACL(path:"s3://mybucket/myobject.txt",acl:data) ). \ No newline at end of file +Adds ACL to existing ACL for object or bucket. You can provide the endpoint as a bucket/object definition (S3AddACL(bucket:"mybucket",object:"myobject.txt",acl:data) ) or as a virtual filesystem path (S3AddACL(path:"s3://mybucket/myobject.txt",acl:data) ). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getacl/function.md b/docs/03.reference/01.functions/s3getacl/function.md index be7097bcc..bfb406b76 100644 --- a/docs/03.reference/01.functions/s3getacl/function.md +++ b/docs/03.reference/01.functions/s3getacl/function.md @@ -5,4 +5,4 @@ related: categories: --- -Returns an array of structures, with each structure representing an ACL (Access Control List) grant. You can provide the endpoint as a bucket/object defintion (S3GetACL(bucket:"mybucket",object:"myobject.txt") ) or as a virtual filesystem path (S3GetACL(path:"s3://mybucket/myobject.txt") ). \ No newline at end of file +Returns an array of structures, with each structure representing an ACL (Access Control List) grant. You can provide the endpoint as a bucket/object definition (S3GetACL(bucket:"mybucket",object:"myobject.txt") ) or as a virtual filesystem path (S3GetACL(path:"s3://mybucket/myobject.txt") ). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3getmetadata/function.md b/docs/03.reference/01.functions/s3getmetadata/function.md index 997a5a8f5..5e0337af7 100644 --- a/docs/03.reference/01.functions/s3getmetadata/function.md +++ b/docs/03.reference/01.functions/s3getmetadata/function.md @@ -5,4 +5,4 @@ related: categories: --- -Returns the metadata related to the object or bucket. You can provide the endpoint as a bucket/object defintion (S3GetMetaData(bucket:"mybucket",object:"myobject.txt") ) or as a virtual filesystem path (S3GetMetaData(path:"s3://mybucket/myobject.txt") ). \ No newline at end of file +Returns the metadata related to the object or bucket. You can provide the endpoint as a bucket/object definition (S3GetMetaData(bucket:"mybucket",object:"myobject.txt") ) or as a virtual filesystem path (S3GetMetaData(path:"s3://mybucket/myobject.txt") ). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3setacl/function.md b/docs/03.reference/01.functions/s3setacl/function.md index 1701c3cc3..40adf9d97 100644 --- a/docs/03.reference/01.functions/s3setacl/function.md +++ b/docs/03.reference/01.functions/s3setacl/function.md @@ -5,4 +5,4 @@ related: categories: --- -Sets ACL to existing ACL for object or bucket. You can provide the endpoint as a bucket/object defintion (S3SetACL(bucket:"mybucket",object:"myobject.txt",acl:data) ) or as a virtual filesystem path (S3SetACL(path:"s3://mybucket/myobject.txt",acl:data) ). \ No newline at end of file +Sets ACL to existing ACL for object or bucket. You can provide the endpoint as a bucket/object definition (S3SetACL(bucket:"mybucket",object:"myobject.txt",acl:data) ) or as a virtual filesystem path (S3SetACL(path:"s3://mybucket/myobject.txt",acl:data) ). \ No newline at end of file diff --git a/docs/03.reference/01.functions/s3setmetadata/function.md b/docs/03.reference/01.functions/s3setmetadata/function.md index 430252c70..ae2e56390 100644 --- a/docs/03.reference/01.functions/s3setmetadata/function.md +++ b/docs/03.reference/01.functions/s3setmetadata/function.md @@ -5,4 +5,4 @@ related: categories: --- -Sets the metadata on bucket or object. You can provide the endpoint as a bucket/object defintion (S3SetMetaData(bucket:"mybucket",object:"myobject.txt",metadata:data) ) or as a virtual filesystem path (S3SetMetaData(path:"s3://mybucket/myobject.txt",metadata:data) ). \ No newline at end of file +Sets the metadata on bucket or object. You can provide the endpoint as a bucket/object definition (S3SetMetaData(bucket:"mybucket",object:"myobject.txt",metadata:data) ) or as a virtual filesystem path (S3SetMetaData(path:"s3://mybucket/myobject.txt",metadata:data) ). \ No newline at end of file From bbedf543a5737fe744ce9912782a36dd17f37358 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 19:59:34 +0200 Subject: [PATCH 03/16] fix spelling --- docs/03.reference/01.functions/createulid/function.md | 2 +- docs/03.reference/02.tags/application/_attributes/showdebug.md | 2 +- docs/03.reference/02.tags/application/_attributes/showdoc.md | 2 +- docs/03.reference/02.tags/application/_attributes/showmetric.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/03.reference/01.functions/createulid/function.md b/docs/03.reference/01.functions/createulid/function.md index 5ea4576af..5c9030271 100644 --- a/docs/03.reference/01.functions/createulid/function.md +++ b/docs/03.reference/01.functions/createulid/function.md @@ -1,5 +1,5 @@ --- -title: createulid +title: createULID id: function-createulid related: categories: diff --git a/docs/03.reference/02.tags/application/_attributes/showdebug.md b/docs/03.reference/02.tags/application/_attributes/showdebug.md index 3a76e7d41..c9247598b 100644 --- a/docs/03.reference/02.tags/application/_attributes/showdebug.md +++ b/docs/03.reference/02.tags/application/_attributes/showdebug.md @@ -1 +1 @@ -Show debug output at the end of teh webpage or not. \ No newline at end of file +Show debug output at the end of the webpage or not. \ No newline at end of file diff --git a/docs/03.reference/02.tags/application/_attributes/showdoc.md b/docs/03.reference/02.tags/application/_attributes/showdoc.md index 75e5784d5..b48d8c5f5 100644 --- a/docs/03.reference/02.tags/application/_attributes/showdoc.md +++ b/docs/03.reference/02.tags/application/_attributes/showdoc.md @@ -1 +1 @@ -Show documentation output at the end of teh webpage or not. \ No newline at end of file +Show documentation output at the end of the webpage or not. \ No newline at end of file diff --git a/docs/03.reference/02.tags/application/_attributes/showmetric.md b/docs/03.reference/02.tags/application/_attributes/showmetric.md index 7ca5c6628..3c55f21f6 100644 --- a/docs/03.reference/02.tags/application/_attributes/showmetric.md +++ b/docs/03.reference/02.tags/application/_attributes/showmetric.md @@ -1 +1 @@ -Show metric output at the end of teh webpage or not. \ No newline at end of file +Show metric output at the end of the webpage or not. \ No newline at end of file From a9d251d2133bf6f0078b63e283f10c418f1be246 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 20:07:01 +0200 Subject: [PATCH 04/16] fix markup --- docs/04.guides/02.installing-lucee/03.osx/chapter.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/04.guides/02.installing-lucee/03.osx/chapter.md b/docs/04.guides/02.installing-lucee/03.osx/chapter.md index 9d617d3db..cf98919e1 100644 --- a/docs/04.guides/02.installing-lucee/03.osx/chapter.md +++ b/docs/04.guides/02.installing-lucee/03.osx/chapter.md @@ -7,6 +7,7 @@ menuTitle: MacOS Here you can find guides on how to run Lucee on MacOS / OS X. While there isn't currently an official Lucee installer for MacOS, there are still several other ways to run Lucee on a Mac: + * [Lucee Express](https://docs.lucee.org/guides/installing-lucee/download-and-install.html#download-and-install-lucee-server) (zip install approach) * [[running-lucee-installing-tomcat-and-lucee-on-os-x-using-the-lucee-war-file]] * [Lucee Docker containers](https://github.com/lucee/lucee-dockerfile) From c60f59287667204dd0a59de1b9d44ea2433dee34 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 20:07:45 +0200 Subject: [PATCH 05/16] cleanup GHA --- .github/workflows/index-recipes.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/index-recipes.yml b/.github/workflows/index-recipes.yml index 8ffd56d52..598fb4ee0 100644 --- a/.github/workflows/index-recipes.yml +++ b/.github/workflows/index-recipes.yml @@ -3,9 +3,9 @@ name: Generate Recipes Index on: push: branches: - - '**' # This will trigger on push to any branch + - "**" # This will trigger on push to any branch paths: - - 'docs/recipes/**' + - "docs/recipes/**" workflow_dispatch: jobs: @@ -14,7 +14,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Set up Node.js uses: actions/setup-node@v2 From b3005417d28aafa6929a160d2a4c93da6d844995 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 20:10:42 +0200 Subject: [PATCH 06/16] cleanup markdown --- docs/recipes/extension-installation.md | 17 ++++++++++++++++- docs/recipes/java-explicit-casting.md | 3 +++ docs/recipes/startup-listeners-code.md | 2 ++ 3 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/recipes/extension-installation.md b/docs/recipes/extension-installation.md index fcc799e9b..7ca98c13a 100644 --- a/docs/recipes/extension-installation.md +++ b/docs/recipes/extension-installation.md @@ -23,29 +23,36 @@ In Lucee, there are multiple ways to install an extension. This recipe will show you all the possibilities along with their pros and cons. ## Lucee Administrator + You can install an extension in the Lucee Administrator by navigating to Extensions/Applications in the Lucee (Server) Administrator and installing or uninstalling the extension you need. ### Pros + - No physical access to the server needed - User-friendly interface - Immediate feedback on the installation process -### Cons +### Cons + - Manual process that is not easily repeatable - Requires access to the Lucee Administrator interface ## `deploy` Directory + Simply copy the extension you want to install into the folder `{lucee-installation}/lucee-server/deploy`. Lucee will pick it up at startup or within a minute after startup and install it. You can find extensions to install under [download.lucee.org](https://download.lucee.org). ### Pros + - Hot deployment on a running server possible with no restart needed (except for some extensions) - Can be automated with scripts ### Cons + - Requires physical or SSH access to the server - Some extensions may require a restart to work properly ## `.CFConfig.json` Configuration (Lucee 6 Only) + With Lucee 6, you can define the extensions you need in the `.CFConfig.json` file that holds all your configurations. ```json @@ -77,17 +84,21 @@ On a fresh install of Lucee, Lucee will install the [bundled extensions](https:/ With Lucee 6.1, the "id" attribute is no longer necessary when you define a path. ### Important Notes for Multi-Mode (Server and Web Admin Enabled) + - If you run Lucee in Multi-Mode (Server and Web Admin enabled), you need to add the extension configuration to the root of the server context JSON file located at `{lucee-installation}/lucee-server/context/.CFConfig.json` and not in the web context JSON file. ### Pros + - You can automate the process - Easy to manage configurations and extensions in one place ### Cons + - No hot deployment - Requires configuration file management ## Environment Variable / System Property + You can also define the extension in an environment variable or system property. This option is similar to the `.CFConfig.json` option. Define a comma-separated list of Lucee extensions to install when starting up. This can be a simple list of IDs, in which case the latest versions will be installed: @@ -124,17 +135,21 @@ java -Dlucee.extensions="99A4EF8D-F2FD-40C8-8FB8C2E67A4EEEB6;name=MSSQL;version= ``` ### Pros + - Can be used in various deployment environments (e.g., Docker, cloud services) - Supports automation and infrastructure as code practices ### Cons + - No hot deployment - Requires setting environment variables or system properties, which might be complex in some environments ## Logging and Troubleshooting + If you encounter issues while installing extensions, you can check the log at `{lucee-installation}/lucee-server/context/logs/deploy.log` not only for any errors reported but also to see what actions were performed. This log is by default set to info level and should contain all details about the installation process. ## Conclusion + Lucee offers several methods to install extensions, each with its own advantages and disadvantages. Choose the method that best fits your deployment and management workflow: - **Lucee Administrator**: Best for manual, ad-hoc installations. diff --git a/docs/recipes/java-explicit-casting.md b/docs/recipes/java-explicit-casting.md index 41922d46a..8411ae2f8 100644 --- a/docs/recipes/java-explicit-casting.md +++ b/docs/recipes/java-explicit-casting.md @@ -21,6 +21,7 @@ This guide demonstrates how to explicitly cast a component to a specific interface in Lucee. ## Implicit Casting + Lucee supports implicit casting by passing a component to a method where the method argument is of a specific type. For example: ```lucee @@ -39,9 +40,11 @@ getPageContext().setLocale(cs); In this example, Lucee implicitly finds a matching method and converts the component to a class implementing the `java.lang.CharSequence` interface. ## Explicit Casting + Sometimes, implicit casting can be problematic if Lucee cannot make the correct fit, or if a method is overloaded and you need to specify which method to use. For instance, the `PageContext` class has two `setLocale` methods: + - `setLocale(java.lang.String): void` - `setLocale(java.util.Locale): void` diff --git a/docs/recipes/startup-listeners-code.md b/docs/recipes/startup-listeners-code.md index dad645d99..f82ed9e43 100644 --- a/docs/recipes/startup-listeners-code.md +++ b/docs/recipes/startup-listeners-code.md @@ -72,9 +72,11 @@ Start the Lucee Server, and the server console should display the above system o ### Functions in Server.cfc #### onServerStart + `onServerStart` is called when you start Lucee. The `reload` argument is set to `false` on the first start, and `true` when any configuration in the Lucee Administrator is updated or an extension is installed. #### onBuild (since Lucee 6.1.1) + `onBuild` is called when you start Lucee with the environment variable `LUCEE_BUILD` (or the older variable `LUCEE_ENABLE_WARMUP`) set to `true`. You can also use the system property `-Dlucee.build` (or `-dlucee-enable.warmup`). This feature got indroduced in Lucee 6.1.1. ## Web.cfc From 0447338b78bf7ad0c9d2b2d58fbe8333756148c1 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 6 Jul 2024 18:10:59 +0000 Subject: [PATCH 07/16] Update recipes index and README --- docs/recipes/index.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/recipes/index.json b/docs/recipes/index.json index 2260f8fdf..e0f7a0226 100644 --- a/docs/recipes/index.json +++ b/docs/recipes/index.json @@ -314,7 +314,7 @@ "file": "extension-installation.md", "title": "Extension Installation", "path": "/docs/recipes/extension-installation.md", - "hash": "2b021c12fbccf07d6d67a86be223fee0", + "hash": "9b5d3396c15710bdd224d63171ec3fd9", "keywords": [ "extension", "install", @@ -463,7 +463,7 @@ "file": "java-explicit-casting.md", "title": "Java - Explicit Casting of a Component to a Specific Interface", "path": "/docs/recipes/java-explicit-casting.md", - "hash": "f13d00993a1625d4aad2d6faec1ae66e", + "hash": "d7bf4af9b9a8bacd1cde12f9f2a15bc7", "keywords": [ "java", "cast", @@ -825,7 +825,7 @@ "file": "startup-listeners-code.md", "title": "Startup Listeners - Server.cfc and Web.cfc", "path": "/docs/recipes/startup-listeners-code.md", - "hash": "9390ecac97cc234930c419a9ec08d10e", + "hash": "edb4b5bdad97967849c5796a18a0fe09", "keywords": [ "startup", "warmup", From e32d6c6a596a0540334fb2f50cc51b6069c469c4 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 20:15:47 +0200 Subject: [PATCH 08/16] fix README generator to generate valid markdown --- .github/scripts/generate-index-recipes.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/scripts/generate-index-recipes.js b/.github/scripts/generate-index-recipes.js index f5b8f7be2..3c6969d32 100644 --- a/.github/scripts/generate-index-recipes.js +++ b/.github/scripts/generate-index-recipes.js @@ -52,7 +52,7 @@ async function generateIndex() { await fs.writeJson(outputPath, index, { spaces: 2 }); console.log(`Writing README to ${readmePath}`); - await fs.writeFile(readmePath, readmeContent, 'utf-8'); + await fs.writeFile(readmePath, trim(readmeContent), 'utf-8'); const readmeExists = await fs.pathExists(readmePath); console.log(`README exists: ${readmeExists}`); From 682574f10d84e912b16383506c0fe8ebd8459aa5 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 20:17:47 +0200 Subject: [PATCH 09/16] fix yaml --- .github/workflows/index-recipes.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/index-recipes.yml b/.github/workflows/index-recipes.yml index 598fb4ee0..37f79ce8d 100644 --- a/.github/workflows/index-recipes.yml +++ b/.github/workflows/index-recipes.yml @@ -3,7 +3,7 @@ name: Generate Recipes Index on: push: branches: - - "**" # This will trigger on push to any branch + - "**" paths: - "docs/recipes/**" workflow_dispatch: From a2df83e4984dbd5de0c6b877e7c65e0f9d10c9e9 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 20:22:14 +0200 Subject: [PATCH 10/16] use 6.1.0.235-RC --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1f91e4459..44d19c43f 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.217-SNAPSHOT + luceeVersion: 6.1.0.235-RC # 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 From 0db274f328dc40a3c87908b482a8d203cc809710 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Sat, 6 Jul 2024 20:22:47 +0200 Subject: [PATCH 11/16] fix code typos --- api/data/DocTree.cfc | 6 +++--- build-all.cfm | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/data/DocTree.cfc b/api/data/DocTree.cfc index 3ca6b4dec..76973e6f9 100644 --- a/api/data/DocTree.cfc +++ b/api/data/DocTree.cfc @@ -332,9 +332,9 @@ component accessors=true { variables.tree.append( arguments.page ); } - if ( !isPage ){ - if ( page.getPath() comtains "/recipes" ){ - request.logger(text="skipping coz /recipes" ); + if ( not isPage ){ + if ( arguments.page.getPath() contains "/recipes" ) { + request.logger( text="skipping coz /recipes" ); return; } throw "not a page [#page.path#]"; // only add main pages diff --git a/build-all.cfm b/build-all.cfm index d23d218e2..4b79a7504 100644 --- a/build-all.cfm +++ b/build-all.cfm @@ -5,7 +5,7 @@ if ( fileExists( docsZipFile ) ) fileDelete( docsZipFile ); if (directoryExists( "builds/artifacts") ){ - directoryDelete(" builds/artifacts", true); + directoryDelete("builds/artifacts", true); } include template="import.cfm"; include template="build.cfm"; From 6be1c92d102332f377ce3e0451fb37139703cd58 Mon Sep 17 00:00:00 2001 From: Zac Spitzer Date: Tue, 9 Jul 2024 01:40:02 +0200 Subject: [PATCH 12/16] enable recipe parsing --- api/data/DocTree.cfc | 57 +++++++++++++---------- api/data/Page.cfc | 11 ++++- api/data/PageReader.cfc | 70 ++++++++++++++++++++++++++--- api/rendering/SyntaxHighlighter.cfc | 12 ++++- builders/html/Builder.cfc | 2 +- 5 files changed, 118 insertions(+), 34 deletions(-) diff --git a/api/data/DocTree.cfc b/api/data/DocTree.cfc index 76973e6f9..bb724735c 100644 --- a/api/data/DocTree.cfc +++ b/api/data/DocTree.cfc @@ -30,13 +30,13 @@ component accessors=true { private void function _initializeEmptyTree() { setTree( [] ); - setIdMap( {} ); - setPathMap( {} ); - setPageTypeMap( {} ); - setRelatedMap( {} ); - setCategoryMap( {} ); - setReferenceMap( {} ); - setDirectlyRelatedMap( {} ); + setIdMap( [:] ); + setPathMap( [:] ); + setPageTypeMap( [:] ); + setRelatedMap( [:] ); + setCategoryMap( [:] ); + setReferenceMap( [:] ); + setDirectlyRelatedMap( [:] ); } public void function updateTree() { @@ -44,10 +44,14 @@ component accessors=true { } public any function getPage( required string id ) { + if ( !pageExists( arguments.id ) ) + systemOutput( "GetPage: #id# does not exist in doctree", true ); return variables.idMap[ arguments.id ] ?: NullValue(); } public any function getPageByPath( required string path ) { + if ( !structKeyExists( variables.pathMap, arguments.path ) ) + systemOutput( "GetPageByPath: #path# does not exist in doctree", true ); return variables.pathMap[ arguments.path ] ?: NullValue(); } @@ -206,16 +210,19 @@ component accessors=true { var start = getTickCount(); var _threads = getThreads(); each (q_source_files, function (page) { + // systemOutput( arguments.page.path & arguments.page.name, true); var _parsedPage = new PageReader().preparePageObject( variables.rootDir, arguments.page.name, arguments.page.directory, arguments.page.path ); if ( ! _parsedPage.getHidden() ) { variables.pageCache.addPage( _parsedPage, - arguments.page.path + _parsedPage.getPath() ); + } else { + // systemOutput("hidden--------------------#arguments.page.path#", true) } }, (_threads != 1), _threads); - request.logger (text="Pages Parsed in #(getTickCount()-start)/1000#s"); + request.logger (text=" #len(variables.pageCache.getPages())# Pages Parsed in #(getTickCount()-start)/1000#s"); _buildTreeHierachy(false); _parseTree(); @@ -292,16 +299,22 @@ component accessors=true { private void function _parseTree( ) { // expose guides as a top level folder for (var folder in variables.tree){ - if (folder.getId() eq "guides"){ - var guideTree = folder.getChildren(); - for (var guide in guideTree){ - if (guide.getForceSortOrder() gt 0){ - guide.setSortOrder(guide.getForceSortOrder()); - } else { - guide.setSortOrder(6 + NumberFormat(guide.getSortOrder()/100,"0.00")); + switch( folder.getId() ){ + case "guides": + var guideTree = folder.getChildren(); + for (var guide in guideTree){ + if (guide.getForceSortOrder() gt 0){ + guide.setSortOrder(guide.getForceSortOrder()); + } else { + guide.setSortOrder(6 + NumberFormat(guide.getSortOrder()/100,"0.00")); + } + variables.tree.append(guide); } - variables.tree.append(guide); - } + break; + /* + case "recipes": + break; + */ } } _sortChildren( variables.tree ); @@ -332,12 +345,8 @@ component accessors=true { variables.tree.append( arguments.page ); } - if ( not isPage ){ - if ( arguments.page.getPath() contains "/recipes" ) { - request.logger( text="skipping coz /recipes" ); - return; - } - throw "not a page [#page.path#]"; // only add main pages + if ( !isPage ){ + throw "not a page [#page.getFilePath()#]"; // only add main pages } if ( !StructKeyExists( variables.pageTypeMap, pageType ) ) diff --git a/api/data/Page.cfc b/api/data/Page.cfc index 2c3a0a5d2..956017586 100644 --- a/api/data/Page.cfc +++ b/api/data/Page.cfc @@ -51,7 +51,7 @@ component accessors=true { } public string function getPageMenuTitle(){ - if (len(getMenuTitle()) gt 0) + if ( len( getMenuTitle() ) gt 0 ) return getMenuTitle(); else return getTitle(); @@ -110,4 +110,13 @@ component accessors=true { return "[[object-#type#]]"; } } + + public function getInstance(){ + var st = {}; + for ( var v in variables ){ + if ( !isNull(variables[ v ]) && isSimpleValue( variables[ v ] ) and len( variables[v] ) lt 75 ) + st[v ] = variables[ v ]; + } + return st; + } } \ No newline at end of file diff --git a/api/data/PageReader.cfc b/api/data/PageReader.cfc index dd2de1a79..2a4e1a8c0 100644 --- a/api/data/PageReader.cfc +++ b/api/data/PageReader.cfc @@ -43,14 +43,32 @@ component { } } - page.setPath( arguments.pagePath ); + // hack to restructure recipes as docs content + if ( listFirst( page.getPath(), "/" ) eq "recipes" ){ + page.setSlug( page.getPageType() ) + + if (page.getPageType() eq "README"){ + page.setPath( page.getPath() ); + page.setPageType( "listing" ); + page.setVisible( true ); + page.setReference( false ); + page.setBody( "Recipes" ); + page.setTitle( "Lucee Recipes" ); + page.setDescription( "Lucee Recipes" ); + } else { + page.setPath( page.getPath() & "/" & replace( page.getPageType(), ".md", "" ) ); + page.setPageType( "page" ); + } + } else { + page.setPath( arguments.pagePath ); + } + if ( !page.getId().len() ) { page.setId( page.getPath() ); } page.setChildren( [] ); page.setDepth( ListLen( page.getPath(), "/" ) ); - return page; } @@ -74,7 +92,7 @@ component { var slug = ListLast( arguments.pageDir, "\/" ); var fileContent = FileReadAsUnix( path ); - var data = _parsePage( fileContent ); + var data = _parsePage( fileContent, path ); var sortOrder = ""; // if the last directory is in the format 00.home, flag is as visible @@ -118,22 +136,24 @@ component { public any function readPageFileSource( required string filePath ) { var path = Replace(arguments.filePath,"\","/","all"); var fileContent = FileReadAsUnix( path ); - var data = _parsePage( fileContent ); + var data = _parsePage( fileContent, arguments.filePath ); return data; } - private struct function _parsePage( required string pageContent ) { + private struct function _parsePage( required string pageContent, required string filePath ) { var yamlAndBody = _splitYamlAndBody( arguments.pageContent ); var parsed = { body = yamlAndBody.body }; if ( yamlAndBody.yaml.len() ) { parsed.append( _parseYaml( yamlAndBody.yaml ), false ); + } else if ( len( trim( arguments.pageContent ) ) ){ + parsed = _splitCommentStructAndBody( arguments.pageContent, arguments.filePath ); } return parsed; } - private struct function _splitYamlAndBody( required string pageContent ) { + private struct function _splitYamlAndBody( required string pageContent, string filePath ) { var splitterRegex = "^(\-\-\-\n(.*?)\n\-\-\-\n)?(.*)$"; return { @@ -142,6 +162,44 @@ component { } } + private struct function _splitCommentStructAndBody( required string pageContent, string filePath ) { + // recipies use a different format, json in html comments + /* + + + */ + var str = trim( arguments.pageContent ); + var startComment = find("", str, startComment ); + if ( endComment == 0 ) + throw "missing closing html comment metadata [#arguments.filePath#]"; + var meta = mid( str, 5, endComment - 5 ); + //systemOutput( "!!" & meta & "!!", true ); + if ( !isJson( meta ) ){ + throw "metadata is not json [#arguments.filePath#]"; + } + var body = mid( str, endComment + 3 ); + if ( len( trim( body ) ) eq 0 ) + throw "empty content after metadata [#arguments.filePath#]"; + return { + yaml = deserializeJson( meta ) + , body = body + } + } + private string function _convertToUnixLineEnding( required string content ){ return REReplace(arguments.content, "\r\n", chr(10), "all"); } diff --git a/api/rendering/SyntaxHighlighter.cfc b/api/rendering/SyntaxHighlighter.cfc index f753612ff..dc7a8301b 100644 --- a/api/rendering/SyntaxHighlighter.cfc +++ b/api/rendering/SyntaxHighlighter.cfc @@ -26,8 +26,16 @@ component { } else if ( arguments.language.reFindNoCase( "^(lucee|cfm|coldfusion)" ) ) { arguments.language = "cfm"; } - - var highlighted = highlighter.highlight( arguments.code, arguments.language, false ); + lock name="highlight" type="exclusive" timeout=10 { + try { + var highlighted = highlighter.highlight( arguments.code, arguments.language, false ); + } catch (e ){ + + systemOutput( arguments, true ); + //systemOutput( e ); + highlighted = arguments.code; + } + } if ( useTryCf ) { var rawCode = '