Skip to content

Commit

Permalink
gh-958 Use Asciidoctor's PDF generation
Browse files Browse the repository at this point in the history 
* Remove docbook-based Maven tool-chain
* Ensure Spring Cloud Data Flow logo shows up on PDF cover-page
* Ensure Spring Cloud Data Flow version-number shows up on PDF cover-page
* Ensure that PDF and HTML docs are bundled up correctly

* Remove docbook contents
* Add basic theme-template

Fix Part pagebreaks, move files
  • Loading branch information
@ghillert @ericbottard
ghillert authored and ericbottard committed Nov 15, 2016
1 parent 507f885 commit f707c9b
Show file tree
Hide file tree
Showing 60 changed files with 92 additions and 3,952 deletions.
153 changes: 4 additions & 149 deletions spring-cloud-dataflow-docs/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,19 +144,6 @@
</attributes>
</configuration>
<executions>
<execution>
<id>generate-docbook</id>
<phase>prepare-package</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>docbook5</backend>
<attributes>
<docinfo>true</docinfo>
</attributes>
</configuration>
</execution>
<execution>
<id>generate-html5</id>
<phase>prepare-package</phase>
Expand All @@ -181,6 +168,8 @@
<backend>pdf</backend>
<sourceHighlighter>rouge</sourceHighlighter>
<attributes>
<pdf-stylesdir>${project.basedir}/src/main/asciidoc-pdf-theme</pdf-stylesdir>
<pdf-style>custom</pdf-style>
<icons>font</icons>
<pagenums />
<toc />
Expand All @@ -191,140 +180,6 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>com.agilejava.docbkx</groupId>
<artifactId>docbkx-maven-plugin</artifactId>
<version>2.0.15</version>
<configuration>
<sourceDirectory>${basedir}/target/generated-docs</sourceDirectory>
<imgSrcPath />
<graphicsize.extension>0</graphicsize.extension>
<includes>index.xml</includes>
<xincludeSupported>true</xincludeSupported>
<chunkedOutput>false</chunkedOutput>
<foCustomization>${basedir}/src/main/docbook/xsl/pdf.xsl</foCustomization>
<useExtensions>1</useExtensions>
<admonGraphics>1</admonGraphics>

<highlightSource>1</highlightSource>
<highlightXslthlConfig>${basedir}/src/main/docbook/xsl/xslthl-config.xml</highlightXslthlConfig>
<preProcess>
<copy todir="${basedir}/target/generated-docs/images">
<fileset dir="${basedir}/src/main/docbook/images" />
</copy>
</preProcess>
</configuration>
<dependencies>
<dependency>
<groupId>net.sf.xslthl</groupId>
<artifactId>xslthl</artifactId>
<version>2.1.0</version>
</dependency>
<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>
</dependencies>
<executions>
<execution>
<id>html-single</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>prepare-package</phase>
<configuration>
<htmlCustomization>${basedir}/src/main/docbook/xsl/html-singlepage.xsl</htmlCustomization>
<targetDirectory>${basedir}/target/docbook/htmlsingle</targetDirectory>
<postProcess>
<copy todir="${basedir}/target/contents/reference/htmlsingle">
<fileset dir="${basedir}/target/docbook/htmlsingle">
<include name="**/*.html" />
</fileset>
</copy>
<copy todir="${basedir}/target/contents/reference/htmlsingle/images">
<fileset dir="${basedir}/target/generated-docs/images" />
</copy>
<copy todir="${basedir}/target/contents/reference/htmlsingle/css">
<fileset dir="${basedir}/src/main/docbook/css" />
</copy>
</postProcess>
</configuration>
</execution>
<execution>
<id>html</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>prepare-package</phase>
<configuration>
<htmlCustomization>${basedir}/src/main/docbook/xsl/html-multipage.xsl</htmlCustomization>
<targetDirectory>${basedir}/target/docbook/html</targetDirectory>
<chunkedOutput>true</chunkedOutput>
<postProcess>
<copy todir="${basedir}/target/contents/reference/html">
<fileset dir="${basedir}/target/docbook/html">
<include name="**/*.html" />
</fileset>
</copy>
<copy todir="${basedir}/target/contents/reference/html/images">
<fileset dir="${basedir}/target/generated-docs/images" />
</copy>
<copy todir="${basedir}/target/contents/reference/html/css">
<fileset dir="${basedir}/src/main/docbook/css" />
</copy>
</postProcess>
</configuration>
</execution>
<execution>
<id>pdf</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>prepare-package</phase>
<configuration>
<foCustomization>${basedir}/src/main/docbook/xsl/pdf.xsl</foCustomization>
<targetDirectory>${basedir}/target/docbook/pdf</targetDirectory>
<postProcess>
<copy todir="${basedir}/target/contents/reference">
<fileset dir="${basedir}/target/docbook">
<include name="**/*.pdf" />
</fileset>
</copy>
<move file="${basedir}/target/contents/reference/pdf/index.pdf" tofile="${basedir}/target/contents/reference/pdf/spring-cloud-dataflow-reference.pdf" />
</postProcess>
</configuration>
</execution>
<execution>
<id>epub</id>
<goals>
<goal>generate-epub3</goal>
</goals>
<phase>prepare-package</phase>
<configuration>
<epubCustomization>${basedir}/src/main/docbook/xsl/epub.xsl</epubCustomization>
<targetDirectory>${basedir}/target/docbook/epub</targetDirectory>
<preProcess>
<copy todir="${basedir}/target/docbook/epub/images">
<fileset dir="${basedir}/src/main/docbook/images" />
<fileset dir="${basedir}/src/main/asciidoc/images" />
</copy>
</preProcess>
<postProcess>
<copy todir="${basedir}/target/contents/reference/epub">
<fileset dir="${basedir}/target/docbook">
<include name="**/*.epub" />
</fileset>
</copy>
<move file="${basedir}/target/contents/reference/epub/index.epub" tofile="${basedir}/target/contents/reference/epub/spring-cloud-dataflow-reference.epub" />
</postProcess>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
Expand Down Expand Up @@ -363,8 +218,8 @@
<target>
<zip destfile="${project.build.directory}/${project.artifactId}-${project.version}.zip">
<zipfileset src="${project.build.directory}/${project.artifactId}-${project.version}-javadoc.jar" prefix="api" />
<fileset dir="${project.build.directory}/contents" />
<zipfileset dir="${project.build.directory}/generated-docs" prefix="html5">
<zipfileset dir="${project.build.directory}/generated-docs" includes="index.pdf" fullpath="reference/pdf/spring-cloud-dataflow-reference.pdf" />
<zipfileset dir="${project.build.directory}/generated-docs" prefix="reference/html">
<include name="index.html" />
<include name="images/**" />
</zipfileset>
Expand Down
0 ...ow-docs/src/main/docbook/images/cover.png → ...ocs/src/main/asciidoc-pdf-theme/cover.png
View file
File renamed without changes
40 changes: 40 additions & 0 deletions spring-cloud-dataflow-docs/src/main/asciidoc-pdf-theme/custom-theme.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
title_page:
align: center
page:
layout: portrait
margin: [0.75in, 1in, 0.75in, 1in]
size: A4
base:
font_color: #333333
line_height_length: 17
line_height: $base_line_height_length / $base_font_size
vertical_rhythm: $base_line_height_length
heading:
font_color: #000000
font_size: 17
font_style: bold
line_height: 1.2
link:
font_color: #009900
outline_list:
indent: $base_font_size * 1.5
header:
height: 0.75in
line_height: 1
recto_content:
center: '{document-title}'
verso_content:
center: '{document-title}'
footer:
height: 0.75in
line_height: 1
recto_content:
right: '*{page-number}*'
verso_content:
left: '*{page-number}* | {chapter-title}'
image:
align: center
caption:
align: center
font_color: #000000
font_size: 10
20 changes: 0 additions & 20 deletions spring-cloud-dataflow-docs/src/main/asciidoc/Guardfile
View file

