DocPublisher (Grails 4.1.0.M1)

grails.doc.DocPublisher

Coordinated the DocEngine the produce documentation based on the gdoc format.
See Also:
DocEngine
Authors:
Graeme Rocher
Since:
1.2

Properties Summary

Properties
Type	Name and description
`private static java.lang.String`	`TOC_FILENAME`
`private AntBuilder`	`ant` The AntBuilder instance to use
`private File`	`apiDir` Directory containing the project's API documentation.
`private boolean`	`asciidoc`
`private java.lang.String`	`authors` The authors of the documentation
`private java.lang.String`	`copyright` The copyright message
`private File`	`css` The directory containing any CSS to use (will override defaults) *
`private java.lang.String`	`encoding` The encoding to use (default is UTF-8)
`private Properties`	`engineProperties` Properties used to configure the DocEngine
`Properties`	`engineProperties`
`private File`	`fonts` The directory containing any fonts to use (will override defaults) *
`private java.lang.String`	`footer` The footer to include
`private File`	`images` The directory containing any images to use (will override defaults) *
`private File`	`js` The directory containing any Javascript to use (will override defaults) *
`private java.lang.String`	`language` The language we're generating for (gets its own sub-directory).
`private java.lang.String`	`license` The documentation license
`private java.lang.String`	`logo` HTML markup that renders the left logo
`private java.lang.Object`	`output`
`private File`	`propertiesFile` The properties fie to populate the engine properties from
`private java.lang.String`	`sourceRepo` The source repository
`private java.lang.String`	`sponsorLogo` HTML markup that renders the right logo
`private File`	`src` The source directory of the documentation
`private File`	`style` The directory cotnaining any templates to use (will override defaults) *
`private java.lang.String`	`subtitle` The subtitle of the documentation
`private File`	`target` The target directory to publish to
`private java.lang.String`	`title` The title of the documentation
`private java.lang.String`	`translators` The translators of the documentation (if any)
`private java.lang.String`	`version` The version of the documentation
`private File`	`workDir` The temporary work directory

Constructor Summary

Constructors
Constructor and description
`DocPublisher ()`
`DocPublisher (File src, File target, java.lang.Object out)`
`DocPublisher ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Properties`	`getEngineProperties()` Returns the engine properties.
	`protected void`	`initialize()`
	`void`	`publish()`
	`void`	`registerMacro(java.lang.Object macro)` Registers a custom Radeox macro.
	`void`	`setEngineProperties(Properties p)` Sets the engine properties.
	`protected java.lang.Object`	`verifyToc(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, 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, File guideSrcDir, java.lang.String targetDir, java.lang.String subDir, java.lang.Object path, java.lang.Object level, java.lang.Object vars)`

Inherited Methods Summary

Inherited Methods
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()`

- Property Detail
  - private static final java.lang.String TOC_FILENAME
  - private AntBuilder ant
    
    The AntBuilder instance to use
  - private File apiDir
    
    Directory containing the project's API documentation.
  - private boolean asciidoc
  - private java.lang.String authors
    
    The authors of the documentation
  - private java.lang.String copyright
    
    The copyright message
  - private File css
    
    The directory containing any CSS to use (will override defaults) *
  - private java.lang.String encoding
    
    The encoding to use (default is UTF-8)
  - private Properties engineProperties
    
    Properties used to configure the DocEngine
  - Properties engineProperties
  - private File fonts
    
    The directory containing any fonts to use (will override defaults) *
  - private java.lang.String footer
    
    The footer to include
  - private File images
    
    The directory containing any images to use (will override defaults) *
  - private File js
    
    The directory containing any Javascript to use (will override defaults) *
  - private java.lang.String language
    
    The language we're generating for (gets its own sub-directory). Defaults to ''
  - private java.lang.String license
    
    The documentation license
  - private java.lang.String logo
    
    HTML markup that renders the left logo
  - private java.lang.Object output
  - private File propertiesFile
    
    The properties fie to populate the engine properties from
  - private java.lang.String sourceRepo
    
    The source repository
  - private java.lang.String sponsorLogo
    
    HTML markup that renders the right logo
  - private File src
    
    The source directory of the documentation
  - private File style
    
    The directory cotnaining any templates to use (will override defaults) *
  - private java.lang.String subtitle
    
    The subtitle of the documentation
  - private File target
    
    The target directory to publish to
  - private java.lang.String title
    
    The title of the documentation
  - private java.lang.String translators
    
    The translators of the documentation (if any)
  - private java.lang.String version
    
    The version of the documentation
  - private File workDir
    
    The temporary work directory
- Constructor Detail
  - DocPublisher()
  - DocPublisher(File src, File target, java.lang.Object out)
  - DocPublisher()
- Method Detail
  - Properties getEngineProperties()
    
    Returns the engine properties.
  - protected void initialize()
  - void publish()
  - void registerMacro(java.lang.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 java.lang.Object verifyToc(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.
    Returns:
    false if any errors are detected.
  - void writeChapter(java.lang.Object section, groovy.text.Template layoutTemplate, groovy.text.Template sectionTemplate, 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, File guideSrcDir, java.lang.String targetDir, java.lang.String subDir, java.lang.Object path, java.lang.Object level, java.lang.Object vars)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class DocPublisher

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private static final java.lang.String TOC_FILENAME

private AntBuilder ant

private File apiDir

private boolean asciidoc

private java.lang.String authors

private java.lang.String copyright

private File css

private java.lang.String encoding

private Properties engineProperties

Properties engineProperties

private File fonts

private java.lang.String footer

private File images

private File js

private java.lang.String language

private java.lang.String license

private java.lang.String logo

private java.lang.Object output

private File propertiesFile

private java.lang.String sourceRepo

private java.lang.String sponsorLogo

private File src

private File style

private java.lang.String subtitle

private File target

private java.lang.String title

private java.lang.String translators

private java.lang.String version

private File workDir

Constructor Detail

DocPublisher()

DocPublisher(File src, File target, java.lang.Object out)

DocPublisher()

Method Detail

Properties getEngineProperties()

protected void initialize()

void publish()

void registerMacro(java.lang.Object macro)

void setEngineProperties(Properties p)

protected java.lang.Object verifyToc(File baseDir, java.lang.Object gdocFiles, java.lang.Object toc)

void writeChapter(java.lang.Object section, groovy.text.Template layoutTemplate, groovy.text.Template sectionTemplate, 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, File guideSrcDir, java.lang.String targetDir, java.lang.String subDir, java.lang.Object path, java.lang.Object level, java.lang.Object vars)