All Classes and Interfaces
Class
Description
AbstractMojo implementation for building core documentation from DocBook XML
using docbkx-tools.
Supported output formats.
Supported DocBook profile attributes.
Copies arbitrary resources from sources to pre-site output for HTML formats.
Build Maven artifact from pre-processed documents.
Unpack documentation artifacts and prepare them for Backstage.
Encapsulation of information about doc artifacts to unpack.
Converts Asciidoc source files to DocBook 5 XML.
Call other classes to prepare documents according to Backstage layout.
HTML post-processor for Bootstrap-formatted HTML formats.
Copy Bootstrap files under the specified directories.
Unpack branding elements.
Build chunked HTML output.
Augment the modifiable copy DocBook XML sources with common content.
Applies profiling to the modifiable copy of DocBook XML sources.
Create thumbnails of .png images in the modifiable copy of the sources.
Replace CSS in release HTML.
Replace
CURRENT.DOCID# with the current document ID + #.Add custom CSS for the normal, non-release build.
Set DPI on .png images in the modifiable copy of the sources.
Build EPUB output format.
Fix favicon links in release HTML.
Construct a FileFilter to match files.
Apply Maven resource filtering to the modifiable copy of DocBook XML sources,
replacing Maven properties such as
${myProperty} with their values.Copy files not having a particular extension.
Update matching files in all directories, replacing the first occurrence of
the string to replace with the replacement string.
Build FO output formats.
Prepare fonts for use with Apache FOP.
Add color to <thead><row> in DocBook XML sources.
Display help information on doc-maven-plugin.
Call
Call
mvn doc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.Add
.htaccess file to the site layout.HTML post-processor for both single-page and chunked HTML formats.
Build XHTML output.
Utility methods to prepare built HTML docs for publication.
Copy images from source to destination.
Edit
<imagedata> elements in DocBook XML sources.Update XML files, transforming <imagedata> elements to make sure they use
scalefit="1", width="100%", and contentdepth="100%"
attributes.Add an index.html file to the release layout.
Use JCite to quote Java code.
Keep shorter programlisting and screen elements on the same page in FO.
Update XML files based on an XSL resource.
Lay out built documents,
by default under
${project.build.directory}/release/version.Lay out built documents,
by default under
${project.build.directory}/site/doc/.Test links in pre-processed copy of the sources.
Build man page output.
Fix man page file locations.
Make a modifiable copy of the documentation source files,
rather than working directly on the original source files.
FreeMarker method for getting a single document name.
Utility methods to work with documents.
No-op processor for formats that have no post-processing at present.
Build olink target database files.
Rename PDF files for Backstage,
Product-from-docset-json-Version-Doc-name.pdf.Build PDF output.
Rename PDF files in the release layout.
Use PlantUML to generate images.
Set dots per inch in the metadata of a Portable Network Graphics image.
Call other classes to pre-process documentation sources.
Call other classes to perform pre-site build.
Offers an alternative to DocBook profiling.
Add file to redirect
/doc/index.html to /docs.html.Call other classes to prepare release layout documents.
Remove robots meta tag in release HTML.
Build RTF output.
Build single-page HTML output.
Call other classes to copy docs to site build directory.
Copy SyntaxHighlighter files under the specified directories.
Update XML files, adding a dbfo processing instruction
to set the background color of table header rows.
Build webhelp output.
Webhelp post-processor for both single-page and chunked HTML formats.
Use the XCite Maven plugin to quote text files.
XHTML post-processor.
Build XHTML output.
Apply and XSL transformation to DocBook XML files.
Zip release documents if configured to do so.