DocGeneratorAPI (DocJGenerator API)

java.lang.Object
- org.docgene.api.DocGeneratorAPI

public class DocGeneratorAPI
extends java.lang.Object

The generator API, usable in another application.

Constructor Summary

Constructors
Constructor and Description

DocGeneratorAPI()
Create the API and don't reset the configuration.

DocGeneratorAPI(boolean reset)
Create the API.

Constructors
Constructor and Description
`DocGeneratorAPI()` Create the API and don't reset the configuration.
`DocGeneratorAPI(boolean reset)` Create the API.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlternateTitle(XMLArticle article, java.lang.String text, boolean keepCase, boolean inDictionnary)` Adds an alternate title to an article.
`XMLAnchor`	`addAnchor(XMLArticle article, ParagraphElementParent parent, java.lang.String anchorID, java.lang.String text)` Add an anchor.
`XMLAnchor`	`addAnchor(XMLArticle article, ParagraphElementParent parent, java.lang.String anchorID, java.lang.String text, int type)` Add an anchor.
`XMLAnchor`	`addAnchor(XMLArticle article, java.lang.String anchorID, java.lang.String text)` Add an anchor at the end of an article.
`XMLAnchor`	`addAnchor(XMLArticle article, java.lang.String anchorID, java.lang.String text, int type)` Add an anchor at the end of an article.
`XMLAnchor`	`addAnchor(XMLTextStyle textStyle, java.lang.String anchorID, java.lang.String text)`
`void`	`addBreak(ParagraphElementParent parent)` Add a break.
`void`	`addBreak(XMLArticle article)` Add a break, at the end of an article.
`DefaultMenuItem`	`addDefaultMenuItem(XMLMenu menu, short type)` Add a default menu item.
`DefaultMenuItem`	`addDefaultMenuItem(XMLMenu menu, short type, java.lang.String desc)` Add a default menu item.
`void`	`addEmptyLine(ParagraphElementParent parent)` Add an empty line.
`void`	`addEmptyLine(XMLArticle article)` Add an empty line, at the end of an article.
`XMLExternalLink`	`addExternalLink(ParagraphElementParent parent, java.net.URL url, java.lang.String desc)` Add an external link.
`XMLExternalLink`	`addExternalLink(XMLArticle article, java.net.URL url, java.lang.String desc)` Add an external link.
`ExternalMenuItem`	`addExternalMenuItem(XMLMenu menu, java.lang.String desc, java.net.URL url)` Add an external menu item to a menu.
`ExternalMenuItem`	`addExternalMenuItem(XMLMenu menu, java.net.URL url, java.lang.String desc)` Add an external menu item to a menu.
`DefaultMenuItem`	`addGlossaryMenuItem(XMLMenu menu, java.lang.String desc)` Add an glossary menu item to a menu.
`XMLImage`	`addImage(XMLArticle article, java.awt.image.BufferedImage bimg, boolean br)` Add an image at the end of an article.
`XMLImage`	`addImage(XMLArticle article, java.io.File imageFile, boolean br)` Add an image at the end of an article.
`XMLImage`	`addImage(XMLArticle article, java.lang.String imageID, boolean br)` Add an image at the end of an article.
`XMLImage`	`addImage(XMLArticle article, java.net.URL url, boolean br)` Add an image at the end of an article.
`XMLImage`	`addImage(org.docgene.model.globals.XMLRootElement element, ParagraphElementParent parent, java.awt.image.BufferedImage bimg, boolean br)` Add an image.
`XMLImage`	`addImage(org.docgene.model.globals.XMLRootElement element, ParagraphElementParent parent, java.io.File imageFile, boolean br)` Add an image.
`XMLImage`	`addImage(org.docgene.model.globals.XMLRootElement element, ParagraphElementParent parent, java.lang.String imageID, boolean br)` Add an image.
`XMLImage`	`addImage(org.docgene.model.globals.XMLRootElement element, ParagraphElementParent parent, java.net.URL url, boolean br)` Add an image.
`InternalMenuItem`	`addInternalMenuItem(XMLMenu menu, java.lang.String refID, java.lang.String desc)` Add an internal menu item to a menu.
`InternalMenuItem`	`addInternalMenuItem(XMLMenu menu, XMLParentArticle article)` Add an internal menu item to a menu.
`InternalMenuItem`	`addInternalMenuItem(XMLMenu menu, XMLParentArticle article, java.lang.String desc)` Add an internal menu item to a menu.
`XMLList`	`addList(ParagraphElementParent parent, boolean isUL)` Add a list.
`XMLList`	`addList(XMLArticle article, boolean isUL)` Add a list at the end of an article.
`XMLListItem`	`addListItem(XMLList list)` Add a list item to a list.
`XMLListItem`	`addListItem(XMLList list, java.lang.String sentence)` Add a list item to a list.
`XMLListItem`	`addListItem(XMLList list, java.lang.String sentence, SentenceStyle style)` Add a list item to a list.
`void`	`addMultilineSentence(ParagraphElementParent parent, java.lang.String text)` Add a multiline sentence.
`void`	`addMultilineSentence(ParagraphElementParent parent, java.lang.String text, int type)` Add a multiline sentence.
`void`	`addMultilineSentence(ParagraphElementParent parent, java.lang.String text, SentenceStyle style)` Add a multiline sentence, setting also its style.
`void`	`addMultilineSentence(XMLArticle article, java.lang.String text)` Add a multiline sentence, at the end of an article.
`void`	`addMultilineSentence(XMLArticle article, java.lang.String text, SentenceStyle style)` Add a multiline sentence, setting also its style, at the end of an article.
`XMLParagraph`	`addParagraph(XMLParent parent)` Add a paragraph.
`XMLReference`	`addReference(XMLArticle article, AnchorElement anchor)` Add a reference at the end of an article.
`XMLReference`	`addReference(XMLArticle article, AnchorElement anchor, java.lang.String desc)` Add a reference at the end of an article.
`XMLReference`	`addReference(XMLArticle article, ParagraphElementParent parent, AnchorElement anchor)` Add a reference.
`XMLReference`	`addReference(XMLArticle article, ParagraphElementParent parent, AnchorElement anchor, java.lang.String desc)` Add a reference.
`XMLReference`	`addReference(XMLArticle article, ParagraphElementParent parent, java.lang.String refID)` Add a reference.
`XMLReference`	`addReference(XMLArticle article, ParagraphElementParent parent, java.lang.String refID, java.lang.String desc)` Add a reference.
`XMLReference`	`addReference(XMLArticle article, ParagraphElementParent parent, XMLParentArticle refArticle)` Add a reference.
`XMLReference`	`addReference(XMLArticle article, ParagraphElementParent parent, XMLParentArticle refArticle, java.lang.String desc)` Add a reference.
`XMLReference`	`addReference(XMLArticle article, java.lang.String refID)` Add a reference at the end of an article.
`XMLReference`	`addReference(XMLArticle article, java.lang.String refID, java.lang.String desc)` Add a reference at the end of an article.
`XMLReference`	`addReference(XMLArticle article, XMLParentArticle refArticle)` Add a reference at the end of an article.
`XMLReference`	`addReference(XMLArticle article, XMLParentArticle refArticle, java.lang.String desc)` Add a reference at the end of an article.
`void`	`addSeeAlso(XMLArticle article, java.lang.String ref)` Add a seeAlso for the article.
`void`	`addSeeAlso(XMLArticle article, java.lang.String ref, java.lang.String desc)` Add a seeAlso for the article.
`void`	`addSeeAlso(XMLArticle article, XMLArticle seeAlsoArticle)` Add a seeAlso for the article.
`void`	`addSeeAlso(XMLArticle article, XMLArticle seeAlsoArticle, java.lang.String desc)` Add a seeAlso for the article.
`XMLSentence`	`addSentence(ParagraphElementParent parent, java.lang.String text)` Add a sentence.
`XMLSentence`	`addSentence(ParagraphElementParent parent, java.lang.String text, int type)` Add a sentence.
`XMLSentence`	`addSentence(ParagraphElementParent parent, java.lang.String text, int type, int size)` Add a sentence.
`XMLSentence`	`addSentence(ParagraphElementParent parent, java.lang.String text, SentenceStyle style)` Add a sentence, setting also its style.
`XMLSentence`	`addSentence(XMLArticle article, java.lang.String text)` Add a sentence, at the end of an article.
`XMLSentence`	`addSentence(XMLArticle article, java.lang.String text, int type)` Add a sentence.
`XMLSentence`	`addSentence(XMLArticle article, java.lang.String text, int type, int size)` Add a sentence.
`XMLSentence`	`addSentence(XMLArticle article, java.lang.String text, SentenceStyle style)` Add a sentence, setting also its style, at the end of an article.
`XMLSentence`	`addSentence(XMLTextStyle textStyle, java.lang.String text)` Add a sentence in a text style.
`void`	`addTab(ParagraphElementParent parent)` Add an tabulation.
`void`	`addTab(XMLArticle article)` Add an tabulation.
`XMLTable`	`addTable(XMLArticle article)` Add a not sortable table at the end of an article.
`XMLTable`	`addTable(XMLArticle article, boolean isSortable)` Add a table at the end of an article.
`XMLTable`	`addTable(XMLArticle article, ParagraphElementParent parent, boolean isSortable)` Add a table.
`XMLTableCell`	`addTableCell(XMLTableRow trow)` Add a table cell.
`XMLTableCell`	`addTableCell(XMLTableRow trow, java.lang.String sentence)` Add a table cell.
`XMLTableCell`	`addTableCell(XMLTableRow trow, java.lang.String sentence, SentenceStyle style)` Add a table cell.
`XMLTableColumn`	`addTableColumn(XMLTable table)` Add a table column.
`XMLTableColumn`	`addTableColumn(XMLTable table, java.lang.String title)` Add a table column.
`XMLTableColumn`	`addTableColumn(XMLTable table, java.lang.String title, SentenceStyle style)` Add a table column.
`XMLTableRow`	`addTableRow(XMLTable table)` Add a table row.
`XMLSizedTableRow`	`addTableRow(XMLTable table, boolean relWidths, int... widths)` Add a table row with specified widths.
`XMLTextStyle`	`addTextStyle(ParagraphElementParent parent, SentenceStyle style)` Add a text style.
`XMLTextStyle`	`addTextStyle(XMLArticle article, SentenceStyle style)` Add a text style, at the end of an article.
`XMLTitle`	`addTitle(XMLArticle article, int level, java.lang.String title)` Add a title for the article.
`XMLTitle`	`addTitle(XMLArticle article, int level, java.lang.String title, boolean keepCase)` Add a title for the article.
`XMLTitle`	`addTitle(XMLArticle article, int level, java.lang.String title, boolean keepCase, boolean isSearchable)` Add a title for the article.
`XMLTitle`	`addTitle(XMLArticle article, ParagraphElementParent parent, int level, java.lang.String title, boolean keepCase)` Add a title for the article.
`XMLTitle`	`addTitle(XMLArticle article, ParagraphElementParent parent, int level, java.lang.String title, boolean keepCase, boolean isSearchable)` Add a title for the article.
`XMLTitle`	`addTitle(XMLArticle article, ParagraphElementParent parent, java.lang.String title)` Add a title for the article, at level 1.
`XMLTitle`	`addTitle(XMLArticle article, java.lang.String title)` Add a title for the article, at the default level (1).
`XMLMenu`	`cleanGlobalLeftMenu()` Merge the left menu on the index and the articles and clean its default content.
`void`	`clear()` Clear the content of the generator.
`XMLArticle`	`createArticle(java.lang.String desc)` Creates an article.
`XMLArticle`	`createArticle(java.lang.String desc, boolean hasTOC, boolean keepCase)` Creates an article.
`XMLArticle`	`createArticle(java.lang.String desc, boolean hasTOC, boolean keepCase, java.lang.String... categories)` Creates an article.
`XMLArticle`	`createArticle(java.lang.String desc, java.lang.String... categories)` Creates an article, belonging to one or several categories.
`ArticleCategory`	`createCategory(java.lang.String id)` Creates a category.
`ArticleCategory`	`createCategory(java.lang.String id, java.lang.String desc)` Creates a category.
`XMLFooter`	`createFooter()` Create the wiki footer.
`XMLHeader`	`createHeader()` Create the wiki header.
`ArticlesModel`	`createModel()` Creates the model.
`OpaqueArticle`	`createOpaqueArticle(java.lang.String desc)` Creates an opaque article.
`OpaqueArticle`	`createOpaqueArticle(java.lang.String desc, boolean keepCase)` Creates an opaque article, belonging to one or several categories.
`OpaqueArticle`	`createOpaqueArticle(java.lang.String desc, boolean keepCase, java.lang.String... categories)` Creates an opaque article, belonging to one or several categories.
`XMLParentArticle`	`getArticle(java.lang.String desc)` Return the article of a specified description.
`Configuration`	`getConfiguration()` Return the configuration.
`org.docgene.model.globals.CustomSearchCategories`	`getCustomSearchCategories()` Return the custom search categories.
`java.lang.String`	`getDefaultFontFace()` Return the default font face for sentences.
`int`	`getDefaultFontSize()` Return the default font size for sentences.
`java.util.List<org.mdiutil.xml.ResolverSAXHandler.ExceptionResult>`	`getGenerationExceptions()` Return the parsing or consistency exceptions.
`XMLIndex`	`getIndex()` Return the index.
`AbstractParagraph`	`getLastParagraph(XMLParent parent)` Return the ladt paragraph of an elemen, or creates one paragraph if it does not exist.
`org.docgene.model.globals.ArticlesMenus`	`getMenus()` Return the articles menus.
`ArticlesModel`	`getModel()` Return the model.
`OpaqueArticle`	`getOpaqueArticle(java.lang.String desc)` Return the opaque article of a specified description.
`ParagraphElementParent`	`getOrCreateLastParagraphParent(XMLArticle article)` Return the last paragraph parent for an article, or create one if it does not exist.
`java.io.File`	`getOutputDirectory()` Return the output directory.
`XMLArticle`	`getXMLArticle(java.lang.String desc)` Return the article of a specified description.
`boolean`	`hasGenerationExceptions()` Return true if the resolving triggered parsing or consistency exceptions.
`XMLArticle`	`importArticle(java.io.File file)` Import an article and add this article to the model.
`XMLArticle`	`importArticle(java.net.URL url)` Import an article and add this article to the model.
`boolean`	`importImageDefinition(java.io.File file)` Import an Image definition XML file to the model.
`boolean`	`importImageDefinition(java.net.URL url)` Import an Image definition XML url to the model.
`XMLArticle`	`includeArticle(XMLArticle parentArticle, java.io.File file, boolean keepLevels)` Include an article in another parent article.
`XMLArticle`	`includeArticle(XMLArticle parentArticle, java.net.URL url, boolean keepLevels)` Include an article in another parent article.
`void`	`includeArticle(XMLArticle parentArticle, XMLArticle includedArticle, boolean keepLevels)` Import an article and add this article to the model.
`void`	`resetConfiguration()` Reset the configuration.
`boolean`	`setCategories(XMLArticle article, java.lang.String... categories)` Set the categories for an article.
`void`	`setCustomStyles(StyledElement element, java.lang.String styleClass, java.lang.String style)` Set the custom styles for an element.
`void`	`setDefaultFontFace(java.lang.String fontFace)` Set the default font face for sentences.
`void`	`setDefaultFontSize(int size)` Set the default font size for sentences.
`boolean`	`setFooter(java.lang.String content)` Set the footer of the wiki.
`void`	`setFullTextSearch(boolean isEnabled, int compressionLevel)` Configure the full text search.
`boolean`	`setHeader(java.lang.String content)` Set the header of the wiki.
`void`	`setIndexGenerationType(char type)` Set the index generation type.
`boolean`	`setLocale(java.lang.String locale)` Set the localization.
`void`	`setMeta(XMLArticle article, java.lang.String meta)` Set the meta of an article.
`boolean`	`setOutputDirectory(java.io.File outputDir)` Set the output directory.
`boolean`	`setOutputDirectory(java.net.URL outputDir)` Set the output directory.
`boolean`	`setOutputType(java.lang.String outputType)` Set the output type of the wiki.
`void`	`setResourcesGenerationType(char type)` Set the resources generation type.
`void`	`setSearch(short searchType)` Set the search type.
`XMLTableHeader`	`setTableHeader(XMLTable table, boolean isVertical)` Set a table header.
`void`	`showGenerationExceptions()` Show the parsing or consistency exceptions.
`void`	`writeContent()` Write the wiki content.
`void`	`writeContent(boolean clean)` Write the wiki content.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DocGeneratorAPI
```
public DocGeneratorAPI()
```
  Create the API and don't reset the configuration.
- DocGeneratorAPI
```
public DocGeneratorAPI(boolean reset)
```
  Create the API.
  
  Parameters:
  
  reset - true if the configuration must be reset

Method Detail

clear
```
public void clear()
```
Clear the content of the generator. If will allow the generator to be reused.

getConfiguration
```
public Configuration getConfiguration()
```
Return the configuration.

Returns:

the configuration

resetConfiguration
```
public void resetConfiguration()
```
Reset the configuration.

getCustomSearchCategories
```
public org.docgene.model.globals.CustomSearchCategories getCustomSearchCategories()
```
Return the custom search categories.

Returns:

the custom search categories

createModel
```
public ArticlesModel createModel()
```
Creates the model.

Returns:

the model

setIndexGenerationType
```
public void setIndexGenerationType(char type)
```
Set the index generation type.

Parameters:

type - the index generation type

See Also:

FileGenerationType

setResourcesGenerationType
```
public void setResourcesGenerationType(char type)
```
Set the resources generation type.

Parameters:

type - the resources generation type

See Also:

FileGenerationType

createCategory
```
public ArticleCategory createCategory(java.lang.String id)
```
Creates a category.

Parameters:

id - the category id

Returns:

the category

createCategory

public ArticleCategory createCategory(java.lang.String id,
                                      java.lang.String desc)

Creates a category.

Parameters:: id - the category id; desc - the category description
Returns:: the category

getModel
```
public ArticlesModel getModel()
```
Return the model.

Returns:

the model

setDefaultFontSize
```
public void setDefaultFontSize(int size)
```
Set the default font size for sentences.

Parameters:

size - the font size

getDefaultFontSize
```
public int getDefaultFontSize()
```
Return the default font size for sentences.

Returns:

the font size

setDefaultFontFace
```
public void setDefaultFontFace(java.lang.String fontFace)
```
Set the default font face for sentences.

Parameters:

fontFace - the font face

getDefaultFontFace
```
public java.lang.String getDefaultFontFace()
```
Return the default font face for sentences.

Returns:

the font face

getIndex
```
public XMLIndex getIndex()
```
Return the index.

Returns:

the index

getMenus

public org.docgene.model.globals.ArticlesMenus getMenus()

Return the articles menus.

Returns:: the menus

cleanGlobalLeftMenu
```
public XMLMenu cleanGlobalLeftMenu()
```
Merge the left menu on the index and the articles and clean its default content.

Returns:

the left menu

addDefaultMenuItem

public DefaultMenuItem addDefaultMenuItem(XMLMenu menu,
                                          short type)
                                   throws DocGeneratorAPIException

Add a default menu item.

Parameters:: menu - the menu; type - the item type
Returns:: the default menu item
Throws:: DocGeneratorAPIException

addDefaultMenuItem

public DefaultMenuItem addDefaultMenuItem(XMLMenu menu,
                                          short type,
                                          java.lang.String desc)
                                   throws DocGeneratorAPIException

Add a default menu item.

Parameters:: menu - the menu; type - the item type; desc - the item description (may be null)
Returns:: the default menu item
Throws:: DocGeneratorAPIException

addInternalMenuItem

public InternalMenuItem addInternalMenuItem(XMLMenu menu,
                                            java.lang.String refID,
                                            java.lang.String desc)

Add an internal menu item to a menu.

Parameters:: menu - the menu; refID - the id of the referenced element; desc - the description of the menu item
Returns:: the menu item

addInternalMenuItem

public InternalMenuItem addInternalMenuItem(XMLMenu menu,
                                            XMLParentArticle article)

Add an internal menu item to a menu.

Parameters:: menu - the menu; article - the referenced article
Returns:: the menu item

addInternalMenuItem

public InternalMenuItem addInternalMenuItem(XMLMenu menu,
                                            XMLParentArticle article,
                                            java.lang.String desc)

Add an internal menu item to a menu.

Parameters:: menu - the menu; article - the referenced article; desc - the description of the menu item
Returns:: the menu item

addExternalMenuItem

public ExternalMenuItem addExternalMenuItem(XMLMenu menu,
                                            java.lang.String desc,
                                            java.net.URL url)

Add an external menu item to a menu.

Parameters:: menu - the menu; desc - the item description; url - the item url
Returns:: the menu item

addGlossaryMenuItem
```
public DefaultMenuItem addGlossaryMenuItem(XMLMenu menu,
                                           java.lang.String desc)
