New feature COMMWEB-37: Provide maven plugin for core documentation

Mark Craig

13.59.2012 8c9121b9316a16ae8ed315d1fe23284d6819ece0

 opendj3/pom.xml

@@ -103,515 +103,34 @@
    <currentServerVersion>2.5.0-SNAPSHOT</currentServerVersion>
    <stableServerVersion>2.4.5</stableServerVersion>
    <docTargetVersion>2.5.0</docTargetVersion>
    <docbkx-src>${basedir}/src/main/docbkx</docbkx-src>
    <dbstyle-dir>${basedir}/src/main/docbkx-stylesheets</dbstyle-dir>
    <docbkx-out>${basedir}/target/docbkx</docbkx-out>
    <fonts-src>${basedir}/src/fonts</fonts-src>
    <fonts-gen>${basedir}/target/fonts</fonts-gen>
    <site-out>${basedir}/target/site</site-out>
    <siteDistributionURL>scp://forgerock.org/var/www/vhosts/opendj.forgerock.org/httpdocs</siteDistributionURL>
    <i18nFrameworkVersion>1.4.0</i18nFrameworkVersion>
  </properties>
  <build>
    <plugins>
      <plugin>
        <groupId>com.agilejava.docbkx</groupId>
        <artifactId>docbkx-fop-support</artifactId>
        <version>2.0.14</version>
        <inherited>false</inherited>
        <executions>
          <execution>
            <phase>pre-site</phase>
            <goals>
              <goal>generate</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>com.agilejava.docbkx</groupId>
        <artifactId>docbkx-maven-plugin</artifactId>
        <version>2.0.14</version>
        <groupId>org.forgerock.commons</groupId>
        <artifactId>forgerock-doc-maven-plugin</artifactId>
        <version>0.1.0-SNAPSHOT</version>
        <inherited>false</inherited>
        <configuration>
          <sourceDirectory>${basedir}/src/main/docbkx</sourceDirectory>
          <!-- Comment the draft elements out for final build -->
          <draftMode>yes</draftMode>
          <draftWatermarkImage>http://docbook.sourceforge.net/release/images/draft.png</draftWatermarkImage>

          <highlightSource>1</highlightSource>

          <includes>*/OpenDJ-*.xml</includes>
          <xincludeSupported>true</xincludeSupported>

          <fonts>
           <font>
            <name>DejaVuSans</name>
            <style>normal</style>
            <weight>normal</weight>
            <embedFile>${fonts-src}/DejaVuSans.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSans-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSans</name>
            <style>normal</style>
            <weight>bold</weight>
            <embedFile>${fonts-src}/DejaVuSansCondensed-Bold.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSansCondensed-Bold-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSans</name>
            <style>italic</style>
            <weight>normal</weight>
            <embedFile>${fonts-src}/DejaVuSans-Oblique.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSans-Oblique-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSans</name>
            <style>italic</style>
            <weight>bold</weight>
            <embedFile>${fonts-src}/DejaVuSansCondensed-BoldOblique.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSansCondensed-BoldOblique-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSansMono</name>
            <style>normal</style>
            <weight>normal</weight>
            <embedFile>${fonts-src}/DejaVuSansMono.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSansMono-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSansMono</name>
            <style>normal</style>
            <weight>bold</weight>
            <embedFile>${fonts-src}/DejaVuSansMono-Bold.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSansMono-Bold-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSansMono</name>
            <style>italic</style>
            <weight>normal</weight>
            <embedFile>${fonts-src}/DejaVuSansMono-Oblique.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSansMono-Oblique-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSansMono</name>
            <style>italic</style>
            <weight>bold</weight>
            <embedFile>${fonts-src}/DejaVuSansMono-BoldOblique.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSansMono-BoldOblique-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSerif</name>
            <style>normal</style>
            <weight>normal</weight>
            <embedFile>${fonts-src}/DejaVuSerif.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSerif-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSerif</name>
            <style>normal</style>
            <weight>bold</weight>
            <embedFile>${fonts-src}/DejaVuSerifCondensed-Bold.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSerifCondensed-Bold-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSerif</name>
            <style>italic</style>
            <weight>normal</weight>
            <embedFile>${fonts-src}/DejaVuSerif-Italic.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSerif-Italic-metrics.xml</metricsFile>
           </font>
           <font>
            <name>DejaVuSerif</name>
            <style>italic</style>
            <weight>bold</weight>
            <embedFile>${fonts-src}/DejaVuSerifCondensed-BoldItalic.ttf</embedFile>
            <metricsFile>${fonts-gen}/DejaVuSerifCondensed-BoldItalic-metrics.xml</metricsFile>
           </font>
          </fonts>

          <sectionAutolabel>true</sectionAutolabel>
          <sectionLabelIncludesComponentLabel>true</sectionLabelIncludesComponentLabel>
         <projectName>OpenDJ</projectName>
         <googleAnalyticsId>UA-23412190-8</googleAnalyticsId>
        </configuration>
        <executions>
          <execution>
           <id>olinkdb-admin-guide</id>
           <phase>pre-site</phase>
           <configuration>
            <includes>*/OpenDJ-Admin-Guide.xml</includes>
            <collectXrefTargets>only</collectXrefTargets>
            <targetsFilename>${basedir}/target/admin-guide.target.db</targetsFilename>
            <postProcess>
             <delete dir="${docbkx-out}/html/admin-guide" />
            </postProcess>
           </configuration>
           <goals>
            <goal>generate-html</goal>
           </goals>
          </execution>
          <execution>
           <id>olinkdb-dev-guide</id>
           <phase>pre-site</phase>
           <configuration>
            <includes>*/OpenDJ-Dev-Guide.xml</includes>
            <collectXrefTargets>only</collectXrefTargets>
            <targetsFilename>${basedir}/target/dev-guide.target.db</targetsFilename>
            <postProcess>
             <delete dir="${docbkx-out}/html/dev-guide" />
            </postProcess>
           </configuration>
           <goals>
            <goal>generate-html</goal>
           </goals>
          </execution>
          <execution>
           <id>olinkdb-install-guide</id>
           <phase>pre-site</phase>
           <configuration>
            <includes>*/OpenDJ-Install-Guide.xml</includes>
            <collectXrefTargets>only</collectXrefTargets>
            <targetsFilename>${basedir}/target/install-guide.target.db</targetsFilename>
            <postProcess>
             <delete dir="${docbkx-out}/html/install-guide" />
            </postProcess>
           </configuration>
           <goals>
            <goal>generate-html</goal>
           </goals>
          </execution>
          <execution>
           <id>olinkdb-release-notes</id>
           <phase>pre-site</phase>
           <configuration>
            <includes>*/OpenDJ-Release-Notes.xml</includes>
            <collectXrefTargets>only</collectXrefTargets>
            <targetsFilename>${basedir}/target/release-notes.target.db</targetsFilename>
            <postProcess>
             <delete dir="${docbkx-out}/html/release-notes" />
            </postProcess>
           </configuration>
           <goals>
            <goal>generate-html</goal>
           </goals>
          </execution>
          <execution>
            <id>doc-epub</id>
            <id>build-doc</id>
            <phase>pre-site</phase>
            <goals>
              <goal>generate-epub</goal>
              <goal>build</goal>
            </goals>
            <configuration>
              <epubCustomization>${dbstyle-dir}/epub/coredoc.xsl</epubCustomization>
              <!-- docbkx-tools does not seem to support multiple embedded
                   fonts for epub format, missing exslt. -->
              <epubEmbeddedFonts>DejaVuSans</epubEmbeddedFonts>
              <!-- Resources required but not copied by DocBook.xsl. -->
              <preProcess>
                <copy todir="${docbkx-out}/epub/admin-guide/OpenDJ-Admin-Guide/images">
                  <fileset dir="${docbkx-src}/admin-guide/images" />
                </copy>
                <copy todir="${docbkx-out}/epub/admin-guide/OpenDJ-Admin-Guide">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
                <copy todir="${docbkx-out}/epub/dev-guide/OpenDJ-Dev-Guide/images">
                  <fileset dir="${docbkx-src}/dev-guide/images" />
                </copy>
                <copy todir="${docbkx-out}/epub/dev-guide/OpenDJ-Dev-Guide">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
                <copy todir="${docbkx-out}/epub/install-guide/OpenDJ-Install-Guide/images">
                  <fileset dir="${docbkx-src}/install-guide/images" />
                </copy>
                <copy todir="${docbkx-out}/epub/install-guide/OpenDJ-Install-Guide">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
                <copy todir="${docbkx-out}/epub/release-notes/OpenDJ-Release-Notes/images">
                  <fileset dir="${docbkx-src}/release-notes/images" />
                </copy>
                <copy todir="${docbkx-out}/epub/release-notes/OpenDJ-Release-Notes">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
              </preProcess>
            </configuration>
          </execution>
          <execution>
            <id>doc-fo</id>
            <phase>pre-site</phase>
            <goals>
              <goal>generate-pdf</goal>
              <goal>generate-rtf</goal>
            </goals>
            <configuration>
              <foCustomization>${dbstyle-dir}/fo/coredoc.xsl</foCustomization>
            </configuration>
          </execution>
          <execution>
            <id>doc-manpages</id>
            <phase>pre-site</phase>
            <goals>
              <goal>generate-manpages</goal>
            </goals>
            <configuration>
             <manpagesCustomization>${dbstyle-dir}/man/manpages.xsl</manpagesCustomization>
            </configuration>
          </execution>
          <execution>
            <id>chunked-html</id>
            <phase>pre-site</phase>
            <goals>
              <goal>generate-html</goal>
            </goals>
            <configuration>
              <!-- <targetDatabaseDocument>${basedir}/src/main/docbkx/olinkdb.xml</targetDatabaseDocument> -->
              <chunkedOutput>true</chunkedOutput>
              <htmlCustomization>${dbstyle-dir}/html/chunked.xsl</htmlCustomization>

              <preProcess>
                <copy todir="${docbkx-out}/html/admin-guide/OpenDJ-Admin-Guide/images">
                  <fileset dir="${docbkx-src}/admin-guide/images" />
                </copy>
                <copy todir="${docbkx-out}/html/admin-guide/OpenDJ-Admin-Guide">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
                <copy todir="${docbkx-out}/html/dev-guide/OpenDJ-Dev-Guide/images">
                  <fileset dir="${docbkx-src}/dev-guide/images" />
                </copy>
                <copy todir="${docbkx-out}/html/dev-guide/OpenDJ-Dev-Guide">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
                <copy todir="${docbkx-out}/html/install-guide/OpenDJ-Install-Guide/images">
                  <fileset dir="${docbkx-src}/install-guide/images" />
                </copy>
                <copy todir="${docbkx-out}/html/install-guide/OpenDJ-Install-Guide">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
                <copy todir="${docbkx-out}/html/release-notes/OpenDJ-Release-Notes/images">
                  <fileset dir="${docbkx-src}/release-notes/images" />
                </copy>
                <copy todir="${docbkx-out}/html/release-notes/OpenDJ-Release-Notes">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
              </preProcess>

              <postProcess>
                <replace dir="${basedir}/target/docbkx/html/" token="&lt;/html&gt;">
                  <include name="**/**/**/*.html" />
                  <replacevalue>
