You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by mg...@apache.org on 2016/03/25 15:11:02 UTC

[26/50] isis git commit: ISIS-1335: updating documentation pom.xml to also generate PDFs.

ISIS-1335: updating documentation pom.xml to also generate PDFs.


Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/5526e014
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/5526e014
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/5526e014

Branch: refs/heads/ISIS-1223-upgrade-to-wicket-7
Commit: 5526e0143636803cf905bf6e6c34a2cf9a708741
Parents: e62eacf
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Mon Mar 21 08:50:03 2016 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Mon Mar 21 08:50:03 2016 +0000

----------------------------------------------------------------------
 adocs/documentation/Gemfile.lock |   3 -
 adocs/documentation/pom.xml      | 130 +++++++++++++++++++++-------------
 2 files changed, 82 insertions(+), 51 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/isis/blob/5526e014/adocs/documentation/Gemfile.lock
----------------------------------------------------------------------
diff --git a/adocs/documentation/Gemfile.lock b/adocs/documentation/Gemfile.lock
index 9b483db..0d4f467 100644
--- a/adocs/documentation/Gemfile.lock
+++ b/adocs/documentation/Gemfile.lock
@@ -45,6 +45,3 @@ DEPENDENCIES
   tilt
   wdm (>= 0.1.0)
   webrick
-
-BUNDLED WITH
-   1.10.6

http://git-wip-us.apache.org/repos/asf/isis/blob/5526e014/adocs/documentation/pom.xml
----------------------------------------------------------------------
diff --git a/adocs/documentation/pom.xml b/adocs/documentation/pom.xml
index 5982ca8..6c19d1b 100644
--- a/adocs/documentation/pom.xml
+++ b/adocs/documentation/pom.xml
@@ -43,11 +43,12 @@
     <url>http://isis.apache.org</url>
 
     <properties>
-        <asciidoctor.version>1.5.2</asciidoctor.version>
-        <jruby.version>1.7.17</jruby.version>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <asciidoctor.maven.plugin.version>1.5.3</asciidoctor.maven.plugin.version>
+        <asciidoctorj.pdf.version>1.5.0-alpha.11</asciidoctorj.pdf.version>
+        <asciidoctorj.version>1.5.4</asciidoctorj.version>
+        <jruby.version>1.7.21</jruby.version>
 
-        <version.isis.latest.stable>1.8.0</version.isis.latest.stable>
-        <version.isis.latest.snapshot>1.9.0-SNAPSHOT</version.isis.latest.snapshot>
         <svn.scmPubCheckoutDirectory>${project.build.directory}/co-site</svn.scmPubCheckoutDirectory>
 
         <build.dir>${project.basedir}/target/site</build.dir>
@@ -86,7 +87,7 @@
                     <version>1.0.5</version>
                     <configuration>
                         <!-- align JRuby version with AsciidoctorJ to avoid redundant downloading -->
-                        <jrubyVersion>1.7.9</jrubyVersion>
+                        <jrubyVersion>${jruby.version}</jrubyVersion>
                         <gemHome>${project.build.directory}/gems</gemHome>
                         <gemPath>${project.build.directory}/gems</gemPath>
                     </configuration>
@@ -98,44 +99,6 @@
                         </execution>
                     </executions>
                 </plugin>