```
Add an glossary menu item to a menu.

Parameters:

menu - the menu

desc - the description of the menu item

Returns:

the menu item

addExternalMenuItem

public ExternalMenuItem addExternalMenuItem(XMLMenu menu,
                                            java.net.URL url,
                                            java.lang.String desc)

Add an external menu item to a menu.

Parameters:: menu - the menu; url - the url; desc - the description of the menu item
Returns:: the menu item

createHeader
```
public XMLHeader createHeader()
```
Create the wiki header. Note that if you call this method twice, the first created header will be returned.

Returns:

the wiki header

setHeader
```
public boolean setHeader(java.lang.String content)
```
Set the header of the wiki.

Parameters:

content - the header content

Returns:

true if the model exists

setFooter
```
public boolean setFooter(java.lang.String content)
```
Set the footer of the wiki.

Parameters:

content - the footer content

Returns:

true if the model exists

createFooter
```
public XMLFooter createFooter()
```
Create the wiki footer. Note that if you call this method twice, the first created footer will be returned.

Returns:

the wiki footer

createArticle
```
public XMLArticle createArticle(java.lang.String desc)
```
Creates an article.

Parameters:

desc - the article description

Returns:

the article

getArticle
```
public XMLParentArticle getArticle(java.lang.String desc)
```
Return the article of a specified description.

Parameters:

desc - the article description

Returns:

the article

getXMLArticle
```
public XMLArticle getXMLArticle(java.lang.String desc)
```
Return the article of a specified description.

Parameters:

desc - the article description

Returns:

the article

getOpaqueArticle
```
public OpaqueArticle getOpaqueArticle(java.lang.String desc)
```
Return the opaque article of a specified description.

Parameters:

desc - the article description

Returns:

the article

createArticle
```
public XMLArticle createArticle(java.lang.String desc,
                                java.lang.String... categories)