&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.01 Transitional//EN&quot; &quot;http://www.w3.org/TR/html4/loose.dtd&quot;&gt;
&lt;html &gt;</replacevalue>
                </replace>
                <replace dir="${basedir}/target/docbkx/html/" token="&lt;/head&gt;">
                  <include name="**/**/**/*.html" />
                  <replacevalue>
&lt;script src="http://code.jquery.com/jquery-latest.min.js" type="text/javascript"&gt;&lt;/script&gt;
&lt;script type="text/javascript"&gt;
// On double-click, reformat &lt;div class="screen"&gt; for easy copying.
$(document).ready(function() {
  // Workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=116083
  if (navigator.userAgent.match(/Firefox/i)) {
    $(".screen").wrap("&lt;pre /&gt;");
    $(".programlisting").wrap("&lt;pre /&gt;");
  }
  $(".screen").attr("title", "Double-click [-] to flatten lines.");
  $(".screen").prepend('&lt;img src="../images/minus.png" class="toggle"&gt;');
});
$(".screen").live("dblclick", function() {
  $(this).replaceWith(
    "&lt;div class=\"flat\" title=\"Double-click [+] to wrap long lines.\"&gt;" +
    $(this).html().replace(/minus\.png/,"plus.png").replace(/\n /g," ") + "\n&lt;!--" + $(this).html() + "--&gt;" +
    "&lt;/div&gt;");
});
$(".flat").live("dblclick", function() {
  $(this).replaceWith(
    "&lt;div class=\"screen\" title=\"Double-click [-] to flatten lines.\"&gt;" +
    $(this).html().replace(/(.|\n)+&lt;!\-\-/m,"").replace(/\-\-\&gt;/,"").replace(/plus\.png/,"minus.png") +
    "&lt;/div&gt;");
});
&lt;/script&gt;
&lt;link rel="shortcut icon" href="http://forgerock.org/favicon.ico"&gt;
&lt;/head &gt;</replacevalue>
                </replace>
                <replace dir="${basedir}/target/docbkx/html/" token="&lt;/body&gt;">
                  <include name="**/**/**/*.html" />
                  <replacevalue>&lt;script type="text/javascript"&gt;
  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-23412190-8']);
  _gaq.push(['_trackPageview']);
  (function() {
    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  })();
