Fix OPENDJ-195: Add chunked HTML (1 page/chapter) as an alternative to 1 pa...

Mark Craig

08.39.2011 be345187c1ebcc44c69c1ab3051686e4ff09664e

 opendj3/pom.xml

@@ -102,7 +102,7 @@
    <dbstyle-dir>${basedir}/src/main/docbkx-stylesheets</dbstyle-dir>
    <docbkx-out>${basedir}/target/docbkx</docbkx-out>
    <site-out>${basedir}/target/site</site-out>
    <legalnotice>${docbkx-out}/html/legalnotice.html</legalnotice>
    <legalnotice>${basedir}/target/docbkx/html/legalnotice.html</legalnotice>
  </properties>
  <build>
    <plugins>
@@ -111,72 +111,95 @@
        <artifactId>docbkx-maven-plugin</artifactId>
        <version>2.0.13</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>

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

          <htmlStylesheet>css/coredoc.css</htmlStylesheet>
        </configuration>
        <executions>
          <execution>
            <id>build-doc</id>
            <id>doc-epub</id>
            <phase>pre-site</phase>
            <goals>
              <goal>generate-epub</goal>
              <goal>generate-html</goal>
              <goal>generate-pdf</goal>
              <goal>generate-rtf</goal>
              <goal>generate-manpages</goal>
            </goals>
            <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>

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

       <!-- EPUB -->
              <epubCustomization>${dbstyle-dir}/epub/coredoc.xsl</epubCustomization>
       
       <!-- HTML -->
              <chunkedOutput>false</chunkedOutput>
              <htmlCustomization>${dbstyle-dir}/html/coredoc.xsl</htmlCustomization>
              <htmlStylesheet>css/coredoc.css</htmlStylesheet>
       
       <!-- PDF, RTF -->
              <foCustomization>${dbstyle-dir}/fo/coredoc.xsl</foCustomization>

       <!-- Resources required but not copied by DocBook.xsl.
            TODO: Figure out how to say foreach in ant. -->
              
              <!-- 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/dev-guide/OpenDJ-Dev-Guide/images'>
                  <fileset dir='${docbkx-src}/dev-guide/images' />
                </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/release-notes/OpenDJ-Release-Notes/images'>
                  <fileset dir='${docbkx-src}/release-notes/images' />
                </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><!-- Nothing specific, yet. --></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>

              <!-- 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}/epub/dev-guide/OpenDJ-Dev-Guide/images'>
                  <fileset dir='${docbkx-src}/dev-guide/images' />
                </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}/epub/install-guide/OpenDJ-Install-Guide/images'>
                  <fileset dir='${docbkx-src}/install-guide/images' />
                </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}/epub/release-notes/OpenDJ-Release-Notes/images'>
                  <fileset dir='${docbkx-src}/release-notes/images' />
                </copy>
                <copy todir='${docbkx-out}/html/release-notes/images'>
                  <fileset dir='${docbkx-src}/release-notes/images' />
                </copy>
@@ -184,6 +207,74 @@
                  <fileset dir='${basedir}/src/main/resources' />
                </copy>
              </preProcess>
              
              <postProcess>
                <copy file='${legalnotice}' todir='${docbkx-out}/html/admin-guide' />
                <copy file='${legalnotice}' todir='${docbkx-out}/html/dev-guide' />
                <copy file='${legalnotice}' todir='${docbkx-out}/html/install-guide' />
                <copy file='${legalnotice}' todir='${docbkx-out}/html/release-notes' />
                <replace
                  dir="${basedir}/target/docbkx/html/"
                  token="target/docbkx/html/legalnotice.html"
                  value="legalnotice.html">
                  <include name="**/**/*.html" />
                </replace>              
              </postProcess>
            </configuration>
          </execution>
          <execution>
            <id>chunked-html</id>
            <phase>pre-site</phase>
            <goals>
              <goal>generate-html</goal>
            </goals>
            <configuration>
              <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>
                <copy file='${legalnotice}'
                  todir='${docbkx-out}/html/admin-guide/OpenDJ-Admin-Guide' />
                <copy file='${legalnotice}'
                  todir='${docbkx-out}/html/dev-guide/OpenDJ-Dev-Guide' />
                <copy file='${legalnotice}'
                  todir='${docbkx-out}/html/install-guide/OpenDJ-Install-Guide' />
                <copy file='${legalnotice}'
                  todir='${docbkx-out}/html/release-notes/OpenDJ-Release-Notes' />
                <replace
                  dir="${basedir}/target/docbkx/html/"
                  token="target/docbkx/html/legalnotice.html"
                  value="legalnotice.html">
                  <include name="**/**/**/*.html" />
                </replace>
              </postProcess>
            </configuration>
          </execution>
        </executions>
@@ -205,37 +296,6 @@
        </dependencies>
      </plugin>
      <plugin>
        <artifactId>maven-antrun-plugin</artifactId>
        <executions>
          <execution>
            <id>fix-legalnotice</id>
            <phase>site</phase>
            <inherited>false</inherited>
            <goals>
              <goal>run</goal>
            </goals>
            <configuration>
              <detail>true</detail>
              <target>
        <!-- TODO: Figure out how to say foreach in ant. -->
                <copy file='${legalnotice}' todir='${basedir}/target/docbkx/html/admin-guide' />
                <copy file='${legalnotice}' todir='${basedir}/target/docbkx/html/dev-guide' />
                <copy file='${legalnotice}' todir='${basedir}/target/docbkx/html/install-guide' />
                <copy file='${legalnotice}' todir='${basedir}/target/docbkx/html/release-notes' />
              </target>
              <target>
                <replace
                  dir="${basedir}/target/docbkx/html/"
                  token="target/docbkx/html/legalnotice.html"
                  value="legalnotice.html">
                  <include name="**/**/*.html" />
                </replace>
              </target>
            </configuration>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <inherited>false</inherited>
@@ -250,8 +310,23 @@
              <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>