```
Creates an article, belonging to one or several categories.

Parameters:

desc - the article description

categories - the categories on which the article belong

Returns:

the article

createArticle
```
public XMLArticle createArticle(java.lang.String desc,
                                boolean hasTOC,
                                boolean keepCase)
```
Creates an article.

Parameters:

desc - the article description

hasTOC - true if the article has a table of contents

keepCase - true if the title of the article case is kept

Returns:

the article

importImageDefinition
```
public boolean importImageDefinition(java.net.URL url)
                              throws DocGeneratorAPIException
```
Import an Image definition XML url to the model.

Parameters:

url - the Image definition XML URL

Returns:

true if the file could be imported

Throws:

DocGeneratorAPIException

importImageDefinition
```
public boolean importImageDefinition(java.io.File file)
                              throws DocGeneratorAPIException
```
Import an Image definition XML file to the model.

Parameters:

file - the Image definition XML file

Returns:

true if the file could be imported

Throws:

DocGeneratorAPIException

importArticle
```
public XMLArticle importArticle(java.net.URL url)
                         throws DocGeneratorAPIException
```
Import an article and add this article to the model.

Parameters:

url - the article url

Returns:

the article

Throws:

DocGeneratorAPIException - if the parsing thhrows exceptions

importArticle
```
public XMLArticle importArticle(java.io.File file)
                         throws DocGeneratorAPIException