&lt;/script&gt;&lt;/body &gt;</replacevalue>
                </replace>
              </postProcess>
            </configuration>
          </execution>
          <execution>
            <id>doc-single-html</id>
            <phase>pre-site</phase>
            <goals>
              <goal>generate-html</goal>
            </goals>
            <configuration>
              <chunkedOutput>false</chunkedOutput>
              <htmlCustomization>${dbstyle-dir}/html/coredoc.xsl</htmlCustomization>

              <targetDatabaseDocument>${docbkx-src}/olinkdb-single-html-pages.xml</targetDatabaseDocument>
              <!-- Resources required but not copied by DocBook.xsl. -->
              <preProcess>
                <copy todir="${docbkx-out}/html/admin-guide/images">
                  <fileset dir="${docbkx-src}/admin-guide/images" />
                </copy>
                <copy todir="${docbkx-out}/html/admin-guide">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
                <copy todir="${docbkx-out}/html/dev-guide/images">
                  <fileset dir="${docbkx-src}/dev-guide/images" />
                </copy>
                <copy todir="${docbkx-out}/html/dev-guide">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
                <copy todir="${docbkx-out}/html/install-guide/images">
                  <fileset dir="${docbkx-src}/install-guide/images" />
                </copy>
                <copy todir="${docbkx-out}/html/install-guide">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
                <copy todir="${docbkx-out}/html/release-notes/images">
                  <fileset dir="${docbkx-src}/release-notes/images" />
                </copy>
                <copy todir="${docbkx-out}/html/release-notes">
                  <fileset dir="${basedir}/src/main/resources" />
                </copy>
              </preProcess>

              <postProcess>
                <replace dir="${basedir}/target/docbkx/html/" token="&lt;/html&gt;">
                  <include name="**/**/*.html" />
                  <replacevalue>
