Repository: camel Updated Branches: refs/heads/master e54a51dfa -> 9f22fab86
CAMEL-11786: Documentation tooling - Should generate in more correct ascii doc format (was using deprecated or markdown style). Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/0e575a40 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0e575a40 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0e575a40 Branch: refs/heads/master Commit: 0e575a403ab0aff619b162c13215da3a8398ff61 Parents: e54a51d Author: Claus Ibsen <davscl...@apache.org> Authored: Tue Sep 19 09:59:30 2017 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Sep 19 10:11:57 2017 +0200 ---------------------------------------------------------------------- .../camel/maven/packaging/UpdateReadmeMojo.java | 6 ++-- .../src/main/resources/component-header.mvel | 29 ++++++++++++-------- .../src/main/resources/component-options.mvel | 6 ++-- .../src/main/resources/dataformat-options.mvel | 4 +-- .../src/main/resources/eip-options.mvel | 4 +-- .../src/main/resources/endpoint-options.mvel | 20 ++++++++------ .../src/main/resources/language-options.mvel | 4 +-- .../src/main/resources/readme-components.mvel | 4 +-- .../src/main/resources/readme-dataformats.mvel | 4 +-- .../src/main/resources/readme-eips.mvel | 4 +-- .../src/main/resources/readme-examples.mvel | 4 +-- .../src/main/resources/readme-languages.mvel | 4 +-- .../src/main/resources/readme-others.mvel | 4 +-- 13 files changed, 52 insertions(+), 45 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java index 9d83038..a5fb2ce 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java @@ -400,7 +400,7 @@ public class UpdateReadmeMojo extends AbstractMojo { if (i == 0) { // first line is the title to make the text less noisy we use level 2 - String newLine = "## " + title; + String newLine = "== " + title; newLines.add(newLine); updated = !line.equals(newLine); continue; @@ -408,7 +408,7 @@ public class UpdateReadmeMojo extends AbstractMojo { // use single line headers with # as level instead of the cumbersome adoc weird style if (line.startsWith("^^^") || line.startsWith("~~~") || line.startsWith("+++")) { - String level = line.startsWith("+++") ? "####" : "###"; + String level = line.startsWith("+++") ? "====" : "==="; // transform legacy heading into new style int idx = newLines.size() - 1; @@ -471,7 +471,7 @@ public class UpdateReadmeMojo extends AbstractMojo { newLines.addAll(Arrays.asList(lines)); // check the first four lines - boolean title = lines[0].startsWith("##"); + boolean title = lines[0].startsWith("##") || lines[0].startsWith("=="); boolean empty = lines[1].trim().isEmpty(); boolean availableFrom = lines[2].trim().contains("Available as of") || lines[2].trim().contains("Available in"); boolean empty2 = lines[3].trim().isEmpty(); http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/component-header.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-header.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-header.mvel index 13aa9d3..8fc5891 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-header.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-header.mvel @@ -1,27 +1,32 @@ -# @{title} += @{title} @{description} -### Syntax +== Syntax The syntax: - @{syntax} +---- +@{syntax} +---- @if{alternativeSyntax != ""} An alternative syntax can be used: - @{alternativeSyntax} +---- +@{alternativeSyntax} +---- @end{} -### Maven Dependency +=== Maven Dependency Maven users would need to add dependency: -```xml - <dependency> - <groupId>${groupId}</groupId> - <artifactId>${artifactId}</artifactId> - <version>${version}</version> - </dependency> -``` +[source,xml] +---- +<dependency> + <groupId>${groupId}</groupId> + <artifactId>${artifactId}</artifactId> + <version>${version}</version> +</dependency> +---- http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel index 9c7a82d..b9b3905 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel @@ -6,8 +6,8 @@ The @{title} component supports @{componentOptions.size()} options which are lis @if{!componentOptions.isEmpty()} [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -@foreach{row : componentOptions}| **@{row.getShortName(25)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} -@end{}|======================================================================= +@foreach{row : componentOptions}| *@{row.getShortName(25)}* (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +@end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/dataformat-options.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/dataformat-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/dataformat-options.mvel index 043ef05..d45c731 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/dataformat-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/dataformat-options.mvel @@ -6,8 +6,8 @@ The @{title} dataformat supports @{dataFormatOptions.size()} options which are l @if{!dataFormatOptions.isEmpty()} [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description @foreach{row : dataFormatOptions}| @{row.name} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} -@end{}|======================================================================= +@end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/eip-options.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/eip-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/eip-options.mvel index 59fdd82..654a58e 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/eip-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/eip-options.mvel @@ -2,8 +2,8 @@ The @{title} EIP supports @{eipOptions.size()} options which are listed below: @if{!eipOptions.isEmpty()} [width="100%",cols="3,1m,6",options="header"] -|======================================================================= +|=== | Name | Java Type | Description @foreach{row : eipOptions}| @{row.name} | @{row.shortJavaType} | @{row.description} -@end{}|======================================================================= +@end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index 2223a79..ee86096 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -1,21 +1,23 @@ The @{title} endpoint is configured using URI syntax: - @{syntax} +---- +@{syntax} +---- with the following path and query parameters: -#### Path Parameters (@{endpointPathOptions.size()} parameters): +==== Path Parameters (@{endpointPathOptions.size()} parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -@foreach{row : endpointPathOptions}| **@{row.getShortName(30)}** | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} -@end{}|======================================================================= +@foreach{row : endpointPathOptions}| *@{row.getShortName(30)}* | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +@end{}|=== -#### Query Parameters (@{endpointOptions.size()} parameters): +==== Query Parameters (@{endpointOptions.size()} parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -@foreach{row : endpointOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} -@end{}|======================================================================= +@foreach{row : endpointOptions}| *@{row.getShortName(30)}* (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +@end{}|=== http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/language-options.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/language-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/language-options.mvel index fea290b..8095d4b 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/language-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/language-options.mvel @@ -6,8 +6,8 @@ The @{title} language supports @{languageOptions.size()} options which are liste @if{!languageOptions.isEmpty()} [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description @foreach{row : languageOptions}| @{row.name} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} -@end{}|======================================================================= +@end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-components.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-components.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-components.mvel index ae65cff..fdc08e0 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-components.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-components.mvel @@ -3,12 +3,12 @@ Number of Components: @{components.size} in @{numberOfArtifacts} JAR artifacts (@{numberOfDeprecated} deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Component | Available From | Description @foreach{row : components} | link:@{row.docLink}/${row.scheme}-component.adoc[@{row.title}] (@{row.artifactId}) + `@{row.syntax}` | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} @end{} -|======================================================================= +|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-dataformats.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-dataformats.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-dataformats.mvel index 62ca235..fbe0987 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-dataformats.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-dataformats.mvel @@ -3,10 +3,10 @@ Number of Data Formats: @{dataformats.size} in @{numberOfArtifacts} JAR artifacts (@{numberOfDeprecated} deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Data Format | Available From | Description @foreach{row : dataformats} | link:@{row.docLink}/${row.name}-dataformat.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} -@end{}|======================================================================= +@end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-eips.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-eips.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-eips.mvel index c9bb8f2..1ba3a04 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-eips.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-eips.mvel @@ -3,12 +3,12 @@ Number of EIPs: @{eips.size} (@{numberOfDeprecated} deprecated) [width="100%",cols="4,6",options="header"] -|======================================================================= +|=== | EIP | Description @foreach{row : eips} | link:@{row.docLink}/${row.name}-eip.adoc[@{row.title}] + `<@{row.name}>` | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} @end{} -|======================================================================= +|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-examples.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-examples.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-examples.mvel index a9fcc42..770e519 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-examples.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-examples.mvel @@ -3,10 +3,10 @@ Number of Examples: @{examples.size} (@{numberOfDeprecated} deprecated) [width="100%",cols="4,2,4",options="header"] -|======================================================================= +|=== | Example | Category | Description @foreach{row : examples} | link:@{row.docLink}[@{row.title}] (@{row.fileName}) | @{row.category} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} -@end{}|======================================================================= +@end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-languages.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-languages.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-languages.mvel index a8b308d..3694975 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-languages.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-languages.mvel @@ -3,10 +3,10 @@ Number of Languages: @{languages.size} in @{numberOfArtifacts} JAR artifacts (@{numberOfDeprecated} deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Language | Available From | Description @foreach{row : languages} | link:@{row.docLink}/${row.name}-language.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} -@end{}|======================================================================= +@end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/0e575a40/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-others.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-others.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-others.mvel index 1cf191b..ccb02e1 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-others.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-others.mvel @@ -3,10 +3,10 @@ Number of Miscellaneous Components: @{others.size} in @{numberOfArtifacts} JAR artifacts (@{numberOfDeprecated} deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Component | Available From | Description @foreach{row : others} | link:@{row.docLink}/${row.name}.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} -@end{}|======================================================================= +@end{}|=== @end{} \ No newline at end of file
