Repository: incubator-tamaya Updated Branches: refs/heads/master f46e2f194 -> ab1ac6bf3
TAMAYA-10 Started to enable Asciidoctor's diagramm support for us. Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/ab1ac6bf Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/ab1ac6bf Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/ab1ac6bf Branch: refs/heads/master Commit: ab1ac6bf3dacd80732f7b45afdc890739431ade5 Parents: f46e2f1 Author: Oliver B. Fischer <ple...@apache.org> Authored: Thu Dec 11 16:55:26 2014 +0100 Committer: Oliver B. Fischer <ple...@apache.org> Committed: Thu Dec 11 16:55:26 2014 +0100 ---------------------------------------------------------------------- docs/pom.xml | 17 +++++++ docs/src/main/asciidoc/example/example.adoc | 63 ++++++++++++++++++++++++ pom.xml | 9 ++++ 3 files changed, 89 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/ab1ac6bf/docs/pom.xml ---------------------------------------------------------------------- diff --git a/docs/pom.xml b/docs/pom.xml index 6233b4f..b4f80b8 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -66,6 +66,23 @@ under the License. <sourceDocumentName>Design.adoc</sourceDocumentName> </configuration> </execution> + <execution> + <id>output-example-doc</id> + <phase>generate-resources</phase> + <goals> + <goal>process-asciidoc</goal> + </goals> + <configuration> + <baseDir>${project.basedir}/src/main/asciidoc/example/</baseDir> + <outputDirectory>target/example</outputDirectory> + <sourceHighlighter>coderay</sourceHighlighter> + <backend>html</backend> + <embedAssets>true</embedAssets> + <sourceDirectory>${project.basedir}/src/main/asciidoc/example/</sourceDirectory> + <sourceDocumentName>example.adoc</sourceDocumentName> + </configuration> + </execution> + </executions> </plugin> </plugins> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/ab1ac6bf/docs/src/main/asciidoc/example/example.adoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/example/example.adoc b/docs/src/main/asciidoc/example/example.adoc new file mode 100644 index 0000000..fde0f98 --- /dev/null +++ b/docs/src/main/asciidoc/example/example.adoc @@ -0,0 +1,63 @@ += Tamayas Asciidoctor Example Document +Oliver B. Fischer + +:encoding: UTF-8 +:source-highlighter: coderay + +This document is used to see if the current setup +of Asciidoctor within the Tamaya project is working +correctly. Therefore it contains some sections +with different examples of Asciidoctors capabilities. + +== Asciidoctor Environment + +Some facts on the current Asciidoctor environment. + +Asciidoctor verision:: {asciidoctor-version} + + +== Plant UML + +This chapter contains a +http://plantuml.sourceforge.net/[Plant UML] diagram. + + +[plantuml, diagram-classes, png] +.... +class BlockProcessor +class DiagramBlock +class DitaaBlock +class PlantUmlBlock + +BlockProcessor <|-- DiagramBlock +DiagramBlock <|-- DitaaBlock +DiagramBlock <|-- PlantUmlBlock +.... + + +== Ditaa + +This section contains a diagram from +http://asciidoctor.org/docs/asciidoctor-diagram/[Asciidoctor Diagram website] +generated with http://ditaa.sourceforge.net/[ditaa]. + +[ditaa, "asciidoctor-diagram-process"] +.... + +-------------+ + | Asciidoctor |-------+ + | diagram | | + +-------------+ | PNG out + ^ | + | ditaa in | + | v + +--------+ +--------+----+ /---------------\ + | |---+ Asciidoctor +--->| | + | Text | +-------------+ | Beautiful | + |Document| | !magic! | | Output | + | {d}| | | | | + +---+----+ +-------------+ \---------------/ + : ^ + | Lots of work | + +-----------------------------------+ +.... + http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/ab1ac6bf/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 0df8d49..451f284 100644 --- a/pom.xml +++ b/pom.xml @@ -54,6 +54,7 @@ under the License. <!-- Dependency and plugin relate version properties go here --> <asciidoctor.version>1.5.0</asciidoctor.version> + <asciidoctorj.version>1.5.2</asciidoctorj.version> <enforcer.version>1.3.1</enforcer.version> <hamcrest.version>1.3</hamcrest.version> <javadoc.version>2.9.1</javadoc.version> @@ -173,6 +174,14 @@ under the License. <groupId>org.asciidoctor</groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <version>${asciidoctor.version}</version> + <dependencies> + <dependency> + <!-- See TAMAYA-10 for details on this dependency --> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctorj</artifactId> + <version>${asciidoctorj.version}</version> + </dependency> + </dependencies> </plugin> <plugin> <groupId>org.jacoco</groupId>