Property Detail

• static final String TOC_FILENAME

• AntBuilder ant

  The AntBuilder instance to use

• File apiDir

  Directory containing the project's API documentation.

• boolean asciidoc

• String authors

  The authors of the documentation

• boolean bookmarks

  Whether to generate bookmarks for PDF

• String copyright

  The copyright message

• File css

  The directory containing any CSS to use (will override defaults)

• String encoding

  The encoding to use (default is UTF-8)

• Properties engineProperties

  Properties used to configure the DocEngine

• Properties engineProperties

• File fonts

  The directory containing any fonts to use (will override defaults)

• String footer

  The footer to include

• File images

  The directory containing any images to use (will override defaults)

• File js

  The directory containing any Javascript to use (will override defaults)

• String language

  The language we're generating for (gets its own sub-directory). Defaults to ''

• String license

  The documentation license

• String logo

  HTML markup that renders the left logo

• Object output

• File propertiesFile

  The properties fie to populate the engine properties from

• String singleHtml

  the file name of the generated html

• String singlePdf

  the file name of the generated PDF

• String sourceRepo

  The source repository

• String sponsorLogo

  HTML markup that renders the right logo

• File src

  The source directory of the documentation

• File style

  The directory containing any templates to use (will override defaults)

• String subtitle

  The subtitle of the documentation

• File target

  The target directory to publish to

• String title

  The title of the documentation

• String translators

  The translators of the documentation (if any)

• String version

  The version of the documentation

• File workDir

  The temporary work directory

Constructor Detail

• DocPublisher()

• DocPublisher(File src, File target, Object out)

Method Detail

• Properties getEngineProperties()

  Returns the engine properties.

• @SuppressWarnings(value: UnnecessaryPackageReference)
  protected void initialize()

• void publish()

• void publishPdf()

• void registerMacro(Object macro)

  Registers a custom Radeox macro. If the macro has an 'initialContext' property, it is set to the render context before first use.

• void setEngineProperties(Properties p)

  Sets the engine properties. Allows clients to override the defaults.

• protected Object verifyToc(File baseDir, Object gdocFiles, Object toc)

  Checks the table of contents (a tree of UserGuideNodes) for duplicate section/alias names and invalid file paths.

  Returns:

  false if any errors are detected.

• void writeChapter(Object section, Template layoutTemplate, Template sectionTemplate, File guideSrcDir, String targetDir, Object fullContents, Object vars)

• String writePage(Object section, Template layoutTemplate, Template sectionTemplate, File guideSrcDir, String targetDir, String subDir, Object path, Object level, Object vars)