You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by gn...@apache.org on 2020/03/03 06:32:22 UTC
[camel] 06/18: Fix docs
This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 2b81e6d0b371f1e9ed6c1aa05a113c7731cbcab5
Author: Guillaume Nodet <gn...@gmail.com>
AuthorDate: Mon Mar 2 17:33:18 2020 +0100
Fix docs
---
.../src/main/docs/properties-component.adoc | 0
.../modules/ROOT/pages/constant-language.adoc | 2 +-
.../modules/ROOT/pages/exchangeProperty-language.adoc | 2 +-
docs/components/modules/ROOT/pages/file-language.adoc | 2 +-
.../components/modules/ROOT/pages/header-language.adoc | 2 +-
docs/components/modules/ROOT/pages/index.adoc | 18 ++++++++----------
docs/components/modules/ROOT/pages/ref-language.adoc | 2 +-
.../components/modules/ROOT/pages/simple-language.adoc | 2 +-
.../modules/ROOT/pages/tokenize-language.adoc | 2 +-
docs/gulpfile.js | 6 +++---
docs/user-manual/modules/ROOT/nav.adoc | 7 -------
.../modules/ROOT/pages/constant-language.adoc | 2 +-
.../modules/ROOT/pages/exchangeProperty-language.adoc | 2 +-
docs/user-manual/modules/ROOT/pages/file-language.adoc | 2 +-
.../modules/ROOT/pages/header-language.adoc | 2 +-
docs/user-manual/modules/ROOT/pages/ref-language.adoc | 2 +-
.../modules/ROOT/pages/simple-language.adoc | 2 +-
.../modules/ROOT/pages/tokenize-language.adoc | 2 +-
.../camel/maven/packaging/PrepareCatalogMojo.java | 10 ++++++++--
19 files changed, 33 insertions(+), 36 deletions(-)
diff --git a/core/camel-core-languages/src/main/docs/properties-component.adoc b/core/camel-base/src/main/docs/properties-component.adoc
similarity index 100%
rename from core/camel-core-languages/src/main/docs/properties-component.adoc
rename to core/camel-base/src/main/docs/properties-component.adoc
diff --git a/docs/components/modules/ROOT/pages/constant-language.adoc b/docs/components/modules/ROOT/pages/constant-language.adoc
index 872be17..a8ef0e0 100644
--- a/docs/components/modules/ROOT/pages/constant-language.adoc
+++ b/docs/components/modules/ROOT/pages/constant-language.adoc
@@ -1,6 +1,6 @@
[[constant-language]]
= Constant Language
-:page-source: core/camel-base/src/main/docs/constant-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/constant-language.adoc
*Since Camel 1.5*
diff --git a/docs/components/modules/ROOT/pages/exchangeProperty-language.adoc b/docs/components/modules/ROOT/pages/exchangeProperty-language.adoc
index f26a26f..c6c0a60 100644
--- a/docs/components/modules/ROOT/pages/exchangeProperty-language.adoc
+++ b/docs/components/modules/ROOT/pages/exchangeProperty-language.adoc
@@ -1,6 +1,6 @@
[[exchangeProperty-language]]
= ExchangeProperty Language
-:page-source: core/camel-base/src/main/docs/exchangeProperty-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/exchangeProperty-language.adoc
*Since Camel 2.0*
diff --git a/docs/components/modules/ROOT/pages/file-language.adoc b/docs/components/modules/ROOT/pages/file-language.adoc
index a0ae9b0..88bfa2c 100644
--- a/docs/components/modules/ROOT/pages/file-language.adoc
+++ b/docs/components/modules/ROOT/pages/file-language.adoc
@@ -1,6 +1,6 @@
[[file-language]]
= File Language
-:page-source: core/camel-base/src/main/docs/file-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/file-language.adoc
*Since Camel 1.1*
diff --git a/docs/components/modules/ROOT/pages/header-language.adoc b/docs/components/modules/ROOT/pages/header-language.adoc
index e80167b..c2134f4 100644
--- a/docs/components/modules/ROOT/pages/header-language.adoc
+++ b/docs/components/modules/ROOT/pages/header-language.adoc
@@ -1,6 +1,6 @@
[[header-language]]
= Header Language
-:page-source: core/camel-base/src/main/docs/header-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/header-language.adoc
*Since Camel 1.5*
diff --git a/docs/components/modules/ROOT/pages/index.adoc b/docs/components/modules/ROOT/pages/index.adoc
index a199191..d9baa1c 100644
--- a/docs/components/modules/ROOT/pages/index.adoc
+++ b/docs/components/modules/ROOT/pages/index.adoc
@@ -781,7 +781,7 @@ Number of Data Formats: 45 in 37 JAR artifacts (0 deprecated)
== Expression Languages
// languages: START
-Number of Languages: 17 in 11 JAR artifacts (0 deprecated)
+Number of Languages: 16 in 10 JAR artifacts (0 deprecated)
[width="100%",cols="4,1,5",options="header"]
|===
@@ -789,15 +789,15 @@ Number of Languages: 17 in 11 JAR artifacts (0 deprecated)
| xref:bean-language.adoc[Bean method] (camel-bean) | 1.3 | To use a Java bean (aka method call) in Camel expressions or predicates.
-| xref:constant-language.adoc[Constant] (camel-base) | 1.5 | To use a constant value in Camel expressions or predicates. Important: this is a fixed constant value that is only set once during starting up the route, do not use this if you want dynamic values during routing.
+| xref:constant-language.adoc[Constant] (camel-core-languages) | 1.5 | To use a constant value in Camel expressions or predicates. Important: this is a fixed constant value that is only set once during starting up the route, do not use this if you want dynamic values during routing.
-| xref:exchangeProperty-language.adoc[ExchangeProperty] (camel-base) | 2.0 | To use a Camel Exchange property in expressions or predicates.
+| xref:exchangeProperty-language.adoc[ExchangeProperty] (camel-core-languages) | 2.0 | To use a Camel Exchange property in expressions or predicates.
-| xref:file-language.adoc[File] (camel-base) | 1.1 | For expressions and predicates using the file/simple language.
+| xref:file-language.adoc[File] (camel-core-languages) | 1.1 | For expressions and predicates using the file/simple language.
| xref:groovy-language.adoc[Groovy] (camel-groovy) | 1.3 | To use Groovy scripts in Camel expressions or predicates.
-| xref:header-language.adoc[Header] (camel-base) | 1.5 | To use a Camel Message header in expressions or predicates.
+| xref:header-language.adoc[Header] (camel-core-languages) | 1.5 | To use a Camel Message header in expressions or predicates.
| xref:hl7terser-language.adoc[HL7 Terser] (camel-hl7) | 2.11 | To use HL7 terser scripts in Camel expressions or predicates.
@@ -807,15 +807,13 @@ Number of Languages: 17 in 11 JAR artifacts (0 deprecated)
| xref:ognl-language.adoc[OGNL] (camel-ognl) | 1.1 | To use OGNL scripts in Camel expressions or predicates.
-| xref:ref-language.adoc[Ref] (camel-base) | 2.8 | Reference to an existing Camel expression or predicate, which is looked up from the Camel registry.
+| xref:ref-language.adoc[Ref] (camel-core-languages) | 2.8 | Reference to an existing Camel expression or predicate, which is looked up from the Camel registry.
-| xref:simple-language.adoc[Simple] (camel-base) | 1.1 | To use Camels built-in Simple language in Camel expressions or predicates.
+| xref:simple-language.adoc[Simple] (camel-core-languages) | 1.1 | To use Camels built-in Simple language in Camel expressions or predicates.
| xref:spel-language.adoc[SpEL] (camel-spring) | 2.7 | To use Spring Expression Language (SpEL) in Camel expressions or predicates.
-| xref:tokenize-language.adoc[Tokenize] (camel-base) | 2.0 | To use Camel message body or header with a tokenizer in Camel expressions or predicates.
-
-| xref:xtokenize-language.adoc[XML Tokenize] (camel-xml-jaxp) | 2.14 | To use Camel message body or header with a XML tokenizer in Camel expressions or predicates.
+| xref:tokenize-language.adoc[Tokenize] (camel-core-languages) | 2.0 | To use Camel message body or header with a tokenizer in Camel expressions or predicates.
| xref:xpath-language.adoc[XPath] (camel-xpath) | 1.1 | To use XPath (XML) in Camel expressions or predicates.
diff --git a/docs/components/modules/ROOT/pages/ref-language.adoc b/docs/components/modules/ROOT/pages/ref-language.adoc
index 1423291..0b86da1 100644
--- a/docs/components/modules/ROOT/pages/ref-language.adoc
+++ b/docs/components/modules/ROOT/pages/ref-language.adoc
@@ -1,6 +1,6 @@
[[ref-language]]
= Ref Language
-:page-source: core/camel-base/src/main/docs/ref-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/ref-language.adoc
*Since Camel 2.8*
diff --git a/docs/components/modules/ROOT/pages/simple-language.adoc b/docs/components/modules/ROOT/pages/simple-language.adoc
index ac942b1..c135562 100644
--- a/docs/components/modules/ROOT/pages/simple-language.adoc
+++ b/docs/components/modules/ROOT/pages/simple-language.adoc
@@ -1,6 +1,6 @@
[[simple-language]]
= Simple Language
-:page-source: core/camel-base/src/main/docs/simple-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/simple-language.adoc
*Since Camel 1.1*
diff --git a/docs/components/modules/ROOT/pages/tokenize-language.adoc b/docs/components/modules/ROOT/pages/tokenize-language.adoc
index 250b9cf..bf1f30a 100644
--- a/docs/components/modules/ROOT/pages/tokenize-language.adoc
+++ b/docs/components/modules/ROOT/pages/tokenize-language.adoc
@@ -1,6 +1,6 @@
[[tokenize-language]]
= Tokenize Language
-:page-source: core/camel-base/src/main/docs/tokenize-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/tokenize-language.adoc
*Since Camel 2.0*
diff --git a/docs/gulpfile.js b/docs/gulpfile.js
index 6380dd9..9a99f71 100644
--- a/docs/gulpfile.js
+++ b/docs/gulpfile.js
@@ -35,7 +35,7 @@ function deleteComponentImageSymlinks() {
}
function createComponentSymlinks() {
- return src(['../core/camel-base/src/main/docs/*.adoc', '../core/camel-xml-jaxp/src/main/docs/*.adoc', '../components/{*,*/*}/src/main/docs/*.adoc'])
+ return src(['../core/camel-base/src/main/docs/*.adoc', '../core/camel-core-languages/src/main/docs/*.adoc', '../core/camel-xml-jaxp/src/main/docs/*.adoc', '../components/{*,*/*}/src/main/docs/*.adoc'])
.pipe(map((file, done) => {
// this flattens the output to just .../pages/....adoc
// instead of .../pages/camel-.../src/main/docs/....adoc
@@ -80,7 +80,7 @@ function deleteUserManualSymlinks() {
}
function createUserManualSymlinks() {
- return src(['../core/camel-base/src/main/docs/*.adoc', '../core/camel-xml-jaxp/src/main/docs/*.adoc', '../core/camel-core-engine/src/main/docs/eips/*.adoc'])
+ return src(['../core/camel-base/src/main/docs/*.adoc', '../core/camel-core-languages/src/main/docs/*.adoc', '../core/camel-xml-jaxp/src/main/docs/*.adoc', '../core/camel-core-engine/src/main/docs/eips/*.adoc'])
// Antora disabled symlinks, there is an issue open
// https://gitlab.com/antora/antora/issues/188
// to reinstate symlink support, until that's resolved
@@ -122,7 +122,7 @@ function insertSourceAttribute() {
function createComponentNav() {
return src('component-nav.adoc.template')
.pipe(insertGeneratedNotice())
- .pipe(inject(src(['../core/camel-base/src/main/docs/*-component.adoc', '../components/{*,*/*}/src/main/docs/*.adoc']).pipe(sort()), {
+ .pipe(inject(src(['../core/camel-base/src/main/docs/*-component.adoc', '../core/camel-core-languages/src/main/docs/*-component.adoc', '../components/{*,*/*}/src/main/docs/*.adoc']).pipe(sort()), {
removeTags: true,
transform: (filename, file) => {
const filepath = path.basename(filename);
diff --git a/docs/user-manual/modules/ROOT/nav.adoc b/docs/user-manual/modules/ROOT/nav.adoc
index dbbca5c..174090d 100644
--- a/docs/user-manual/modules/ROOT/nav.adoc
+++ b/docs/user-manual/modules/ROOT/nav.adoc
@@ -52,14 +52,7 @@
** xref:spring.adoc[Spring support]
* xref:using-osgi-blueprint-with-camel.adoc[Using OSGi blueprint with Camel]
* Supported expression languages
- ** xref:constant-language.adoc[Constant Language]
- ** xref:exchangeProperty-language.adoc[ExchangeProperty Language]
- ** xref:file-language.adoc[File Language]
- ** xref:header-language.adoc[Header Language]
** xref:properties-component.adoc[Properties Component]
- ** xref:ref-language.adoc[Ref Language]
- ** xref:simple-language.adoc[Simple Language]
- ** xref:tokenize-language.adoc[Tokenize Language]
* xref:enterprise-integration-patterns.adoc[Enterprise Integration Patterns]
** xref:aggregate-eip.adoc[Aggregate EIP]
** xref:batch-config-eip.adoc[Batch-config EIP]
diff --git a/docs/user-manual/modules/ROOT/pages/constant-language.adoc b/docs/user-manual/modules/ROOT/pages/constant-language.adoc
index 872be17..a8ef0e0 100644
--- a/docs/user-manual/modules/ROOT/pages/constant-language.adoc
+++ b/docs/user-manual/modules/ROOT/pages/constant-language.adoc
@@ -1,6 +1,6 @@
[[constant-language]]
= Constant Language
-:page-source: core/camel-base/src/main/docs/constant-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/constant-language.adoc
*Since Camel 1.5*
diff --git a/docs/user-manual/modules/ROOT/pages/exchangeProperty-language.adoc b/docs/user-manual/modules/ROOT/pages/exchangeProperty-language.adoc
index f26a26f..c6c0a60 100644
--- a/docs/user-manual/modules/ROOT/pages/exchangeProperty-language.adoc
+++ b/docs/user-manual/modules/ROOT/pages/exchangeProperty-language.adoc
@@ -1,6 +1,6 @@
[[exchangeProperty-language]]
= ExchangeProperty Language
-:page-source: core/camel-base/src/main/docs/exchangeProperty-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/exchangeProperty-language.adoc
*Since Camel 2.0*
diff --git a/docs/user-manual/modules/ROOT/pages/file-language.adoc b/docs/user-manual/modules/ROOT/pages/file-language.adoc
index a0ae9b0..88bfa2c 100644
--- a/docs/user-manual/modules/ROOT/pages/file-language.adoc
+++ b/docs/user-manual/modules/ROOT/pages/file-language.adoc
@@ -1,6 +1,6 @@
[[file-language]]
= File Language
-:page-source: core/camel-base/src/main/docs/file-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/file-language.adoc
*Since Camel 1.1*
diff --git a/docs/user-manual/modules/ROOT/pages/header-language.adoc b/docs/user-manual/modules/ROOT/pages/header-language.adoc
index e80167b..c2134f4 100644
--- a/docs/user-manual/modules/ROOT/pages/header-language.adoc
+++ b/docs/user-manual/modules/ROOT/pages/header-language.adoc
@@ -1,6 +1,6 @@
[[header-language]]
= Header Language
-:page-source: core/camel-base/src/main/docs/header-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/header-language.adoc
*Since Camel 1.5*
diff --git a/docs/user-manual/modules/ROOT/pages/ref-language.adoc b/docs/user-manual/modules/ROOT/pages/ref-language.adoc
index 1423291..0b86da1 100644
--- a/docs/user-manual/modules/ROOT/pages/ref-language.adoc
+++ b/docs/user-manual/modules/ROOT/pages/ref-language.adoc
@@ -1,6 +1,6 @@
[[ref-language]]
= Ref Language
-:page-source: core/camel-base/src/main/docs/ref-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/ref-language.adoc
*Since Camel 2.8*
diff --git a/docs/user-manual/modules/ROOT/pages/simple-language.adoc b/docs/user-manual/modules/ROOT/pages/simple-language.adoc
index ac942b1..c135562 100644
--- a/docs/user-manual/modules/ROOT/pages/simple-language.adoc
+++ b/docs/user-manual/modules/ROOT/pages/simple-language.adoc
@@ -1,6 +1,6 @@
[[simple-language]]
= Simple Language
-:page-source: core/camel-base/src/main/docs/simple-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/simple-language.adoc
*Since Camel 1.1*
diff --git a/docs/user-manual/modules/ROOT/pages/tokenize-language.adoc b/docs/user-manual/modules/ROOT/pages/tokenize-language.adoc
index 250b9cf..bf1f30a 100644
--- a/docs/user-manual/modules/ROOT/pages/tokenize-language.adoc
+++ b/docs/user-manual/modules/ROOT/pages/tokenize-language.adoc
@@ -1,6 +1,6 @@
[[tokenize-language]]
= Tokenize Language
-:page-source: core/camel-base/src/main/docs/tokenize-language.adoc
+:page-source: core/camel-core-languages/src/main/docs/tokenize-language.adoc
*Since Camel 2.0*
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
index c9426cc..361e28e 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
+++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
@@ -158,6 +158,12 @@ public class PrepareCatalogMojo extends AbstractMojo {
protected File baseDir;
/**
+ * The camel-core-languages directory
+ */
+ @Parameter(defaultValue = "${project.build.directory}/../../../core/camel-core-languages")
+ protected File languagesDir;
+
+ /**
* The camel-xml-jaxp directory
*/
@Parameter(defaultValue = "${project.build.directory}/../../../core/camel-xml-jaxp")
@@ -217,7 +223,7 @@ public class PrepareCatalogMojo extends AbstractMojo {
allJsonFiles = new TreeSet<>();
allPropertiesFiles = new TreeSet<>();
- Stream.concat(list(componentsDir.toPath()), Stream.of(coreDir.toPath(), baseDir.toPath(), jaxpDir.toPath(), springDir.toPath()))
+ Stream.concat(list(componentsDir.toPath()), Stream.of(coreDir.toPath(), baseDir.toPath(), languagesDir.toPath(), jaxpDir.toPath(), springDir.toPath()))
.filter(dir -> !"target".equals(dir.getFileName().toString())).map(this::getComponentPath).filter(dir -> Files.isDirectory(dir.resolve("src")))
.map(p -> p.resolve("target/classes")).flatMap(PackageHelper::walk).forEach(p -> {
String f = p.getFileName().toString();
@@ -645,7 +651,7 @@ public class PrepareCatalogMojo extends AbstractMojo {
// find all camel maven modules
Stream.concat(list(componentsDir.toPath()).filter(dir -> !"target".equals(dir.getFileName().toString())).map(this::getComponentPath),
- Stream.of(coreDir.toPath(), baseDir.toPath(), jaxpDir.toPath()))
+ Stream.of(coreDir.toPath(), baseDir.toPath(), languagesDir.toPath(), jaxpDir.toPath()))
.forEach(dir -> {
List<Path> l = PackageHelper.walk(dir.resolve("src/main/docs")).filter(f -> f.getFileName().toString().endsWith(".adoc")).collect(Collectors.toList());
if (l.isEmpty()) {