improve md

lucee · Jun 6, 2024 · eec3cdb · eec3cdb
1 parent 53b4de3
commit eec3cdb
Show file tree

Hide file tree

Showing 63 changed files with 1,605 additions and 161 deletions.
diff --git a/docs/recipes/application-context-update.md b/docs/recipes/application-context-update.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Update current Application Context",
-  "id": "cookbook-application-context-update",
+  "id": "update-application-context",
   "related": [
     "tag-application"
   ],
@@ -19,7 +19,7 @@
   ]
 }
 -->
-# Update Application Context
+# Application Context update
 
 Lucee allows you to update the existing application context defined for example in [cookbook-application-context-basic].
 

diff --git a/docs/recipes/deploy-archives.md → docs/recipes/archives-creating-and-deploy.md b/docs/recipes/deploy-archives.md → docs/recipes/archives-creating-and-deploy.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Creating and deploying Lucee Archives (.lar files)",
-  "id": "deploy-archives",
+  "id": "archives-creating-and-deploy",
   "description": "This document explains how to deploy an Application on a live server without using a single CFML file.",
   "keywords": [
     "Lucee",
@@ -15,7 +15,7 @@
   ]
 }
 -->
-# Creating and deploying Lucee Archives (.lar files)
+# Archives - Creating and deploying Lucee Archives (.lar files)
 
 This document explains how to deploy an Application on a live server without using a single CFML file.
 

diff --git a/docs/recipes/basic-date.md b/docs/recipes/basic-date.md
@@ -14,7 +14,7 @@
   ]
 }
 -->
-# Output the current date
+# Basic Date - Output the current date
 
 The following examples show you how to output the current date.
 

diff --git a/docs/recipes/cached-within-request.md b/docs/recipes/cached-within-request.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Cache a query for the current request",
-  "id": "cookbook-cached-within-request",
+  "id": "cache-a-query-for-the-curr-context",
   "related": [
     "tag-query"
   ],

diff --git a/docs/recipes/caches-in-application-cfc.md → ...ipes/caches-defined-in-application-cfc.md b/docs/recipes/caches-in-application-cfc.md → ...ipes/caches-defined-in-application-cfc.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Adding Caches via Application.cfc",
-  "id": "cookbook-caches-in-application-cfc",
+  "id": "caches-defined-in-application-cfc",
   "related": [
     "tag-application"
   ],
@@ -21,7 +21,7 @@
   ]
 }
 -->
-# Adding Caches via Application.cfc
+# Caches defined in Application.cfc
 
 It is possible to add cache connections in Lucee 5.1+ on a per-application basis by adding configuration to your `Application.cfc`. You can also select the default object cache, query cache, function cache, etc. Note if these caches use an extension that provides the cache driver, the extension must be installed already.
 

diff --git a/docs/recipes/cfml-to-java.md → docs/recipes/convert-a-cfml-func-to-java.md b/docs/recipes/cfml-to-java.md → docs/recipes/convert-a-cfml-func-to-java.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Convert a CFML Function/Component to use in Java",
-  "id": "convert-cfml-to-java",
+  "id": "convert-a-cfml-func-to-java",
   "description": "Learn how to convert user-defined functions or components in Lucee to use them in Java. This guide demonstrates how to define components to implement Java interfaces, pass components to Java methods, explicitly define interfaces, and use the onMissingMethod feature. It also shows how to convert user-defined functions to Java lambdas.",
   "since": "6.0",
   "keywords": [

diff --git a/docs/recipes/datasource-define-datasource.md → .../recipes/datasource-how-to-define-them.md b/docs/recipes/datasource-define-datasource.md → .../recipes/datasource-how-to-define-them.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Datasources",
-  "id": "cookbook-datasource-define-datasource",
+  "id": "datasource-how-to-define-them",
   "description": "How to define a Datasource in Lucee.",
   "keywords": [
     "Datasource",
@@ -13,7 +13,7 @@
   ]
 }
 -->
-# How to define a Datasource
+# Datasource - How to define them
 
 To execute queries, you need a datasource definition, which points to a specific local or remote datasource. There are different ways to do so.
 