```
Import an article and add this article to the model.

Parameters:

file - the article file

Returns:

the article

Throws:

DocGeneratorAPIException - if the parsing thhrows exceptions

includeArticle
```
public XMLArticle includeArticle(XMLArticle parentArticle,
                                 java.net.URL url,
                                 boolean keepLevels)
                          throws DocGeneratorAPIException
```
Include an article in another parent article.

Parameters:

parentArticle - the article in which to include the other article

url - the article url

keepLevels - true if the numebring of the included afrticle must be kept

Returns:

the article

Throws:

DocGeneratorAPIException - if the parsing thhrows exceptions

includeArticle
```
public XMLArticle includeArticle(XMLArticle parentArticle,
                                 java.io.File file,
                                 boolean keepLevels)
                          throws DocGeneratorAPIException
```
Include an article in another parent article.

Parameters:

parentArticle - the article in which to include the other article

file - the article file

keepLevels - true if the numebring of the included afrticle must be kept

Returns:

the article

Throws:

DocGeneratorAPIException - if the parsing thhrows exceptions

includeArticle
```
public void includeArticle(XMLArticle parentArticle,
                           XMLArticle includedArticle,
                           boolean keepLevels)
```
Import an article and add this article to the model.

Parameters:

parentArticle - the article in which to include the article

includedArticle - the included article

keepLevels - true if the numebring of the included afrticle must be kept

createArticle
```
public XMLArticle createArticle(java.lang.String desc,
                                boolean hasTOC,
                                boolean keepCase,
                                java.lang.String... categories)
