Coordinated the DocEngine the produce documentation based on the gdoc format.
| Constructor and description |
|---|
DocPublisher
() |
DocPublisher
(java.io.File src, java.io.File target, java.lang.Object out = LOG) |
| Type | Name and description |
|---|---|
java.util.Properties |
getEngineProperties()Returns the engine properties. |
protected void |
initialize() |
void |
publish() |
void |
registerMacro(java.lang.Object macro)Registers a custom Radeox macro. |
void |
setEngineProperties(java.util.Properties p)Sets the engine properties. |
protected java.lang.Object |
verifyToc(java.io.File baseDir, java.lang.Object gdocFiles, java.lang.Object toc)Checks the table of contents (a tree of UserGuideNodes) for duplicate section/alias names and invalid file paths. |
void |
writeChapter(java.lang.Object section, groovy.text.Template layoutTemplate, groovy.text.Template sectionTemplate, java.io.File guideSrcDir, java.lang.String targetDir, java.lang.Object fullContents, java.lang.Object vars) |
java.lang.String |
writePage(java.lang.Object section, groovy.text.Template layoutTemplate, groovy.text.Template sectionTemplate, java.io.File guideSrcDir, java.lang.String targetDir, java.lang.String subDir, java.lang.Object path, java.lang.Object level, java.lang.Object vars) |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
The AntBuilder instance to use
Directory containing the project's API documentation.
The authors of the documentation
The copyright message
The directory containing any CSS to use (will override defaults) *
The encoding to use (default is UTF-8)
Properties used to configure the DocEngine
The footer to include
The directory containing any images to use (will override defaults) *
The directory containing any Javascript to use (will override defaults) *
The language we're generating for (gets its own sub-directory). Defaults to ''
The documentation license
HTML markup that renders the left logo
HTML markup that renders the right logo
The source directory of the documentation
The directory cotnaining any templates to use (will override defaults) *
The subtitle of the documentation
The target directory to publish to
The title of the documentation
The translators of the documentation (if any)
The version of the documentation
The temporary work directory
Returns the engine properties.
Registers a custom Radeox macro. If the macro has an 'initialContext' property, it is set to the render context before first use.
Sets the engine properties. Allows clients to override the defaults.
Checks the table of contents (a tree of UserGuideNodes) for duplicate section/alias names and invalid file paths.
false if any errors are detected.Groovy Documentation