diff --git a/docs/recipes/settings.md → ...nvironment-variables-system-properties.md b/docs/recipes/settings.md → ...nvironment-variables-system-properties.md
diff --git a/docs/recipes/event-gateway-create.md b/docs/recipes/event-gateway-create.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Custom Event Gateways",
-  "id": "create-event-gateway",
+  "id": "custom-event-gateways",
   "categories": [
     "gateways"
   ],

diff --git a/...ecipes/application-context-set-mapping.md → docs/recipes/event-gateway-in-app-cfc.md b/...ecipes/application-context-set-mapping.md → docs/recipes/event-gateway-in-app-cfc.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Event Handling in Application.cfc",
-  "id": "cookbook-event-handling",
+  "id": "event-gateway-in-app-cfc",
   "related": [
     "tag-application",
     "function-onrequest",

diff --git a/docs/recipes/event-gateways-overview.md → docs/recipes/event-gateways-how-they-work.md b/docs/recipes/event-gateways-overview.md → docs/recipes/event-gateways-how-they-work.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Event Gateways",
-  "id": "event-gateways-overview",
+  "id": "event-gateways-how-they-work",
   "categories": [
     "gateways"
   ],
@@ -16,7 +16,7 @@
   ]
 }
 -->
-# How does an Event Gateway work?
+# Event Gateway - How they work?
 
 An event gateway is a background process that continuously runs.
 

diff --git a/docs/recipes/event-gateways.md b/docs/recipes/event-gateways.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Event Gateways in Lucee",
-  "id": "event-gateways-lucee",
+  "id": "event-gateways",
   "related": [
     "function-sendgatewaymessage"
   ],
@@ -20,7 +20,7 @@
   ]
 }
 -->
-# Lucee Event Gateways
+# Event Gateways
 
 First of all, it is necessary to explain how Event Gateways (EG) are working in the first place. EG's are another way to communicate with your Lucee server and are kind of a service running on Lucee, reacting to certain events. These kinds of events could be something along the lines of:
 

diff --git a/docs/recipes/application-context-basic.md → docs/recipes/event-handling-in-app-cfc.md b/docs/recipes/application-context-basic.md → docs/recipes/event-handling-in-app-cfc.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Event Handling in Application.cfc",
-  "id": "cookbook-event-handling",
+  "id": "event-handling-in-app-cfc",
   "related": [
     "tag-application",
     "function-onrequest",

diff --git a/docs/recipes/exception-output.md b/docs/recipes/exception-output.md
@@ -22,7 +22,7 @@
   ]
 }
 -->
-# Output Exceptions
+# Exceptions Output
 
 How to catch and display exceptions
 

diff --git a/docs/recipes/Externalizing_Strings.md → docs/recipes/externalizing-strings.md b/docs/recipes/Externalizing_Strings.md → docs/recipes/externalizing-strings.md
diff --git a/docs/recipes/systemoutput_function.md → docs/recipes/function-systemoutput.md b/docs/recipes/systemoutput_function.md → docs/recipes/function-systemoutput.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Function SystemOutput",
-  "id": "systemoutput_function",
+  "id": "function-systemoutput",
   "description": "This document explains the systemoutput function with some simple examples.",
   "keywords": [
     "SystemOutput function",

diff --git a/docs/recipes/gateways-overview.md b/docs/recipes/gateways-overview.md
diff --git a/docs/recipes/hidden_gems.md → docs/recipes/hidden-gems.md b/docs/recipes/hidden_gems.md → docs/recipes/hidden-gems.md
diff --git a/docs/recipes/java-in-functions.md → ...recipes/java-in-functions-and-closures.md b/docs/recipes/java-in-functions.md → ...recipes/java-in-functions-and-closures.md
diff --git a/docs/recipes/lazy_queries.md → docs/recipes/lazy-queries.md b/docs/recipes/lazy_queries.md → docs/recipes/lazy-queries.md
diff --git a/docs/recipes/cache-list.md → docs/recipes/list-existing-cache-conn.md b/docs/recipes/cache-list.md → docs/recipes/list-existing-cache-conn.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "List existing Cache Connections",
-  "id": "cookbook-cache-list",
+  "id": "list-existing-cache-conn",
   "categories": [
     "cache"
   ],

diff --git a/docs/recipes/labels.md → docs/recipes/loop-labels.md b/docs/recipes/labels.md → docs/recipes/loop-labels.md
diff --git a/docs/recipes/loop_through_files.md → docs/recipes/loop-through-files.md b/docs/recipes/loop_through_files.md → docs/recipes/loop-through-files.md
diff --git a/docs/recipes/mail-send.md → docs/recipes/mail-how-to-send-a-mail.md b/docs/recipes/mail-send.md → docs/recipes/mail-how-to-send-a-mail.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Sending Emails",
-  "id": "cookbook-mail-send",
+  "id": "mail-how-to-send-a-mail",
   "related": [
     "tag-imap",
     "tag-mail",
@@ -19,7 +19,7 @@
   ]
 }
 -->