```
Creates an article.

Parameters:

desc - the article description

hasTOC - true if the article has a table of contents

keepCase - true if the title of the article case is kept

categories - the categories on which the article belong

Returns:

the article

createOpaqueArticle
```
public OpaqueArticle createOpaqueArticle(java.lang.String desc)
```
Creates an opaque article.

Parameters:

desc - the article description

Returns:

the article

createOpaqueArticle
```
public OpaqueArticle createOpaqueArticle(java.lang.String desc,
                                         boolean keepCase)
```
Creates an opaque article, belonging to one or several categories.

Parameters:

desc - the article description

keepCase - true if the title of the article case is kept

Returns:

the article

createOpaqueArticle
```
public OpaqueArticle createOpaqueArticle(java.lang.String desc,
                                         boolean keepCase,
                                         java.lang.String... categories)
```
Creates an opaque article, belonging to one or several categories.

Parameters:

desc - the article description

keepCase - true if the title of the article case is kept

categories - the categories on which the article belong

Returns:

the article

addAlternateTitle
```
public void addAlternateTitle(XMLArticle article,
                              java.lang.String text,
                              boolean keepCase,
                              boolean inDictionnary)
```
Adds an alternate title to an article.

Parameters:

article - the article

text - the alternate title text

keepCase - true if the alternate title case is kept

inDictionnary - true if the alternate title must be added in the dictionnary

setMeta

public void setMeta(XMLArticle article,
                    java.lang.String meta)

Set the meta of an article.

Parameters:: article - the article; meta - the meta

addTitle

public XMLTitle addTitle(XMLArticle article,
                         ParagraphElementParent parent,
                         java.lang.String title)

Add a title for the article, at level 1.

Parameters:: article - the article; parent - the paragraph parent; title - the title text
Returns:: the title

addTitle
```
public XMLTitle addTitle(XMLArticle article,
                         java.lang.String title)
```
Add a title for the article, at the default level (1).

Parameters:

article - the article

title - the title text

Returns:

the title

addTitle

public XMLTitle addTitle(XMLArticle article,
                         int level,
                         java.lang.String title)

Add a title for the article.

Parameters:: article - the article; level - the title level; title - the title text
Returns:: the title

addTitle

public XMLTitle addTitle(XMLArticle article,
                         ParagraphElementParent parent,
                         int level,
                         java.lang.String title,
                         boolean keepCase)

Add a title for the article.

Parameters:: article - the article; parent - the paragraph parent; level - the title level; title - the title text; keepCase - true if the case should be kept
Returns:: the title

addTitle

public XMLTitle addTitle(XMLArticle article,
                         int level,
                         java.lang.String title,
                         boolean keepCase)

Add a title for the article.

Parameters:: article - the article; level - the title level; title - the title text; keepCase - true if the case should be kept
Returns:: the title

addTitle

public XMLTitle addTitle(XMLArticle article,
                         int level,
                         java.lang.String title,
                         boolean keepCase,
                         boolean isSearchable)

Add a title for the article.

Parameters:: article - the article; level - the title level; title - the title text; keepCase - true if the case should be kept; isSearchable - true if the title is searchable
Returns:: the title

addTitle

public XMLTitle addTitle(XMLArticle article,
                         ParagraphElementParent parent,
                         int level,
                         java.lang.String title,
                         boolean keepCase,
                         boolean isSearchable)

Add a title for the article.

Parameters:: article - the article; parent - the paragraph parent; level - the title level; title - the title text; keepCase - true if the case should be kept; isSearchable - true if the title is searchable
Returns:: the title

addSeeAlso
```
public void addSeeAlso(XMLArticle article,
                       java.lang.String ref)
```
Add a seeAlso for the article.

Parameters:

article - the article

ref - the see also reference

addSeeAlso

public void addSeeAlso(XMLArticle article,
                       java.lang.String ref,
                       java.lang.String desc)

Add a seeAlso for the article.

Parameters:: article - the article; ref - the see also reference; desc - the seeAlso description

addSeeAlso

public void addSeeAlso(XMLArticle article,
                       XMLArticle seeAlsoArticle)

Add a seeAlso for the article.

Parameters:: article - the article; seeAlsoArticle - the see also article

addSeeAlso

public void addSeeAlso(XMLArticle article,
                       XMLArticle seeAlsoArticle,
                       java.lang.String desc)

Add a seeAlso for the article.

Parameters:: article - the article; seeAlsoArticle - the see also article; desc - the seeAlso description

setCategories
```
public boolean setCategories(XMLArticle article,
                             java.lang.String... categories)