-
-                <!-- Configure ASCIIDOC plugin -->
-                <plugin>
-                    <groupId>org.asciidoctor</groupId>
-                    <artifactId>asciidoctor-maven-plugin</artifactId>
-                    <version>${asciidoctor.version}</version>
-                    <configuration>
-                        <sourceDirectory>src/main/asciidoc</sourceDirectory>
-                        <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
-
-                        <!-- The gem-maven-plugin appends the scope (e.g., provided) to the gemPath defined in the plugin configuration -->
-                        <gemPath>${project.build.directory}/gems-provided</gemPath>
-                        <!--
-                                    <requires>
-                                        <require>asciidoctor-diagram</require>
-                                    </requires>
-                        -->
-
-                        <sourceHighlighter>coderay</sourceHighlighter>
-                        <backend>html5</backend>
-                        <templateDir>../template</templateDir>
-                        <eruby>erb</eruby>
-                        <preserveDirectories>true</preserveDirectories>
-                        <relativeBaseDir>true</relativeBaseDir>
-                        <attributes>
-                            <!--
-                            in essence unsets the imagesdir attribute (the mojo hardcodes it to "images").
-                            Has unfortunate side-effect of preventing docs from overriding with own value
-                            (but any other value seems to be incompatible with github's built-in rendering anyway)
-                            -->
-                            <imagesdir/>
-                            <toc>right</toc>
-                            <icons>font</icons>
-                            <latestStable>${version.isis.latest.stable}</latestStable>
-                            <latestSnapshot>${version.isis.latest.snapshot}</latestSnapshot>
-                        </attributes>
-                    </configuration>
-                </plugin>
             </plugins>
         </pluginManagement>
 
@@ -143,6 +106,40 @@
             <plugin>
                 <groupId>org.asciidoctor</groupId>
                 <artifactId>asciidoctor-maven-plugin</artifactId>
+                <version>${asciidoctor.maven.plugin.version}</version>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.asciidoctor</groupId>
+                        <artifactId>asciidoctorj-pdf</artifactId>
+                        <version>${asciidoctorj.pdf.version}</version>
+                    </dependency>
+                    <!-- Comment this section to use the default jruby artifact provided by the plugin -->
+                    <dependency>
+                        <groupId>org.jruby</groupId>
+                        <artifactId>jruby-complete</artifactId>
+                        <version>${jruby.version}</version>
+                    </dependency>
+                    <!-- Comment this section to use the default AsciidoctorJ artifact provided by the plugin -->
+                    <dependency>
+                        <groupId>org.asciidoctor</groupId>
+                        <artifactId>asciidoctorj</artifactId>
+                        <version>${asciidoctorj.version}</version>
+                    </dependency>
+                </dependencies>
+                <configuration>
+                    <sourceDirectory>src/main/asciidoc</sourceDirectory>
+                    <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+                    <!-- Attributes common to all output formats -->
+                    <attributes>
+                        <sourcedir>${project.build.sourceDirectory}</sourcedir>
+                        <!--
+                        in essence unsets the imagesdir attribute (the mojo hardcodes it to "images").
+                        Has unfortunate side-effect of preventing docs from overriding with own value
+                        (but any other value seems to be incompatible with github's built-in rendering anyway)
+                        -->
+                        <imagesdir/>
+                    </attributes>
+                </configuration>
                 <executions>
                     <execution>
                         <id>output-html</id>
@@ -150,14 +147,51 @@
                         <goals>
                             <goal>process-asciidoc</goal>
                         </goals>
+                        <configuration>
+                            <!-- The gem-maven-plugin appends the scope (e.g., provided) to the gemPath defined in the plugin configuration -->
+                            <gemPath>${project.build.directory}/gems-provided</gemPath>
+                            <!--
+                                        <requires>
+                                            <require>asciidoctor-diagram</require>
+                                        </requires>
+                            -->
+
+                            <sourceHighlighter>coderay</sourceHighlighter>
+                            <backend>html5</backend>
+                            <templateDir>../template</templateDir>
+                            <eruby>erb</eruby>
+                            <preserveDirectories>true</preserveDirectories>
+                            <relativeBaseDir>true</relativeBaseDir>
+                            <attributes>
+                                <toc>right</toc>
+                                <icons>font</icons>
+                            </attributes>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>generate-pdf-doc</id>
+                        <phase>generate-resources</phase>
+                        <goals>
+                            <goal>process-asciidoc</goal>
+                        </goals>
+                        <configuration>
+                            <backend>pdf</backend>
+                            <!-- Since 1.5.0-alpha.9 PDF back-end can use 'rouge' as well as 'coderay'
+                            source highlighting -->
+                            <sourceHighlighter>rouge</sourceHighlighter>
+                            <preserveDirectories>true</preserveDirectories>
+                            <relativeBaseDir>true</relativeBaseDir>
+                            <attributes>
+                                <icons>font</icons>
+                                <pagenums/>
+                                <toc/>
+                                <idprefix/>
+                                <idseparator>-</idseparator>
+                            </attributes>
+                        </configuration>
                     </execution>
                 </executions>
-                <configuration>
-                    <attributes>
-                    </attributes>
-                </configuration>
             </plugin>
-
             <plugin>
                 <artifactId>maven-antrun-plugin</artifactId>
                 <version>1.8</version>