-# How to send a Mail
+# Mail - How to send a Mail
 
 The following example shows you how you can send a mail. Before you can use this functionality, you have to define a Mail server in the Lucee Administrator.
 

diff --git a/...ipes/filesystem-mapping-define-mapping.md → ...s/mappings-how-to-define-a-reg-mapping.md b/...ipes/filesystem-mapping-define-mapping.md → ...s/mappings-how-to-define-a-reg-mapping.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Define a mapping",
-  "id": "cookbook-filesystem-mapping-define-mapping",
+  "id": "mappings-how-to-define-a-reg-mapping",
   "related": [
     "tag-application",
     "function-expandpath",
@@ -21,7 +21,7 @@
   ]
 }
 -->
-# How to define a regular Mapping
+# Mappings - How to define a regular Mapping
 
 Lucee allows you to define a mapping to a specific location in a filesystem, so you don't always have to use the full path. In most cases, the full path is not working anyway, for example with [tag-include] which does not work with a full path.
 

diff --git a/docs/recipes/monitoring.md → docs/recipes/monitoring-debugging.md b/docs/recipes/monitoring.md → docs/recipes/monitoring-debugging.md
diff --git a/docs/recipes/null_support.md → docs/recipes/null-support.md b/docs/recipes/null_support.md → docs/recipes/null-support.md
diff --git a/docs/recipes/flying_saucer.md → docs/recipes/pdf-engine-flying-saucer.md b/docs/recipes/flying_saucer.md → docs/recipes/pdf-engine-flying-saucer.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Flying Saucer PDF Engine - CFDOCUMENT",
-  "id": "flying_saucer",
+  "id": "pdf-engine-flying-saucer",
   "related": [
     "tag-document"
   ],
@@ -18,7 +18,7 @@
   ]
 }
 -->
-# Flying Saucer PDF Engine - CFDOCUMENT
+# PDF Engine - Flying Saucer (CFDocument)
 This document provides information about the new PDF engine, [Flying Saucer](https://github.com/flyingsaucerproject/flyingsaucer) (FS) in Lucee 5.3
 
 Flying saucer is a new PDF engine in Lucee. PDF engines are mainly used to convert HTML to PDF format.

diff --git a/docs/recipes/QOQ_Sucks.md → docs/recipes/query-of-query-sometime.md b/docs/recipes/QOQ_Sucks.md → docs/recipes/query-of-query-sometime.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Query of Queries sometimes it rocks, sometimes it sucks",
-  "id": "QOQ_Sucks",
+  "id": "query-of-query-sometime",
   "related": [
     "tag-query",
     "function-queryexecute",
@@ -21,7 +21,7 @@
   ]
 }
 -->
-# The good, the bad and the ugly
+# Query of Queries sometimes it rocks, sometimes it sucks
 
 This document explains why Query of Queries (QoQ) may or may not be the best approach for your use case.
 

diff --git a/docs/recipes/query_return_type.md → docs/recipes/query-return-type.md b/docs/recipes/query_return_type.md → docs/recipes/query-return-type.md
@@ -1,7 +1,7 @@
 <!--
 {
   "title": "Query return type",
-  "id": "query_return_type",
+  "id": "query-return-type",
   "categories": [
     "query"
   ],
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,7 +14,7 @@ @@
       ]
     }
     -->
-    # Output the current date
+    # Basic Date - Output the current date
     The following examples show you how to output the current date.
@@ Expand Down @@