```
Set the categories for an article.

Parameters:

article - the article

categories - the categories

Returns:

true if the model exists

addParagraph
```
public XMLParagraph addParagraph(XMLParent parent)
```
Add a paragraph.

Parameters:

parent - the parent

Returns:

the paragraph

getLastParagraph
```
public AbstractParagraph getLastParagraph(XMLParent parent)
```
Return the ladt paragraph of an elemen, or creates one paragraph if it does not exist.

Parameters:

parent - the parent

Returns:

the paragraph

getOrCreateLastParagraphParent
```
public ParagraphElementParent getOrCreateLastParagraphParent(XMLArticle article)
```
Return the last paragraph parent for an article, or create one if it does not exist.

Parameters:

article - the article

Returns:

last paragraph parent

addBreak

public void addBreak(ParagraphElementParent parent)

Add a break.

Parameters:: parent - the parent

addBreak
```
public void addBreak(XMLArticle article)
```
Add a break, at the end of an article.

Parameters:

article - the article

addEmptyLine

public void addEmptyLine(ParagraphElementParent parent)

Add an empty line.

Parameters:: parent - the parent

addEmptyLine
```
public void addEmptyLine(XMLArticle article)
```
Add an empty line, at the end of an article.

Parameters:

article - the article

addTab

public void addTab(ParagraphElementParent parent)

Add an tabulation.

Parameters:: parent - the parent

addTab
```
public void addTab(XMLArticle article)
```
Add an tabulation.

Parameters:

article - the article

addSentence
```
public XMLSentence addSentence(XMLArticle article,
                               java.lang.String text)
```
Add a sentence, at the end of an article.

Parameters:

article - the article

text - the sentence text

Returns:

the sentence

addSentence

public XMLSentence addSentence(ParagraphElementParent parent,
                               java.lang.String text)

Add a sentence.

Parameters:: parent - the parent; text - the sentence text
Returns:: the sentence

addSentence

public XMLSentence addSentence(ParagraphElementParent parent,
                               java.lang.String text,
                               int type)

Add a sentence.

Parameters:: parent - the parent; text - the sentence text; type - the sentence type
Returns:: the sentence

addSentence

public XMLSentence addSentence(XMLArticle article,
                               java.lang.String text,
                               SentenceStyle style)

Add a sentence, setting also its style, at the end of an article.

Parameters:: article - the article; text - the sentence text; style - the sentence style
Returns:: the sentence

addSentence

public XMLSentence addSentence(ParagraphElementParent parent,
                               java.lang.String text,
                               SentenceStyle style)

Add a sentence, setting also its style.

Parameters:: parent - the parent; text - the sentence text; style - the sentence style
Returns:: the sentence

addMultilineSentence
```
public void addMultilineSentence(XMLArticle article,
                                 java.lang.String text)
```
Add a multiline sentence, at the end of an article.

Parameters:

article - the article

text - the sentence text

addMultilineSentence

public void addMultilineSentence(ParagraphElementParent parent,
                                 java.lang.String text)

Add a multiline sentence.

Parameters:: parent - the parent; text - the sentence text

addMultilineSentence

public void addMultilineSentence(ParagraphElementParent parent,
                                 java.lang.String text,
                                 int type)

Add a multiline sentence.

Parameters:: parent - the parent; text - the sentence text; type - the sentence type

addMultilineSentence

public void addMultilineSentence(XMLArticle article,
                                 java.lang.String text,
                                 SentenceStyle style)

Add a multiline sentence, setting also its style, at the end of an article.

Parameters:: article - the article; text - the sentence text; style - the sentence style

addMultilineSentence

public void addMultilineSentence(ParagraphElementParent parent,
                                 java.lang.String text,
                                 SentenceStyle style)

Add a multiline sentence, setting also its style.

Parameters:: parent - the parent; text - the sentence text; style - the sentence style

addAnchor

public XMLAnchor addAnchor(XMLTextStyle textStyle,
                           java.lang.String anchorID,
                           java.lang.String text)

addTextStyle

public XMLTextStyle addTextStyle(XMLArticle article,
                                 SentenceStyle style)

Add a text style, at the end of an article.

Parameters:: article - the article; style - the sentence style
Returns:: the sentence

addSentence

public XMLSentence addSentence(XMLTextStyle textStyle,
                               java.lang.String text)

Add a sentence in a text style.

Parameters:: textStyle - the text style; text - the text
Returns:: the sentence

addTextStyle

public XMLTextStyle addTextStyle(ParagraphElementParent parent,
                                 SentenceStyle style)

Add a text style.

Parameters:: parent - the parent; style - the sentence style
Returns:: the sentence

addAnchor

public XMLAnchor addAnchor(XMLArticle article,
                           ParagraphElementParent parent,
                           java.lang.String anchorID,
                           java.lang.String text)

Add an anchor.

Parameters:: article - the article; parent - the parent; anchorID - the anchor ID; text - the anchor text
Returns:: the reference

addAnchor

public XMLAnchor addAnchor(XMLArticle article,
                           ParagraphElementParent parent,
                           java.lang.String anchorID,
                           java.lang.String text,
                           int type)

Add an anchor.

Parameters:: article - the article; parent - the parent; anchorID - the anchor ID; text - the anchor text; type - the anchor text type
Returns:: the reference

addAnchor

public XMLAnchor addAnchor(XMLArticle article,
                           java.lang.String anchorID,
                           java.lang.String text)

Add an anchor at the end of an article.

Parameters:: article - the article; anchorID - the anchor ID; text - the anchor text
Returns:: the reference

addAnchor

public XMLAnchor addAnchor(XMLArticle article,
                           java.lang.String anchorID,
                           java.lang.String text,
                           int type)

Add an anchor at the end of an article.

Parameters:: article - the article; anchorID - the anchor ID; text - the anchor text; type - the anchor text type
Returns:: the reference

addList
```
public XMLList addList(XMLArticle article,
                       boolean isUL)
```
Add a list at the end of an article.

Parameters:

article - the article

isUL - true for a "ul" list

Returns:

the list

addList

public XMLList addList(ParagraphElementParent parent,
                       boolean isUL)

Add a list.

Parameters:: parent - the parent; isUL - true for a "ul" list
Returns:: the list

addListItem
```
public XMLListItem addListItem(XMLList list)
```
Add a list item to a list.

Parameters:

list - the list

Returns:

the list item

addListItem

public XMLListItem addListItem(XMLList list,
                               java.lang.String sentence)

Add a list item to a list.

Parameters:: list - the list; sentence - the sentence
Returns:: the list item

addListItem

public XMLListItem addListItem(XMLList list,
                               java.lang.String sentence,
                               SentenceStyle style)

Add a list item to a list.

Parameters:: list - the list; sentence - the sentence; style - the sentence style
Returns:: the list item

addTable
```
public XMLTable addTable(XMLArticle article)
```
Add a not sortable table at the end of an article.

Parameters:

article - the article

Returns:

the reference

addTable
```
public XMLTable addTable(XMLArticle article,
                         boolean isSortable)
