Skip to content

Commit

Permalink
cross reference recipes
Browse files Browse the repository at this point in the history
  • Loading branch information
zspitzer committed Jan 17, 2025
1 parent a48dbfe commit 4e18c28
Show file tree
Hide file tree
Showing 32 changed files with 182 additions and 102 deletions.
8 changes: 7 additions & 1 deletion builders/html/Builder.cfc
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,13 @@ component {
FileWrite( arguments.buildDirectory & "/sitemap.xml", _renderSiteMap( arguments.docTree ) );
// google analytics for @zackster
FileWrite( arguments.buildDirectory & "/google4973ccb67f78b874.html", "google-site-verification: google4973ccb67f78b874.html");
FileWrite( arguments.buildDirectory & "/robots.txt", "User-agent: *#chr(10)#Disallow: /dictionaries/#chr(10)#Sitemap: https://docs.lucee.org/sitemap.xml");
FileWrite( arguments.buildDirectory & "/robots.txt", [
"User-agent: *",
"Disallow: /dictionaries/",
"Disallow: /editor.html",
"Sitemap: https://docs.lucee.org/sitemap.xml"
].toList(chr(10))
);

FileCopy( GetDirectoryFromPath( GetCurrentTemplatePath() ) & "/assets/trycf/index.html", arguments.buildDirectory & "/editor.html" );
}
Expand Down
77 changes: 0 additions & 77 deletions docs/04.guides/04.cookbooks/40.System_output/page.md

This file was deleted.

4 changes: 3 additions & 1 deletion docs/04.guides/06.extensions/02.extension-websocket/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ title: Websocket gateway
id: extensions-websocket-gateway
categories:
- ajax
- gateways
- extensions
- gateways
- protocols
description: 'This extension enables you to launch a server that is capable to manage
messaging from HTML WebSockets. '
---

### WebSockets Gateway Extension ###
Expand Down
7 changes: 5 additions & 2 deletions docs/recipes/breaking-changes-6-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@
{
"title": "Breaking Changes Between Lucee 6.0 and 6.1",
"id": "breaking-changes-6-0-to-6-1",
"categories": ["breaking changes", "migration"],
"categories": ["breaking changes", "migration","compat"],
"description": "A guide to breaking changes introduced in Lucee between version 6.0 and 6.1",
"keywords": ["breaking changes", "Lucee 6.0", "Lucee 6.1", "migration", "upgrade"]
"keywords": ["breaking changes", "Lucee 6.0", "Lucee 6.1", "migration", "upgrade"],
"related": [
"logging-cfhttp-calls"
]
}
-->

Expand Down
6 changes: 6 additions & 0 deletions docs/recipes/convert-a-cfml-func-to-java.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@
"Java",
"lambda",
"Lucee"
],
"categories":[
"java"
],
"related": [
"tag-component"
]
}
-->
Expand Down
3 changes: 2 additions & 1 deletion docs/recipes/event-gateway-in-app-cfc.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
],
"categories": [
"application",
"event handling"
"event handling",
"gateways"
],
"description": "An overview of event handling functions in Application.cfc for Lucee.",
"images": {
Expand Down
17 changes: 14 additions & 3 deletions docs/recipes/function-systemoutput.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,32 @@
<!--
{
"title": "Function SystemOutput",
"id": "function-systemoutput",
"title": "SystemOutput, writing to the console",
"id": "systemoutput-recipe",
"description": "This document explains the systemoutput function with some simple examples.",
"keywords": [
"SystemOutput function",
"Debugging",
"Output stream",
"Error stream",
"Stack trace"
],
"related":[
"function-systemoutput"
],
"categories":[
"server",
"debugging"
]
}
-->

# Function SystemOutput

This document explains the systemoutput function with some simple examples.
This document explains the systemOutput function with some simple examples.

It's like dump() for your console, including support for complex types.

For example, if you are using Docker, you can see this output in the console logs.

## Example 1:

Expand Down
3 changes: 3 additions & 0 deletions docs/recipes/http-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
"Lucee",
"log level",
"http log"
],
"related": [
"tag-http"
]
}
-->
Expand Down
8 changes: 8 additions & 0 deletions docs/recipes/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
"java classes",
"custom tags",
"taglib"
],
"categories": [
"java"
],
"related":[
"function-createobject",
"tag-import",
"developing-with-lucee-server"
]
}
-->
Expand Down
17 changes: 14 additions & 3 deletions docs/recipes/inline-components.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
{
"title": "Inline Component",
"title": "Inline Components (CFCs)",
"id": "inline-component",
"since": "6.0",
"description": "Learn how to create and use inline components in Lucee. This guide demonstrates how to define components directly within your CFML code, making it easier to create and use components without needing a separate .cfc file. Examples include creating an inline component and using it similarly to closures.",
Expand All @@ -9,13 +9,24 @@
"component",
"inline-component",
"Lucee"
],
"categories": [
"component"
],
"related":[
"sub-component",
"tag-component",
]
}
-->

