You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by dj...@apache.org on 2020/03/13 01:14:20 UTC
[camel] 12/18: fix fixable language xrefs in component. Generated
broken xrefs remain in index.adoc
This is an automated email from the ASF dual-hosted git repository.
djencks pushed a commit to branch issue-14698-rearrange-adocs
in repository https://gitbox.apache.org/repos/asf/camel.git
commit f8aec1625becc10c73649a50e9e50323e6997277
Author: David Jencks <dj...@apache.org>
AuthorDate: Thu Mar 12 13:21:34 2020 -0700
fix fixable language xrefs in component. Generated broken xrefs remain in index.adoc
---
.../src/main/docs/controlbus-component.adoc | 4 ++--
.../camel-elsql/src/main/docs/elsql-component.adoc | 2 +-
.../camel-file/src/main/docs/file-component.adoc | 24 +++++++++++-----------
.../camel-jetty/src/main/docs/jetty-component.adoc | 2 +-
.../src/main/docs/language-component.adoc | 2 +-
.../camel-xpath/src/main/docs/xpath-language.adoc | 2 +-
.../modules/ROOT/pages/controlbus-component.adoc | 4 ++--
.../modules/ROOT/pages/elsql-component.adoc | 2 +-
.../modules/ROOT/pages/file-component.adoc | 24 +++++++++++-----------
.../modules/ROOT/pages/jetty-component.adoc | 2 +-
.../modules/ROOT/pages/language-component.adoc | 2 +-
.../modules/ROOT/pages/xpath-language.adoc | 2 +-
12 files changed, 36 insertions(+), 36 deletions(-)
diff --git a/components/camel-controlbus/src/main/docs/controlbus-component.adoc b/components/camel-controlbus/src/main/docs/controlbus-component.adoc
index 382cd41..4ebc599 100644
--- a/components/camel-controlbus/src/main/docs/controlbus-component.adoc
+++ b/components/camel-controlbus/src/main/docs/controlbus-component.adoc
@@ -161,7 +161,7 @@ String xml = template.requestBody("controlbus:route?action=stats", null, String.
== Using Simple language
-You can use the xref:manual::simple-language.adoc[Simple] language with the control bus,
+You can use the xref:manual:languages:simple-language.adoc[Simple] language with the control bus,
for example to stop a specific route, you can send a message to the
`"controlbus:language:simple"` endpoint containing the following
message:
@@ -182,7 +182,7 @@ String status = template.requestBody("controlbus:language:simple", "${camelConte
It's easier to use the `route` command to control lifecycle of
routes. The `language` command allows you to execute a language script
that has stronger powers such as xref:groovy-language.adoc[Groovy] or to some
-extend the xref:manual::simple-language.adoc[Simple] language.
+extend the xref:manual:languages:simple-language.adoc[Simple] language.
For example to shutdown Camel itself you can do:
diff --git a/components/camel-elsql/src/main/docs/elsql-component.adoc b/components/camel-elsql/src/main/docs/elsql-component.adoc
index 550057d..59c018c 100644
--- a/components/camel-elsql/src/main/docs/elsql-component.adoc
+++ b/components/camel-elsql/src/main/docs/elsql-component.adoc
@@ -44,7 +44,7 @@ The parameters to the SQL queries are named parameters in the elsql
mapping files, and maps to corresponding keys from the Camel message, in
the given precedence:
-1. from message body if xref:manual::simple-language.adoc[Simple]
+1. from message body if xref:manual:languages:simple-language.adoc[Simple]
expression.
2. from message body if its a `java.util.Map`
diff --git a/components/camel-file/src/main/docs/file-component.adoc b/components/camel-file/src/main/docs/file-component.adoc
index 926a244..a49fd00 100644
--- a/components/camel-file/src/main/docs/file-component.adoc
+++ b/components/camel-file/src/main/docs/file-component.adoc
@@ -220,7 +220,7 @@ bean completes, and thus the route is completed, the file consumer will
perform the move operation and move the file to the `.done` sub-folder.
The *move* and the *preMove* options are considered as a directory name
-(though if you use an expression such as xref:manual::file-language.adoc[File Language], or xref:manual::simple-language.adoc[Simple] then the result of the expression
+(though if you use an expression such as xref:manual:languages:file-language.adoc[File Language], or xref:manual:languages:simple-language.adoc[Simple] then the result of the expression
evaluation is the file name to be used - eg if you set
[source]
@@ -228,7 +228,7 @@ evaluation is the file name to be used - eg if you set
move=../backup/copy-of-${file:name}
----
-then that's using the xref:manual::file-language.adoc[File Language] which we
+then that's using the xref:manual:languages:file-language.adoc[File Language] which we
use return the file name to be used), which can be either relative or
absolute. If relative, the directory is created as a sub-folder from
within the folder where the file was consumed.
@@ -266,10 +266,10 @@ processed and after it's processed, it's moved to the `.done` folder.
The *move* and *preMove* options
are Expression-based, so we have the full power of
-the xref:manual::file-language.adoc[File Language] to do advanced configuration
+the xref:manual:languages:file-language.adoc[File Language] to do advanced configuration
of the directory and name pattern. +
Camel will, in fact, internally convert the directory name you enter
-into a xref:manual::file-language.adoc[File Language] expression. So when we
+into a xref:manual:languages:file-language.adoc[File Language] expression. So when we
enter `move=.done` Camel will convert this into:
`\${file:parent}/.done/${file:onlyname}`. This is only done if
Camel detects that you have not provided a $\{ } in the option value
@@ -292,7 +292,7 @@ choice. For example to move the files in an error folder with a
timestamp you can use
`moveFailed=/error/${``file:name.noext``}-${date:now:yyyyMMddHHmmssSSS}.${``file:ext`}.
-See more examples at xref:manual::file-language.adoc[File Language]
+See more examples at xref:manual:languages:file-language.adoc[File Language]
== Message Headers
@@ -306,7 +306,7 @@ The following headers are supported by this component:
|`CamelFileName` |Specifies the name of the file to write (relative to the endpoint
directory). This name can be a `String`; a `String` with a
-xref:manual::file-language.adoc[File Language] or xref:manual::simple-language.adoc[Simple]
+xref:manual:languages:file-language.adoc[File Language] or xref:manual:languages:simple-language.adoc[Simple]
expression; or an Expression object. If it's
`null` then Camel will auto-generate a filename based on the message
unique ID.
@@ -513,8 +513,8 @@ from("direct:report").to("file:target/reports/?fileName=report.txt");
== Filename Expression
Filename can be set either using the *expression* option or as a
-string-based xref:manual::file-language.adoc[File Language] expression in the
-`CamelFileName` header. See the xref:manual::file-language.adoc[File Language]
+string-based xref:manual:languages:file-language.adoc[File Language] expression in the
+`CamelFileName` header. See the xref:manual:languages:file-language.adoc[File Language]
for syntax and samples.
[[File2-Consumingfilesfromfolderswhereothersdropfilesdirectly]]
@@ -797,7 +797,7 @@ today's date as a sub-folder name:
from("file://inbox?move=backup/${date:now:yyyyMMdd}/${file:name}").to("...");
----
-See xref:manual::file-language.adoc[File Language] for more samples.
+See xref:manual:languages:file-language.adoc[File Language] for more samples.
== Avoiding reading the same file more than once (idempotent consumer)
@@ -998,7 +998,7 @@ Registry for a bean with the ID, `mySorter`.
=== Sorting using sortBy
Camel supports pluggable sorting strategies. This strategy it to use the
-xref:manual::file-language.adoc[File Language] to configure the sorting. The
+xref:manual:languages:file-language.adoc[File Language] to configure the sorting. The
`sortBy` option is configured as follows:
[source]
@@ -1022,7 +1022,7 @@ This will sort by file name, you can reverse the order by prefixing
sortBy=reverse:file:name
----
-As we have the full power of xref:manual::file-language.adoc[File Language] we
+As we have the full power of xref:manual:languages:file-language.adoc[File Language] we
can use some of the other parameters, so if we want to sort by file size
we do:
@@ -1066,7 +1066,7 @@ sortBy=file:modified;file:name
Now there is an issue here, can you spot it? Well the modified timestamp
of the file is too fine as it will be in milliseconds, but what if we
want to sort by date only and then subgroup by name? +
- Well as we have the true power of xref:manual::file-language.adoc[File Language] we can use its date command that supports patterns. So this
+ Well as we have the true power of xref:manual:languages:file-language.adoc[File Language] we can use its date command that supports patterns. So this
can be solved as:
[source]
diff --git a/components/camel-jetty/src/main/docs/jetty-component.adoc b/components/camel-jetty/src/main/docs/jetty-component.adoc
index 51ab58c..63e30cb 100644
--- a/components/camel-jetty/src/main/docs/jetty-component.adoc
+++ b/components/camel-jetty/src/main/docs/jetty-component.adoc
@@ -225,7 +225,7 @@ Jetty component will copy the HTTP request parameter, `one` to the
exchange's `in.header`. We can then use the `simple` language to route
exchanges that contain this header to a specific endpoint and all others
to another. If we used a language more powerful than
-xref:manual::simple-language.adoc[Simple] (such as xref:ognl-language.adoc[OGNL])
+xref:manual:languages:simple-language.adoc[Simple] (such as xref:ognl-language.adoc[OGNL])
we could also test for the parameter value and do routing based on the
header value as well.
diff --git a/components/camel-language/src/main/docs/language-component.adoc b/components/camel-language/src/main/docs/language-component.adoc
index a3b75cc..1bce7ce 100644
--- a/components/camel-language/src/main/docs/language-component.adoc
+++ b/components/camel-language/src/main/docs/language-component.adoc
@@ -108,7 +108,7 @@ script configured on the endpoint.
== Examples
-For example you can use the xref:manual::simple-language.adoc[Simple] language to
+For example you can use the xref:manual:languages:simple-language.adoc[Simple] language to
Message Translator a message:
In case you want to convert the message body type you can do this as
diff --git a/components/camel-xpath/src/main/docs/xpath-language.adoc b/components/camel-xpath/src/main/docs/xpath-language.adoc
index 7e44fbd..0730b0c 100644
--- a/components/camel-xpath/src/main/docs/xpath-language.adoc
+++ b/components/camel-xpath/src/main/docs/xpath-language.adoc
@@ -128,7 +128,7 @@ exchange:
|function:properties |key for property |String |To lookup a property using the
xref:properties-component.adoc[Properties] component (property placeholders).
-|function:simple |simple expression |Object |To evaluate a xref:manual::simple-language.adoc[Simple] expression.
+|function:simple |simple expression |Object |To evaluate a xref:manual:languages:simple-language.adoc[Simple] expression.
|===
CAUTION: `function:properties` and `function:simple` is not supported
diff --git a/docs/components/modules/ROOT/pages/controlbus-component.adoc b/docs/components/modules/ROOT/pages/controlbus-component.adoc
index d951d23..5f09e59 100644
--- a/docs/components/modules/ROOT/pages/controlbus-component.adoc
+++ b/docs/components/modules/ROOT/pages/controlbus-component.adoc
@@ -162,7 +162,7 @@ String xml = template.requestBody("controlbus:route?action=stats", null, String.
== Using Simple language
-You can use the xref:manual::simple-language.adoc[Simple] language with the control bus,
+You can use the xref:manual:languages:simple-language.adoc[Simple] language with the control bus,
for example to stop a specific route, you can send a message to the
`"controlbus:language:simple"` endpoint containing the following
message:
@@ -183,7 +183,7 @@ String status = template.requestBody("controlbus:language:simple", "${camelConte
It's easier to use the `route` command to control lifecycle of
routes. The `language` command allows you to execute a language script
that has stronger powers such as xref:groovy-language.adoc[Groovy] or to some
-extend the xref:manual::simple-language.adoc[Simple] language.
+extend the xref:manual:languages:simple-language.adoc[Simple] language.
For example to shutdown Camel itself you can do:
diff --git a/docs/components/modules/ROOT/pages/elsql-component.adoc b/docs/components/modules/ROOT/pages/elsql-component.adoc
index 9248949..c842c36 100644
--- a/docs/components/modules/ROOT/pages/elsql-component.adoc
+++ b/docs/components/modules/ROOT/pages/elsql-component.adoc
@@ -45,7 +45,7 @@ The parameters to the SQL queries are named parameters in the elsql
mapping files, and maps to corresponding keys from the Camel message, in
the given precedence:
-1. from message body if xref:manual::simple-language.adoc[Simple]
+1. from message body if xref:manual:languages:simple-language.adoc[Simple]
expression.
2. from message body if its a `java.util.Map`
diff --git a/docs/components/modules/ROOT/pages/file-component.adoc b/docs/components/modules/ROOT/pages/file-component.adoc
index b1cab97..2a58d76 100644
--- a/docs/components/modules/ROOT/pages/file-component.adoc
+++ b/docs/components/modules/ROOT/pages/file-component.adoc
@@ -221,7 +221,7 @@ bean completes, and thus the route is completed, the file consumer will
perform the move operation and move the file to the `.done` sub-folder.
The *move* and the *preMove* options are considered as a directory name
-(though if you use an expression such as xref:manual::file-language.adoc[File Language], or xref:manual::simple-language.adoc[Simple] then the result of the expression
+(though if you use an expression such as xref:manual:languages:file-language.adoc[File Language], or xref:manual:languages:simple-language.adoc[Simple] then the result of the expression
evaluation is the file name to be used - eg if you set
[source]
@@ -229,7 +229,7 @@ evaluation is the file name to be used - eg if you set
move=../backup/copy-of-${file:name}
----
-then that's using the xref:manual::file-language.adoc[File Language] which we
+then that's using the xref:manual:languages:file-language.adoc[File Language] which we
use return the file name to be used), which can be either relative or
absolute. If relative, the directory is created as a sub-folder from
within the folder where the file was consumed.
@@ -267,10 +267,10 @@ processed and after it's processed, it's moved to the `.done` folder.
The *move* and *preMove* options
are Expression-based, so we have the full power of
-the xref:manual::file-language.adoc[File Language] to do advanced configuration
+the xref:manual:languages:file-language.adoc[File Language] to do advanced configuration
of the directory and name pattern. +
Camel will, in fact, internally convert the directory name you enter
-into a xref:manual::file-language.adoc[File Language] expression. So when we
+into a xref:manual:languages:file-language.adoc[File Language] expression. So when we
enter `move=.done` Camel will convert this into:
`\${file:parent}/.done/${file:onlyname}`. This is only done if
Camel detects that you have not provided a $\{ } in the option value
@@ -293,7 +293,7 @@ choice. For example to move the files in an error folder with a
timestamp you can use
`moveFailed=/error/${``file:name.noext``}-${date:now:yyyyMMddHHmmssSSS}.${``file:ext`}.
-See more examples at xref:manual::file-language.adoc[File Language]
+See more examples at xref:manual:languages:file-language.adoc[File Language]
== Message Headers
@@ -307,7 +307,7 @@ The following headers are supported by this component:
|`CamelFileName` |Specifies the name of the file to write (relative to the endpoint
directory). This name can be a `String`; a `String` with a
-xref:manual::file-language.adoc[File Language] or xref:manual::simple-language.adoc[Simple]
+xref:manual:languages:file-language.adoc[File Language] or xref:manual:languages:simple-language.adoc[Simple]
expression; or an Expression object. If it's
`null` then Camel will auto-generate a filename based on the message
unique ID.
@@ -514,8 +514,8 @@ from("direct:report").to("file:target/reports/?fileName=report.txt");
== Filename Expression
Filename can be set either using the *expression* option or as a
-string-based xref:manual::file-language.adoc[File Language] expression in the
-`CamelFileName` header. See the xref:manual::file-language.adoc[File Language]
+string-based xref:manual:languages:file-language.adoc[File Language] expression in the
+`CamelFileName` header. See the xref:manual:languages:file-language.adoc[File Language]
for syntax and samples.
[[File2-Consumingfilesfromfolderswhereothersdropfilesdirectly]]
@@ -798,7 +798,7 @@ today's date as a sub-folder name:
from("file://inbox?move=backup/${date:now:yyyyMMdd}/${file:name}").to("...");
----
-See xref:manual::file-language.adoc[File Language] for more samples.
+See xref:manual:languages:file-language.adoc[File Language] for more samples.
== Avoiding reading the same file more than once (idempotent consumer)
@@ -999,7 +999,7 @@ Registry for a bean with the ID, `mySorter`.
=== Sorting using sortBy
Camel supports pluggable sorting strategies. This strategy it to use the
-xref:manual::file-language.adoc[File Language] to configure the sorting. The
+xref:manual:languages:file-language.adoc[File Language] to configure the sorting. The
`sortBy` option is configured as follows:
[source]
@@ -1023,7 +1023,7 @@ This will sort by file name, you can reverse the order by prefixing
sortBy=reverse:file:name
----
-As we have the full power of xref:manual::file-language.adoc[File Language] we
+As we have the full power of xref:manual:languages:file-language.adoc[File Language] we
can use some of the other parameters, so if we want to sort by file size
we do:
@@ -1067,7 +1067,7 @@ sortBy=file:modified;file:name
Now there is an issue here, can you spot it? Well the modified timestamp
of the file is too fine as it will be in milliseconds, but what if we
want to sort by date only and then subgroup by name? +
- Well as we have the true power of xref:manual::file-language.adoc[File Language] we can use its date command that supports patterns. So this
+ Well as we have the true power of xref:manual:languages:file-language.adoc[File Language] we can use its date command that supports patterns. So this
can be solved as:
[source]
diff --git a/docs/components/modules/ROOT/pages/jetty-component.adoc b/docs/components/modules/ROOT/pages/jetty-component.adoc
index 87f0bb5..e4a6918 100644
--- a/docs/components/modules/ROOT/pages/jetty-component.adoc
+++ b/docs/components/modules/ROOT/pages/jetty-component.adoc
@@ -226,7 +226,7 @@ Jetty component will copy the HTTP request parameter, `one` to the
exchange's `in.header`. We can then use the `simple` language to route
exchanges that contain this header to a specific endpoint and all others
to another. If we used a language more powerful than
-xref:manual::simple-language.adoc[Simple] (such as xref:ognl-language.adoc[OGNL])
+xref:manual:languages:simple-language.adoc[Simple] (such as xref:ognl-language.adoc[OGNL])
we could also test for the parameter value and do routing based on the
header value as well.
diff --git a/docs/components/modules/ROOT/pages/language-component.adoc b/docs/components/modules/ROOT/pages/language-component.adoc
index 476c9f0..92aa1a7 100644
--- a/docs/components/modules/ROOT/pages/language-component.adoc
+++ b/docs/components/modules/ROOT/pages/language-component.adoc
@@ -109,7 +109,7 @@ script configured on the endpoint.
== Examples
-For example you can use the xref:manual::simple-language.adoc[Simple] language to
+For example you can use the xref:manual:languages:simple-language.adoc[Simple] language to
Message Translator a message:
In case you want to convert the message body type you can do this as
diff --git a/docs/components/modules/ROOT/pages/xpath-language.adoc b/docs/components/modules/ROOT/pages/xpath-language.adoc
index 830468c..f5ca7c8 100644
--- a/docs/components/modules/ROOT/pages/xpath-language.adoc
+++ b/docs/components/modules/ROOT/pages/xpath-language.adoc
@@ -129,7 +129,7 @@ exchange:
|function:properties |key for property |String |To lookup a property using the
xref:properties-component.adoc[Properties] component (property placeholders).
-|function:simple |simple expression |Object |To evaluate a xref:manual::simple-language.adoc[Simple] expression.
+|function:simple |simple expression |Object |To evaluate a xref:manual:languages:simple-language.adoc[Simple] expression.
|===
CAUTION: `function:properties` and `function:simple` is not supported