```
Add a table at the end of an article.

Parameters:

article - the article

isSortable - true if the table is sortable

Returns:

the reference

addTable

public XMLTable addTable(XMLArticle article,
                         ParagraphElementParent parent,
                         boolean isSortable)

Add a table.

Parameters:: article - the article; parent - the parent; isSortable - true if the table is sortable
Returns:: the reference

setTableHeader
```
public XMLTableHeader setTableHeader(XMLTable table,
                                     boolean isVertical)
```
Set a table header.

Parameters:

table - the table

isVertical - true for vertical headers

Returns:

the table header

addTableColumn

public XMLTableColumn addTableColumn(XMLTable table,
                                     java.lang.String title)

Add a table column.

Parameters:: table - the table; title - the colum title
Returns:: the table column

addTableColumn

public XMLTableColumn addTableColumn(XMLTable table,
                                     java.lang.String title,
                                     SentenceStyle style)

Add a table column.

Parameters:: table - the table; title - the column title; style - the column sentence style
Returns:: the table column

addTableColumn
```
public XMLTableColumn addTableColumn(XMLTable table)
```
Add a table column.

Parameters:

table - the table

Returns:

the table column

addTableRow
```
public XMLTableRow addTableRow(XMLTable table)
```
Add a table row.

Parameters:

table - the table

Returns:

the table row

addTableRow

public XMLSizedTableRow addTableRow(XMLTable table,
                                    boolean relWidths,
                                    int... widths)

Add a table row with specified widths.

Parameters:: table - the table; relWidths - true for relative widths; widths - the row widths
Returns:: the table row

addTableCell
```
public XMLTableCell addTableCell(XMLTableRow trow)
```
Add a table cell.

Parameters:

trow - the table row

Returns:

the table cell

addTableCell

public XMLTableCell addTableCell(XMLTableRow trow,
                                 java.lang.String sentence)

Add a table cell.

Parameters:: trow - the table row; sentence - the cell sentence
Returns:: the table cell

addTableCell

public XMLTableCell addTableCell(XMLTableRow trow,
                                 java.lang.String sentence,
                                 SentenceStyle style)

Add a table cell.

Parameters:: trow - the table row; sentence - the cell sentence; style - the sentence style
Returns:: the table cell

addSentence

public XMLSentence addSentence(ParagraphElementParent parent,
                               java.lang.String text,
                               int type,
                               int size)

Add a sentence.

Parameters:: parent - the parent; text - the text; type - the sentence type; size - the sentence size
Returns:: the sentence

addSentence

public XMLSentence addSentence(XMLArticle article,
                               java.lang.String text,
                               int type,
                               int size)

Add a sentence.

Parameters:: article - the article; text - the text; type - the sentence type; size - the sentence size
Returns:: the sentence

addSentence

public XMLSentence addSentence(XMLArticle article,
                               java.lang.String text,
                               int type)

Add a sentence.

Parameters:: article - the article; text - the text; type - the sentence type
Returns:: the sentence

addExternalLink

public XMLExternalLink addExternalLink(ParagraphElementParent parent,
                                       java.net.URL url,
                                       java.lang.String desc)

Add an external link.

Parameters:: parent - the parent; url - the URL; desc - the link description
Returns:: the external link

addExternalLink

public XMLExternalLink addExternalLink(XMLArticle article,
                                       java.net.URL url,
                                       java.lang.String desc)

Add an external link.

Parameters:: article - the article; url - the URL; desc - the link description
Returns:: the external link

addReference

public XMLReference addReference(XMLArticle article,
                                 ParagraphElementParent parent,
                                 java.lang.String refID)

Add a reference.

Parameters:: article - the article; parent - the parent; refID - the reference ID
Returns:: the reference

addReference
```
public XMLReference addReference(XMLArticle article,
                                 java.lang.String refID)
```
Add a reference at the end of an article.

Parameters:

article - the article

refID - the reference ID

Returns:

the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 ParagraphElementParent parent,
                                 java.lang.String refID,
                                 java.lang.String desc)

Add a reference.

Parameters:: article - the article; parent - the parent; refID - the reference ID; desc - the reference description
Returns:: the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 java.lang.String refID,
                                 java.lang.String desc)

Add a reference at the end of an article.

Parameters:: article - the article; refID - the reference ID; desc - the reference description
Returns:: the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 ParagraphElementParent parent,
                                 XMLParentArticle refArticle)

Add a reference.

Parameters:: article - the article; parent - the parent; refArticle - the reference article
Returns:: the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 XMLParentArticle refArticle)

Add a reference at the end of an article.

Parameters:: article - the article; refArticle - the reference article
Returns:: the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 ParagraphElementParent parent,
                                 XMLParentArticle refArticle,
                                 java.lang.String desc)

Add a reference.

Parameters:: article - the article; parent - the parent; refArticle - the reference article; desc - the reference description
Returns:: the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 XMLParentArticle refArticle,
                                 java.lang.String desc)

Add a reference at the end of an article.

Parameters:: article - the article; refArticle - the reference article; desc - the reference description
Returns:: the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 ParagraphElementParent parent,
                                 AnchorElement anchor)

Add a reference.

Parameters:: article - the article; parent - the parent; anchor - the reference anchor
Returns:: the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 AnchorElement anchor)

Add a reference at the end of an article.

Parameters:: article - the article; anchor - the reference anchor
Returns:: the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 ParagraphElementParent parent,
                                 AnchorElement anchor,
                                 java.lang.String desc)

Add a reference.

Parameters:: article - the article; parent - the parent; anchor - the anchor; desc - the reference description
Returns:: the reference

addReference

public XMLReference addReference(XMLArticle article,
                                 AnchorElement anchor,
                                 java.lang.String desc)

Add a reference at the end of an article.

Parameters:: article - the article; anchor - the anchor; desc - the reference description
Returns:: the reference

addImage

public XMLImage addImage(org.docgene.model.globals.XMLRootElement element,
                         ParagraphElementParent parent,
                         java.lang.String imageID,
                         boolean br)

Add an image.

Parameters:: element - the root element; parent - the parent; imageID - the image id; br - true if the image must be added in a new line
Returns:: the image

addImage
```
public XMLImage addImage(XMLArticle article,
                         java.lang.String imageID,
                         boolean br)