&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.01 Transitional//EN&quot; &quot;http://www.w3.org/TR/html4/loose.dtd&quot;&gt;
&lt;html &gt;</replacevalue>
                </replace>
                <replace dir="${basedir}/target/docbkx/html/" token="&lt;/head&gt;">
                  <include name="**/**/*.html" />
                  <replacevalue>
&lt;script src="http://code.jquery.com/jquery-latest.min.js" type="text/javascript"&gt;&lt;/script&gt;
&lt;script type="text/javascript"&gt;
// On double-click, reformat &lt;div class="screen"&gt; for easy copying.
$(document).ready(function() {
  // Workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=116083
  if (navigator.userAgent.match(/Firefox/i)) {
    $(".screen").wrap("&lt;pre /&gt;");
    $(".programlisting").wrap("&lt;pre /&gt;");
  }
  $(".screen").attr("title", "Double-click [-] to flatten lines.");
  $(".screen").prepend('&lt;img src="./images/minus.png" class="toggle"&gt;');
});
$(".screen").live("dblclick", function() {
  $(this).replaceWith(
    "&lt;div class=\"flat\" title=\"Double-click [+] to wrap long lines.\"&gt;" +
    $(this).html().replace(/minus\.png/,"plus.png").replace(/\n /g," ") + "\n&lt;!--" + $(this).html() + "--&gt;" +
    "&lt;/div&gt;");
});
$(".flat").live("dblclick", function() {
  $(this).replaceWith(
    "&lt;div class=\"screen\" title=\"Double-click [-] to flatten lines.\"&gt;" +
    $(this).html().replace(/(.|\n)+&lt;!\-\-/m,"").replace(/\-\-\&gt;/,"").replace(/plus\.png/,"minus.png") +
    "&lt;/div&gt;");
});
&lt;/script&gt;
&lt;link rel="shortcut icon" href="http://forgerock.org/favicon.ico"&gt;
&lt;/head&gt;</replacevalue>
                </replace>
              </postProcess>
            </configuration>
          </execution>
        </executions>
        <dependencies>
          <dependency>
            <groupId>net.sf.docbook</groupId>
            <artifactId>docbook-xml</artifactId>
            <version>5.0-all</version>
            <classifier>resources</classifier>
            <type>zip</type>
            <scope>runtime</scope>
          </dependency>
          <dependency>
            <groupId>net.sf.offo</groupId>
            <artifactId>fop-hyph</artifactId>
            <version>1.2</version> <!-- Should use 2.0, but it doesn't exist? -->
            <scope>runtime</scope>
          </dependency>
          <dependency>
           <groupId>net.sf.xslthl</groupId>
           <artifactId>xslthl</artifactId>
           <version>2.0.2</version>
           <scope>runtime</scope>
          </dependency>
        </dependencies>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <inherited>false</inherited>
        <executions>
          <execution>
            <id>layout-doc</id>
            <phase>site</phase>
            <goals>
              <goal>copy-resources</goal>
              <goal>layout</goal>
            </goals>
            <configuration>
              <outputDirectory>${site-out}/doc</outputDirectory>
              <resources>
                <resource>
                  <directory>${docbkx-out}/epub/admin-guide</directory>
                  <includes>
                    <include>**/*.epub</include>
                  </includes>
                </resource>
                <resource>
                  <directory>${docbkx-out}/epub/dev-guide</directory>
                  <includes>
                    <include>**/*.epub</include>
                  </includes>
                </resource>
                <resource>
                  <directory>${docbkx-out}/epub/install-guide</directory>
                  <includes>
                    <include>**/*.epub</include>
                  </includes>
                </resource>
                <resource>
                  <directory>${docbkx-out}/epub/release-notes</directory>
                  <includes>
                    <include>**/*.epub</include>
                  </includes>
                </resource>
                <resource>
                  <directory>${docbkx-out}/html/</directory>
                </resource>
                <resource>
                  <directory>${docbkx-out}/pdf</directory>
                  <includes>
                    <include>**/*.pdf</include>
                  </includes>
                </resource>
                <resource>
                  <directory>${docbkx-out}/rtf</directory>
                  <includes>
                    <include>**/*.rtf</include>
                  </includes>
                </resource>
                <resource>
                  <directory>${basedir}/src/main/resources/docs-redirect</directory>
                  <includes>
                    <include>**/index.html</include>
                  </includes>
                </resource>
              </resources>
            </configuration>
          </execution>
        </executions>
      </plugin>
@@ -630,7 +149,7 @@
        </executions>
        <configuration>
          <includes>
            <include>**/OpenDJ-*.xml</include>
            <include>**/index.xml</include>
          </includes>
          <validating>true</validating>
          <xIncludeAware>true</xIncludeAware>