DirectoryWriter (DocJGenerator Plugins API)

```
public interface DirectoryWriter
```
This class generates a list of html files (to produce a wiki-like html site) from an input model.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`allowIdenticalTitleIDs()` Return true if the parser accept identical title IDs.
`default boolean`	`forceAbsoluteLinksFeature()` Return true if the articles Table of contents must be generated.
`default boolean`	`getFeature(java.lang.String name)` Return a property value for the writer.
`default boolean`	`getFeature(java.lang.String name, boolean defaultValue)` Return a property value for the writer.
`ArticlesModel`	`getModel()` Return the model.
`default boolean`	`isSupportingThemes()` Return true if the writer support themes.
`default boolean`	`isWritingComments()` Return true if comments are written.
`default boolean`	`isXHTMLCompliant()` Return true if the writer will write an XHTML compliant result.
`void`	`setErrorHandler(org.docgene.parser.XMLErrorHandler errorHandler)` Set the error handler which will be used to create and store errors or informations during the writing.
`default void`	`setFeature(java.lang.String name, boolean value)` Set a property value for the writer.
`void`	`setModel(java.io.File dir, ArticlesModel model)` Set the model.
`default boolean`	`setSupportThemes()` Return true if the writer support themes.
`default void`	`setupFeatures()` Setup the writer configuration.
`default boolean`	`writeAnyScriptsFeature()` Return true if the writer can write scripts.
`default boolean`	`writeArticlesHeaderFrame()` Return true if the articles header frame must be written.
`default boolean`	`writeArticlesTOCFeature()` Return true if the articles Table of contents must be generated.
`void`	`writeContent()` Write the wiki content.
`default boolean`	`writeFallback()` Return true if allowing to write the fallback articles.
`default boolean`	`writeHTMLArticlesFrame()` Return true if the html articles can be enclosed in frames.
`default boolean`	`writeResourcesFeature()` Return true if the writer can write resources files.
`default boolean`	`writeScriptsFeature()` Return true if the writer can write scripts.
`default boolean`	`writeSeeAlsoFeature()` Return true if the writer can write seeAlso elements.
`default boolean`	`writeSubDirectories()` Return true if allowing to write articles, resources and images in sub-directories.

- Method Detail
  - setErrorHandler
```
void setErrorHandler(org.docgene.parser.XMLErrorHandler errorHandler)
```
    Set the error handler which will be used to create and store errors or informations during the writing.
    
    Parameters:
    
    errorHandler - the error handler
  - setFeature
```
default void setFeature(java.lang.String name,
                        boolean value)
```
    Set a property value for the writer. Do nothing by default.
    
    Parameters:
    
    name - the property name
    
    value - the property value
  - getFeature
```
default boolean getFeature(java.lang.String name)
```
    Return a property value for the writer. Return false by default.
    
    Parameters:
    
    name - name the property name
    
    Returns:
    
    the property value
  - getFeature
```
default boolean getFeature(java.lang.String name,
                           boolean defaultValue)
```
    Return a property value for the writer. Return a default value by default.
    
    Parameters:
    
    name - name the property name
    
    defaultValue - the property default value
    
    Returns:
    
    the property value
  - writeScriptsFeature
```
default boolean writeScriptsFeature()
```
    Return true if the writer can write scripts. If false, scripts are not allowed but database scripts (such as full text) are allowed.
    
    Returns:
    
    true if the writer can write scripts
  - writeAnyScriptsFeature
```
default boolean writeAnyScriptsFeature()
```
    Return true if the writer can write scripts. If false, it means that any scripts are not allowed.
    
    Returns:
    
    true if the writer can write scripts
  - writeResourcesFeature
```
default boolean writeResourcesFeature()
```
    Return true if the writer can write resources files.
    
    Returns:
    
    true if the writer can write resources files
  - writeSeeAlsoFeature
```
default boolean writeSeeAlsoFeature()
```
    Return true if the writer can write seeAlso elements.
    
    Returns:
    
    true if the writer can write seeAlso elements
  - writeArticlesTOCFeature
```
default boolean writeArticlesTOCFeature()
```
    Return true if the articles Table of contents must be generated.
    
    Returns:
    
    true if the articles Table of contents must be generated
  - forceAbsoluteLinksFeature
```
default boolean forceAbsoluteLinksFeature()
```
    Return true if the articles Table of contents must be generated.
    
    Returns:
    
    true if the articles Table of contents must be generated
  - setSupportThemes
```
default boolean setSupportThemes()
```
    Return true if the writer support themes.
    
    Returns:
    
    true if the writer support themes
  - allowIdenticalTitleIDs
```
default boolean allowIdenticalTitleIDs()
```
    Return true if the parser accept identical title IDs.
    
    Returns:
    
    true if the parser accept identical title IDs
  - writeSubDirectories
```
default boolean writeSubDirectories()
```
    Return true if allowing to write articles, resources and images in sub-directories.
    
    Returns:
    
    true if allowing to write articles, resources and images in sub-directories
  - writeFallback
```
default boolean writeFallback()
```
    Return true if allowing to write the fallback articles.
    
    Returns:
    
    true if allowing to write the fallback articles
  - writeArticlesHeaderFrame
```
default boolean writeArticlesHeaderFrame()
```
    Return true if the articles header frame must be written.
    
    Returns:
    
    true if the articles header frame must be written
  - writeHTMLArticlesFrame
```
default boolean writeHTMLArticlesFrame()
```
    Return true if the html articles can be enclosed in frames.
    
    Returns:
    
    true if the html articles can be enclosed in frames
  - isWritingComments
```
default boolean isWritingComments()
```
    Return true if comments are written.
    
    Returns:
    
    true if comments are written
  - isXHTMLCompliant
```
default boolean isXHTMLCompliant()
```
    Return true if the writer will write an XHTML compliant result.
    
    Returns:
    
    true if the writer will write an XHTML compliant result
  - isSupportingThemes
```
default boolean isSupportingThemes()
```
    Return true if the writer support themes.
    
    Returns:
    
    true if the writer support themes
  - setupFeatures
```
default void setupFeatures()
```
    Setup the writer configuration. It will allow to get the specific parsing and wirting features of the writer. Do nothing by default.
  - setModel
```
void setModel(java.io.File dir,
              ArticlesModel model)
```
    Set the model.
    
    Parameters:
    
    dir - the base directory
    
    model - the articles model
  - getModel
```
ArticlesModel getModel()
```
    Return the model.
    
    Returns:
    
    the articles model
  - writeContent
```
void writeContent()
           throws org.docgene.writer.DocJWriterException
```
    Write the wiki content.
    
    Throws:
    
    DocJWriterException - thrown if an exception occur when trying to write the content

Interface DirectoryWriter

Method Summary

Method Detail

setErrorHandler

setFeature

getFeature

getFeature

writeScriptsFeature

writeAnyScriptsFeature

writeResourcesFeature

writeSeeAlsoFeature

writeArticlesTOCFeature

forceAbsoluteLinksFeature

setSupportThemes

allowIdenticalTitleIDs

writeSubDirectories

writeFallback

writeArticlesHeaderFrame

writeHTMLArticlesFrame

isWritingComments

isXHTMLCompliant

isSupportingThemes

setupFeatures

setModel

getModel

writeContent