```
Add an image at the end of an article.

Parameters:

article - the article

imageID - the image id

br - true if the image must be added in a new line

Returns:

the image

addImage

public XMLImage addImage(org.docgene.model.globals.XMLRootElement element,
                         ParagraphElementParent parent,
                         java.awt.image.BufferedImage bimg,
                         boolean br)

Add an image.

Parameters:: element - the root element; parent - the parent; bimg - the image; br - true if the image must be added in a new line
Returns:: the image

addImage
```
public XMLImage addImage(XMLArticle article,
                         java.awt.image.BufferedImage bimg,
                         boolean br)
```
Add an image at the end of an article.

Parameters:

article - the article

bimg - the image

br - true if the image must be added in a new line

Returns:

the image

addImage

public XMLImage addImage(org.docgene.model.globals.XMLRootElement element,
                         ParagraphElementParent parent,
                         java.io.File imageFile,
                         boolean br)

Add an image.

Parameters:: element - the root element; parent - the parent; imageFile - the image File; br - true if the image must be added in a new line
Returns:: the image

addImage

public XMLImage addImage(org.docgene.model.globals.XMLRootElement element,
                         ParagraphElementParent parent,
                         java.net.URL url,
                         boolean br)

Add an image.

Parameters:: element - the root element; parent - the parent; url - the image URL; br - true if the image must be added in a new line
Returns:: the image

addImage
```
public XMLImage addImage(XMLArticle article,
                         java.io.File imageFile,
                         boolean br)
```
Add an image at the end of an article.

Parameters:

article - the article

imageFile - the image File

br - true if the image must be added in a new line

Returns:

the image

addImage
```
public XMLImage addImage(XMLArticle article,
                         java.net.URL url,
                         boolean br)
```
Add an image at the end of an article.

Parameters:

article - the article

url - the image URL

br - true if the image must be added in a new line

Returns:

the image

setCustomStyles

public void setCustomStyles(StyledElement element,
                            java.lang.String styleClass,
                            java.lang.String style)

Set the custom styles for an element.

Parameters:: element - the element; styleClass - the style class; style - the style

setOutputDirectory
```
public boolean setOutputDirectory(java.net.URL outputDir)
```
Set the output directory.

Parameters:

outputDir - the directory

Returns:

true if the provided file is a directory

setOutputDirectory
```
public boolean setOutputDirectory(java.io.File outputDir)
```
Set the output directory.

Parameters:

outputDir - the directory

Returns:

true if the provided file is a directory

getOutputDirectory
```
public java.io.File getOutputDirectory()
```
Return the output directory.

Returns:

the output directory

setSearch
```
public void setSearch(short searchType)
```
Set the search type.

Parameters:

searchType - the search type

See Also:

SearchOptions

setLocale
```
public boolean setLocale(java.lang.String locale)
```
Set the localization.

Parameters:

locale - the locale

Returns:

true if the locale exists

See Also:

Localization

setFullTextSearch
```
public void setFullTextSearch(boolean isEnabled,
                              int compressionLevel)
```
Configure the full text search.

Parameters:

isEnabled - true if the full text search is enabled

compressionLevel - the compression level, from 0 to 2

setOutputType
```
public boolean setOutputType(java.lang.String outputType)
```
Set the output type of the wiki.

Parameters:

outputType - the output type

Returns:

true if the output type is valid and supported

See Also:

APIOutputTypes

writeContent

public void writeContent()
                  throws DocGeneratorAPIException

Write the wiki content.

Throws:: DocGeneratorAPIException

writeContent
```
public void writeContent(boolean clean)
                  throws DocGeneratorAPIException
```
Write the wiki content.

Parameters:

clean - true if the content of the output directory must be cleaned prior to the writing

Throws:

DocGeneratorAPIException

hasGenerationExceptions
```
public boolean hasGenerationExceptions()
```
Return true if the resolving triggered parsing or consistency exceptions.

Returns:

true if the resolving triggered parsing or consistency exceptions

getGenerationExceptions
```
public java.util.List<org.mdiutil.xml.ResolverSAXHandler.ExceptionResult> getGenerationExceptions()
```
Return the parsing or consistency exceptions.

Returns:

the parsing or consistency exceptions

showGenerationExceptions
```
public void showGenerationExceptions()
```
Show the parsing or consistency exceptions.

Class DocGeneratorAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocGeneratorAPI

DocGeneratorAPI

Method Detail

clear

getConfiguration

resetConfiguration

getCustomSearchCategories

createModel

setIndexGenerationType

setResourcesGenerationType

createCategory

createCategory

getModel

setDefaultFontSize

getDefaultFontSize

setDefaultFontFace

getDefaultFontFace

getIndex

getMenus

cleanGlobalLeftMenu

addDefaultMenuItem

addDefaultMenuItem

addInternalMenuItem

addInternalMenuItem

addInternalMenuItem

addExternalMenuItem

addGlossaryMenuItem

addExternalMenuItem

createHeader

setHeader

setFooter

createFooter

createArticle

getArticle

getXMLArticle

getOpaqueArticle

createArticle

createArticle

importImageDefinition

importImageDefinition

importArticle

importArticle

includeArticle

includeArticle

includeArticle

createArticle

createOpaqueArticle

createOpaqueArticle

createOpaqueArticle

addAlternateTitle

setMeta

addTitle

addTitle

addTitle

addTitle

addTitle

addTitle

addTitle

addSeeAlso

addSeeAlso

addSeeAlso

addSeeAlso

setCategories

addParagraph

getLastParagraph

getOrCreateLastParagraphParent

addBreak

addBreak

addEmptyLine

addEmptyLine

addTab

addTab

addSentence

addSentence

addSentence