# Inline Component
# Inline Components

Since Lucee 6.0, Lucee allows you to create inline components. These are components you can create directly in your CFML code, with no need to create a .cfc file for it. This feature allows you to directly use them, similar to closures.
Since Lucee 6.0, Lucee allows you to create inline components.

These are components you can create directly in your CFML code, with no need to create a `.cfc` file for it.

This feature allows you to directly use them, similar to closures, enabling more dynamic programming approaches.

This example shows how to create an inline component and then use it:

Expand Down
4 changes: 4 additions & 0 deletions docs/recipes/java-explicit-casting.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
"cast",
"convert",
"method"
],
"related": [
"function-javacast",
"tag-component"
]
}
-->
Expand Down
5 changes: 4 additions & 1 deletion docs/recipes/java-in-functions-and-closures.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@
"components",
"lambda",
"Lucee"
]
],
"categories": [
"java"
],
}
-->

Expand Down
5 changes: 4 additions & 1 deletion docs/recipes/java-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@
"Lucee",
"libraries",
"new operator"
]
],
"categories": [
"java"
],
}
-->

Expand Down
5 changes: 4 additions & 1 deletion docs/recipes/java-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
"Application.cfc",
"javasettings",
"cfapplication"
]
],
"categories": [
"java"
],
}
-->

Expand Down
3 changes: 3 additions & 0 deletions docs/recipes/lazy-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
"Performance",
"Memory Optimization",
"Lucee"
],
"related": [
"tag-query"
]
}
-->
Expand Down
3 changes: 3 additions & 0 deletions docs/recipes/loop-through-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
"fileReadBinary",
"Memory optimization",
"Lucee"
],
"related": [
"tag-loop"
]
}
-->
Expand Down
4 changes: 4 additions & 0 deletions docs/recipes/mail-how-to-send-a-mail.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
"Mail server",
"Mail script",
"Lucee"
],
"categories": [
"protocols",
"core"
]
}
-->
Expand Down
6 changes: 6 additions & 0 deletions docs/recipes/mail-listener.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@
"listener",
"Application.cfc",
"component"
],
"related": [
"tag-mail",
],
"categories": [
"protocols"
]
}
-->
Expand Down
23 changes: 21 additions & 2 deletions docs/recipes/maven.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@

<!--
{
"title": "Maven",
"title": "Using Maven directly via CFML",
"id": "maven",
"categories": [],
"categories": [
"java"
],
"description": "How to use Maven in Lucee",
"keywords": [
"Maven",
"Java",
"OSGi"
],
"related":[
"function-createobject",
"tag-import"
]
}
-->
Expand Down Expand Up @@ -57,6 +63,19 @@ In `.CFConfig.json`, you can define Maven dependencies that will be used globall

The `version` attribute is optional. If not specified, Lucee will automatically fetch the latest version available for the specified Maven artifact.

In addition, we also support the more concise Gradle style format.

```json
{
"javasettings": {
"maven": [
"org.graalvm.polyglot:polyglot:24.1.1"
, "org.graalvm.polyglot:python:24.1.1"
]
}
}
```

## Application.cfc

In your `Application.cfc`, you can override or extend the global Java settings by adding Maven dependencies specific to your application.
Expand Down
5 changes: 5 additions & 0 deletions docs/recipes/monitoring-debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@
"debug",
"showdebugoutput",
"cfapplication"
],
"categories": [
"monitoring",
"debugging",
"server"
]
}
-->
Expand Down
3 changes: 2 additions & 1 deletion docs/recipes/monitoring-enable-for-your-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"id": "monitoring-enable-for-your-session",
"since": "6.1",
"categories": [
"monitoring"
"monitoring",
"debugging"
],
"description": "Shows you a way to enable Monitoring for your session",
"keywords": [
Expand Down
Loading

0 comments on commit 4e18c28

Please sign in to comment.