This file was deleted.

0 ...low-docs/src/main/docbook/images/logo.png → ...ow-docs/src/main/asciidoc/images/logo.png
View file
File renamed without changes
28 changes: 0 additions & 28 deletions spring-cloud-dataflow-docs/src/main/asciidoc/index-docinfo.xml
View file

This file was deleted.

47 changes: 46 additions & 1 deletion spring-cloud-dataflow-docs/src/main/asciidoc/index.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
= Spring Cloud Data Flow Reference Guide
Sabby Anandan; Marius Bogoevici; Eric Bottard; Mark Fisher; Ilayaperumal Gopinathan; Gunnar Hillert; Mark Pollack; Patrick Peralta; Glenn Renfro; Thomas Risberg; Dave Syer; David Turanski; Janne Valkealahti
v{project-version}
:doctype: book
:toc:
:toclevels: 4
:source-highlighter: prettify
:numbered:
:icons: font
:hide-uri-scheme:
:title-logo-image: image:logo.png[top=10%, align=center, pdfwidth=6cm]

:spring-cloud-dataflow-docs: http://docs.spring.io/spring-cloud-dataflow/docs/{project-version}/reference
:spring-cloud-dataflow-docs-current: http://docs.spring.io/spring-cloud-dataflow/docs/current-SNAPSHOT/reference/html/
Expand All @@ -19,17 +21,60 @@ Sabby Anandan; Marius Bogoevici; Eric Bottard; Mark Fisher; Ilayaperumal Gopinat
// ======================================================================================

include::preface.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::spring-cloud-dataflow-overview.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::architecture.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::getting-started.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::configuration.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::streams.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::tasks.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::dashboard.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::howto.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::api-guide.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::dataflow-template.adoc[]
include::appendix.adoc[]

ifdef::backend-pdf[]
<<<
endif::backend-pdf[]
include::appendix.adoc[]

// ======================================================================================
5 changes: 2 additions & 3 deletions spring-cloud-dataflow-docs/src/main/asciidoc/preface.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@

[[dataflow-documentation-about]]
== About the documentation
The Spring Cloud Data Flow reference guide is available as {spring-cloud-dataflow-docs}/html[html],
{spring-cloud-dataflow-docs}/pdf/spring-cloud-dataflow-reference.pdf[pdf]
and {spring-cloud-dataflow-docs}/epub/spring-cloud-dataflow-reference.epub[epub] documents. The latest copy
The Spring Cloud Data Flow reference guide is available as {spring-cloud-dataflow-docs}/html[html] and
{spring-cloud-dataflow-docs}/pdf/spring-cloud-dataflow-reference.pdf[pdf] documents. The latest copy
is available at {spring-cloud-dataflow-docs-current}.

Copies of this document may be made for your own use and for
Expand Down
35 changes: 0 additions & 35 deletions spring-cloud-dataflow-docs/src/main/docbook/css/highlight.css
View file

This file was deleted.

Loading

0 comments on commit f707c9b

Please sign in to comment.