Skip navigation links
A B C D E F G H I J L M N O P R S T U V W X Y 

A

ABOUT - Static variable in class org.docgene.model.globals.Localization
"about": The name for the "The article is about" text.
AbstractAPI - Class in org.docgene.model
A general API link.
AbstractAPI() - Constructor for class org.docgene.model.AbstractAPI
 
AbstractJustifiedElement - Class in org.docgene.model
A ParagraphElement which can be justified depending on if it is the first in its line.
AbstractJustifiedElement() - Constructor for class org.docgene.model.AbstractJustifiedElement
 
AbstractLink - Class in org.docgene.model
An abstract Link.
AbstractLink() - Constructor for class org.docgene.model.AbstractLink
 
AbstractMenuItem - Class in org.docgene.model.globals
Represent a menu item on a left menu in an article, or any other page in the HTML wiki.
AbstractMenuItem(String) - Constructor for class org.docgene.model.globals.AbstractMenuItem
Constructor.
AbstractMoreInfoRef - Class in org.docgene.model
Represent an "info" or "moreInfo" reference.
AbstractMoreInfoRef(Article) - Constructor for class org.docgene.model.AbstractMoreInfoRef
Constructor.
AbstractMoreInfoRef(Article, String, String) - Constructor for class org.docgene.model.AbstractMoreInfoRef
Constructor.
AbstractParagraph - Class in org.docgene.model
Represent the content of a paragraph.
AbstractParagraph() - Constructor for class org.docgene.model.AbstractParagraph
 
AbstractStylableText - Class in org.docgene.model
A text which may have a decoration.
AbstractStylableText() - Constructor for class org.docgene.model.AbstractStylableText
Constructor.
AbstractStyledElement - Class in org.docgene.model
An element with custom styles.
AbstractStyledElement() - Constructor for class org.docgene.model.AbstractStyledElement
 
AbstractWikiLink - Class in org.docgene.model
An abstract wiki link.
AbstractWikiLink() - Constructor for class org.docgene.model.AbstractWikiLink
 
AbstractXMLAPIDoc - Class in org.docgene.model
A general API documentation.
AbstractXMLAPIDoc(APIDoc.Element) - Constructor for class org.docgene.model.AbstractXMLAPIDoc
 
AbstractXMLParent - Class in org.docgene.model
An abstract XMLParent.
AbstractXMLParent() - Constructor for class org.docgene.model.AbstractXMLParent
 
AbstractXMLParentArticle - Class in org.docgene.model
An abstract XMLParent article.
AbstractXMLParentArticle() - Constructor for class org.docgene.model.AbstractXMLParentArticle
 
acceptArguments() - Method in class org.docgene.model.XMLIncludedAPIMember
Return true if the member accept arguments declaration.
acceptDependency(String, String) - Method in class org.docgene.model.globals.ArticlesModel
Return true if dependencies betwen two packages are accepted.
acceptExtension() - Method in class org.docgene.model.XMLExtendedImage
Return true if the image accept an extension (whichc an be an ImageMap, a reference, or an external link).
acceptExtension() - Method in class org.docgene.model.XMLImage
Return true if the image accept an extension (which an be an ImageMap, a reference, or an external link).
addAlternateTerm(String, boolean) - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Add an alternate term for the Word.
addAlternateTitle(XMLArticle, String, boolean, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Adds an alternate title to an article.
addAlternateTitle(String, boolean, boolean) - Method in interface org.docgene.model.Article
Add an alternate title to the article.
addAlternateTitle(String, boolean, boolean) - Method in class org.docgene.model.OpaqueArticle
Add an alternate title to the article.
addAlternateTitle(String, boolean, boolean) - Method in class org.docgene.model.XMLArticle
Add an alternate title to the article.
addAlternateTitle(String, boolean, boolean) - Method in class org.docgene.model.XMLRawHTMLArticle
Add an alternate title to the article.
addAlternateTitle(String, boolean, boolean) - Method in class org.docgene.model.XMLRedirect
Add an alternate title to the article.
addAnchor(XMLTextStyle, String, String) - Method in class org.docgene.api.DocGeneratorAPI
 
addAnchor(XMLArticle, ParagraphElementParent, String, String) - Method in class org.docgene.api.DocGeneratorAPI
Add an anchor.
addAnchor(XMLArticle, ParagraphElementParent, String, String, int) - Method in class org.docgene.api.DocGeneratorAPI
Add an anchor.
addAnchor(XMLArticle, String, String) - Method in class org.docgene.api.DocGeneratorAPI
Add an anchor at the end of an article.
addAnchor(XMLArticle, String, String, int) - Method in class org.docgene.api.DocGeneratorAPI
Add an anchor at the end of an article.
addAnchor(AnchorElement) - Method in class org.docgene.model.XMLArticle
Add an Anchor to the article.
addArea(ImageMap.Area) - Method in class org.docgene.model.ImageMap
Add an active area on the map.
addArea(ImageMap.Area) - Method in class org.docgene.model.XMLExtendedImage
Add an active area in the image.
addArea(ImageMap.Area) - Method in class org.docgene.model.XMLImage
Do nothing.
addArgument(String, String) - Method in class org.docgene.model.APIMember
Add an argument.
addArticle(Article) - Method in class org.docgene.model.globals.ArticleCategory
Add an article.
addArticle(Article) - Method in class org.docgene.model.globals.ArticlesDictionary
Add an article to the dictionnary.
addArticle(Article, boolean) - Method in class org.docgene.model.globals.ArticlesDictionary
Add an article to the dictionnary.
addArticle(String, boolean, Article) - Method in class org.docgene.model.globals.ArticlesDictionary
Add an article to the dictionnary.
addArticle(Article, String) - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Add an article to the Word.
addArticle(Article, String) - Method in class org.docgene.model.globals.ArticlesModel
Add an article.
addArticle(Article, String, boolean, boolean) - Method in class org.docgene.model.globals.ArticlesModel
Add an article.
addArticleParent(XMLParentArticle) - Method in class org.docgene.model.AbstractXMLParentArticle
Add an article which include this article.
addArticleParent(XMLParentArticle) - Method in class org.docgene.model.OpaqueArticle
 
addArticleParent(XMLParentArticle) - Method in interface org.docgene.model.XMLParentArticle
Add an article which include this article.
addArticleParent(XMLParentArticle) - Method in class org.docgene.model.XMLRawHTMLArticle
 
addArticleToDictionnary(String, Article) - Method in class org.docgene.model.globals.ArticlesModel
Add an article to the dictionnary.
addArticleToDictionnary(Article) - Method in class org.docgene.model.globals.ArticlesModel
Add an article to the dictionnary and categories.
addArticleToPackage(Article) - Method in class org.docgene.model.globals.ArticlesDictionary
Add an article in its corresponding package.This method should only be called if the article is not included by default in the wiki.
addAttribute(String, String) - Method in interface org.docgene.model.HTMLNode
Add an attribute to the HTML node.
addAttribute(String, String) - Method in class org.docgene.model.HTMLNode.Default
Add an attribute to the HTML node.
addAttribute(String, String) - Method in class org.docgene.model.HTMLNode.Empty
 
addBreak(ParagraphElementParent) - Method in class org.docgene.api.DocGeneratorAPI
Add a break.
addBreak(XMLArticle) - Method in class org.docgene.api.DocGeneratorAPI
Add a break, at the end of an article.
addCategoriesFile(CategoriesFile) - Method in class org.docgene.model.globals.ArticlesModel
Add one categories File.
addCategory(ArticleCategory) - Method in class org.docgene.model.globals.ArticlesCategories
Add a category to the model.
addCategory(ArticleCategory) - Method in class org.docgene.model.globals.ArticlesModel
Add a category to the model.
addCategory(String) - Method in class org.docgene.model.OpaqueArticle
Add a category on which this article belongs.
addCategory(String) - Method in class org.docgene.model.XMLArticle
Add a category on which this article belongs.
addCategoryReference(XMLCategoryReference) - Method in class org.docgene.model.XMLExtendedImage
Add a category reference on the image.
addCategoryReference(XMLCategoryReference) - Method in class org.docgene.model.XMLImage
Do nothing.
addCell(XMLTableCell) - Method in class org.docgene.model.XMLTableRow
Add a cell to the table row.
addChapter(XMLChapter) - Method in class org.docgene.model.AbstractXMLParent
Add a chapter.
addChapter(XMLChapter) - Method in class org.docgene.model.OpaqueArticle
 
addChapter(XMLChapter) - Method in class org.docgene.model.XMLArticle
Add a chapter to the article.
addChapter(XMLChapter, boolean, boolean) - Method in class org.docgene.model.XMLArticle
Add a resolved chapter to the article.
addChapter(XMLChapter) - Method in class org.docgene.model.XMLDiv
Do nothing.
addChapter(XMLChapter) - Method in interface org.docgene.model.XMLParent
Add a chapter.
addChapter(XMLChapter) - Method in class org.docgene.model.XMLRawHTMLArticle
 
addChild(HTMLElement) - Method in interface org.docgene.model.HTMLNode
Add a child to the HTML node.
addChild(HTMLElement) - Method in class org.docgene.model.HTMLNode.Default
Add a child to the HTML node.
addChild(HTMLElement) - Method in class org.docgene.model.HTMLNode.Empty
 
addColumn(XMLTableColumn) - Method in class org.docgene.model.XMLTableHeader
Add a column to the header.
addComment(XMLArticle, XMLComment) - Method in class org.docgene.model.globals.ArticlesModel
Add a comment to the comment list.
addComment(XMLComment) - Method in class org.docgene.model.XMLArticle
Add a comment.
addComment(XMLArticle, XMLComment) - Method in class org.docgene.model.XMLCommentList
Add a comment reference.
addConditionElement(ConditionElement<ListElement>) - Method in class org.docgene.model.XMLList
Add a condition element to the list.
addConditionElement(ConditionElement<XMLTableRow>) - Method in class org.docgene.model.XMLTable
Add a condition element to the list.
addConditionElement(ConditionElement<XMLTreeItem>) - Method in class org.docgene.model.XMLTree
Add a condition element to the list.
addDefaultMenuItem(XMLMenu, short) - Method in class org.docgene.api.DocGeneratorAPI
Add a default menu item.
addDefaultMenuItem(XMLMenu, short, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a default menu item.
addDefaultMenuItem(short) - Method in class org.docgene.model.XMLMenu
Add a default menu item to the menu.
addDirectResource(XMLResource) - Method in class org.docgene.model.globals.ArticlesModel
Add a resource directy specified in a "doc-files" directory.
addDisambArticle(XMLDisambArticle) - Method in class org.docgene.model.globals.ArticlesModel
Add a disambiguation article.
addDisambArticle(Article) - Method in class org.docgene.model.XMLDisambArticle
Add an article to the disambiguation list.
addDisambElement(ArticleRef) - Method in class org.docgene.model.XMLDisambArticle
Add a disambiguation element.
addElement(ParagraphElement) - Method in class org.docgene.model.AbstractParagraph
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.AbstractXMLAPIDoc
Add an element.
addElement(ParagraphElement) - Method in interface org.docgene.model.ParagraphElementParent
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLBox
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLChapter
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLCode
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLIfCondition
Add an element.
addElement(E) - Method in class org.docgene.model.XMLIfListCondition
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLIncludedAPI
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLIncludedAPIArgument
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLIncludedAPIMember
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLInfobox
 
addElement(ParagraphElement) - Method in class org.docgene.model.XMLInfobox.BaseProperty
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLList
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLListItem
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLPre
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLTable
 
addElement(ParagraphElement) - Method in class org.docgene.model.XMLTableCell
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLTerm
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLTextStyle
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLTree
Add an element.
addElement(ParagraphElement) - Method in class org.docgene.model.XMLTreeItem
Add an element.
addElementDefinitionFile(ElementDefinitionsFile) - Method in class org.docgene.model.globals.ArticlesModel
Add one elements definition File.
addEmptyCell() - Method in class org.docgene.model.XMLTableRow
Add an empty cell to the table row.
addEmptyLine(ParagraphElementParent) - Method in class org.docgene.api.DocGeneratorAPI
Add an empty line.
addEmptyLine(XMLArticle) - Method in class org.docgene.api.DocGeneratorAPI
Add an empty line, at the end of an article.
addEnumProperty(String, String) - Method in class org.docgene.model.XMLInfobox
Create an enum property of a specified key and adds it to the infobox.
addExternalLink(ParagraphElementParent, URL, String) - Method in class org.docgene.api.DocGeneratorAPI
Add an external link.
addExternalLink(XMLArticle, URL, String) - Method in class org.docgene.api.DocGeneratorAPI
Add an external link.
addExternalLink(XMLExternalLink) - Method in class org.docgene.model.XMLExtendedImage
Add an external link on the image.
addExternalLink(XMLExternalLink) - Method in class org.docgene.model.XMLImage
Do nothing.
addExternalMenuItem(XMLMenu, String, URL) - Method in class org.docgene.api.DocGeneratorAPI
Add an external menu item to a menu.
addExternalMenuItem(XMLMenu, URL, String) - Method in class org.docgene.api.DocGeneratorAPI
Add an external menu item to a menu.
addGlossaryMenuItem(XMLMenu, String) - Method in class org.docgene.api.DocGeneratorAPI
Add an glossary menu item to a menu.
addImage(XMLRootElement, ParagraphElementParent, String, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add an image.
addImage(XMLArticle, String, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add an image at the end of an article.
addImage(XMLRootElement, ParagraphElementParent, BufferedImage, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add an image.
addImage(XMLArticle, BufferedImage, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add an image at the end of an article.
addImage(XMLRootElement, ParagraphElementParent, File, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add an image.
addImage(XMLRootElement, ParagraphElementParent, URL, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add an image.
addImage(XMLArticle, File, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add an image at the end of an article.
addImage(XMLArticle, URL, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add an image at the end of an article.
addImage(ImageDefinition) - Method in class org.docgene.model.globals.ArticlesModel
Add an image resource.
addImageFromHRef() - Method in class org.docgene.model.globals.ArticlesModel
Add an image from a path on the model.
addInclude(XMLInclude) - Method in class org.docgene.model.XMLArticle
Add an included article or template.
addInfo(XMLMoreInfoRef) - Method in class org.docgene.model.XMLMoreInfo
Add a child reference.
addInfobox(InfoboxDefinition) - Method in class org.docgene.model.globals.ArticlesModel
Add an infobox definition.
addInfobox(XMLInfobox) - Method in class org.docgene.model.XMLArticle
Add an infobox.
addInternalMenuItem(XMLMenu, String, String) - Method in class org.docgene.api.DocGeneratorAPI
Add an internal menu item to a menu.
addInternalMenuItem(XMLMenu, XMLParentArticle) - Method in class org.docgene.api.DocGeneratorAPI
Add an internal menu item to a menu.
addInternalMenuItem(XMLMenu, XMLParentArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add an internal menu item to a menu.
addItem(XMLTreeItem) - Method in interface org.docgene.model.TreeElement
Add a child element.
addItem(ListElement) - Method in class org.docgene.model.XMLList
Add a list element to the list.
addItem() - Method in class org.docgene.model.XMLList
Add a new item in this list.
addItem(XMLTreeItem) - Method in class org.docgene.model.XMLTree
Add a list element to the list.
addItem(XMLTreeItem) - Method in class org.docgene.model.XMLTreeItem
Add a tree element to the tree.
addLinkFromArticle(XMLParentArticle) - Method in class org.docgene.model.AbstractXMLParentArticle
Add an article from which there is a reference to this article.
addLinkFromArticle(XMLParentArticle) - Method in class org.docgene.model.OpaqueArticle
 
addLinkFromArticle(XMLParentArticle) - Method in interface org.docgene.model.XMLParentArticle
Add an article from which there is a reference to this article.
addLinkFromArticle(XMLParentArticle) - Method in class org.docgene.model.XMLRawHTMLArticle
Add an article from which there is a reference to this article.
addLinksFrom() - Method in class org.docgene.model.globals.ArticlesModel
Set if the articles must have a "What Links Here" link.
addList(XMLArticle, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add a list at the end of an article.
addList(ParagraphElementParent, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add a list.
addListItem(XMLList) - Method in class org.docgene.api.DocGeneratorAPI
Add a list item to a list.
addListItem(XMLList, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a list item to a list.
addListItem(XMLList, String, SentenceStyle) - Method in class org.docgene.api.DocGeneratorAPI
Add a list item to a list.
addMap(XMLMap) - Method in class org.docgene.model.XMLArticle
Add a Map.
addMenuItem(AbstractMenuItem) - Method in class org.docgene.model.XMLMenu
Add a menu item to the menu.
addMessageBox(XMLMessageBox) - Method in class org.docgene.model.XMLArticle
Add a message box.
addMultilineSentence(XMLArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a multiline sentence, at the end of an article.
addMultilineSentence(ParagraphElementParent, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a multiline sentence.
addMultilineSentence(ParagraphElementParent, String, int) - Method in class org.docgene.api.DocGeneratorAPI
Add a multiline sentence.
addMultilineSentence(XMLArticle, String, SentenceStyle) - Method in class org.docgene.api.DocGeneratorAPI
Add a multiline sentence, setting also its style, at the end of an article.
addMultilineSentence(ParagraphElementParent, String, SentenceStyle) - Method in class org.docgene.api.DocGeneratorAPI
Add a multiline sentence, setting also its style.
addNote(NoteContent) - Method in class org.docgene.model.XMLArticle
Add a note.
addPackage(PackageModel) - Method in class org.docgene.model.globals.ArticlesModel
Add a package.
addPackage(RootDirectory, String) - Method in class org.docgene.model.globals.ArticlesModel
Add a package.
addParagraph(XMLParent) - Method in class org.docgene.api.DocGeneratorAPI
Add a paragraph.
addParagraph(AbstractParagraph) - Method in class org.docgene.model.AbstractXMLParent
Add a paragraph.
addParagraph(AbstractParagraph) - Method in class org.docgene.model.OpaqueArticle
 
addParagraph(AbstractParagraph) - Method in class org.docgene.model.XMLChapter
Add a paragraph.
addParagraph(AbstractParagraph) - Method in class org.docgene.model.XMLDiv
Do nothing.
addParagraph(AbstractParagraph) - Method in interface org.docgene.model.XMLParent
Add a paragraph.
addParagraph(AbstractParagraph) - Method in class org.docgene.model.XMLRawHTMLArticle
 
addParsedArticle(Article) - Method in class org.docgene.model.globals.ArticlesModel
Add a parsed article.
addProperty(String) - Method in class org.docgene.model.XMLInfobox
Create a property of a specified key and adds it to the infobox.
addReference(XMLArticle, ParagraphElementParent, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference.
addReference(XMLArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference at the end of an article.
addReference(XMLArticle, ParagraphElementParent, String, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference.
addReference(XMLArticle, String, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference at the end of an article.
addReference(XMLArticle, ParagraphElementParent, XMLParentArticle) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference.
addReference(XMLArticle, XMLParentArticle) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference at the end of an article.
addReference(XMLArticle, ParagraphElementParent, XMLParentArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference.
addReference(XMLArticle, XMLParentArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference at the end of an article.
addReference(XMLArticle, ParagraphElementParent, AnchorElement) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference.
addReference(XMLArticle, AnchorElement) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference at the end of an article.
addReference(XMLArticle, ParagraphElementParent, AnchorElement, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference.
addReference(XMLArticle, AnchorElement, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a reference at the end of an article.
addReference(ArticleRef) - Method in class org.docgene.model.AbstractXMLParentArticle
Add an article reference.
addReference(XMLParentArticle) - Method in class org.docgene.model.AbstractXMLParentArticle
Add an article reference.
addReference(ArticleRef) - Method in interface org.docgene.model.Article
Add an article reference.
addReference(XMLReference) - Method in class org.docgene.model.XMLExtendedImage
Add a reference on the image.
addReference(XMLReference) - Method in class org.docgene.model.XMLImage
Do nothing.
addReferenceToDisambArticle(ArticleRef, XMLDisambArticle) - Method in class org.docgene.model.globals.ArticlesModel
Add an article reference to the associated disambiguation article.
addResolvedChapter(XMLChapter, boolean) - Method in class org.docgene.model.XMLArticle
Add a resolved chapter to the article.
addResolvedTitle(XMLTitle, boolean) - Method in class org.docgene.model.XMLArticle
Add a resolved title to the article.
addResource(ResourceDefinition) - Method in class org.docgene.model.globals.ArticlesModel
Add a resource.
addRoot(File) - Method in class org.docgene.model.globals.ArticlesModel
Add a root directory.
addRoot(HTMLNode) - Method in interface org.docgene.model.HTMLRootElement
Add a root.
addRow(XMLTableRow) - Method in class org.docgene.model.XMLTable
Add a row to the table.
addSeeAlso(XMLArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a seeAlso for the article.
addSeeAlso(XMLArticle, String, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a seeAlso for the article.
addSeeAlso(XMLArticle, XMLArticle) - Method in class org.docgene.api.DocGeneratorAPI
Add a seeAlso for the article.
addSeeAlso(XMLArticle, XMLArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a seeAlso for the article.
addSeeAlsoReference(XMLSeeAlso) - Method in class org.docgene.model.XMLArticle
Add a SeeAlso reference.
addSentence(XMLArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a sentence, at the end of an article.
addSentence(ParagraphElementParent, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a sentence.
addSentence(ParagraphElementParent, String, int) - Method in class org.docgene.api.DocGeneratorAPI
Add a sentence.
addSentence(XMLArticle, String, SentenceStyle) - Method in class org.docgene.api.DocGeneratorAPI
Add a sentence, setting also its style, at the end of an article.
addSentence(ParagraphElementParent, String, SentenceStyle) - Method in class org.docgene.api.DocGeneratorAPI
Add a sentence, setting also its style.
addSentence(XMLTextStyle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a sentence in a text style.
addSentence(ParagraphElementParent, String, int, int) - Method in class org.docgene.api.DocGeneratorAPI
Add a sentence.
addSentence(XMLArticle, String, int, int) - Method in class org.docgene.api.DocGeneratorAPI
Add a sentence.
addSentence(XMLArticle, String, int) - Method in class org.docgene.api.DocGeneratorAPI
Add a sentence.
addSubListItem(boolean) - Method in class org.docgene.model.XMLList
Add a new list as an item of this list.
addTab(ParagraphElementParent) - Method in class org.docgene.api.DocGeneratorAPI
Add an tabulation.
addTab(XMLArticle) - Method in class org.docgene.api.DocGeneratorAPI
Add an tabulation.
addTable(XMLArticle) - Method in class org.docgene.api.DocGeneratorAPI
Add a not sortable table at the end of an article.
addTable(XMLArticle, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add a table at the end of an article.
addTable(XMLArticle, ParagraphElementParent, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add a table.
addTableCell(XMLTableRow) - Method in class org.docgene.api.DocGeneratorAPI
Add a table cell.
addTableCell(XMLTableRow, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a table cell.
addTableCell(XMLTableRow, String, SentenceStyle) - Method in class org.docgene.api.DocGeneratorAPI
Add a table cell.
addTableColumn(XMLTable, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a table column.
addTableColumn(XMLTable, String, SentenceStyle) - Method in class org.docgene.api.DocGeneratorAPI
Add a table column.
addTableColumn(XMLTable) - Method in class org.docgene.api.DocGeneratorAPI
Add a table column.
addTableRow(XMLTable) - Method in class org.docgene.api.DocGeneratorAPI
Add a table row.
addTableRow(XMLTable, boolean, int...) - Method in class org.docgene.api.DocGeneratorAPI
Add a table row with specified widths.
addTextAfter(String) - Method in class org.docgene.model.XMLSentence
Add characters after the sentence text.
addTextAfter(String) - Method in class org.docgene.model.XMLSpan
Add characters after the sentence text.
addTextBefore(String) - Method in class org.docgene.model.XMLSentence
Add characters before the sentence text.
addTextBefore(String) - Method in class org.docgene.model.XMLSpan
Add characters before the sentence text.
addTextStyle(XMLArticle, SentenceStyle) - Method in class org.docgene.api.DocGeneratorAPI
Add a text style, at the end of an article.
addTextStyle(ParagraphElementParent, SentenceStyle) - Method in class org.docgene.api.DocGeneratorAPI
Add a text style.
addTitle(XMLArticle, ParagraphElementParent, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a title for the article, at level 1.
addTitle(XMLArticle, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a title for the article, at the default level (1).
addTitle(XMLArticle, int, String) - Method in class org.docgene.api.DocGeneratorAPI
Add a title for the article.
addTitle(XMLArticle, ParagraphElementParent, int, String, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add a title for the article.
addTitle(XMLArticle, int, String, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add a title for the article.
addTitle(XMLArticle, int, String, boolean, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add a title for the article.
addTitle(XMLArticle, ParagraphElementParent, int, String, boolean, boolean) - Method in class org.docgene.api.DocGeneratorAPI
Add a title for the article.
addTitle(TitledElement, boolean) - Method in class org.docgene.model.XMLArticle
Add a title to the article.
addTitle(XMLTitle, boolean, boolean) - Method in class org.docgene.model.XMLArticle
Add a resolved title to the article.
addTitle(XMLTitle) - Method in class org.docgene.model.XMLRawHTMLArticle
Add a resolved title to the article.
addTodo(XMLArticle, TodoElement) - Method in class org.docgene.model.globals.ArticlesModel
Add a TODO to the TODO list.
addTodo(TodoElement) - Method in class org.docgene.model.XMLArticle
Add a todo.
addTODO(XMLArticle, TodoElement) - Method in class org.docgene.model.XMLCommentList
Add a comment reference.
addTodo(XMLArticle, TodoElement) - Method in class org.docgene.model.XMLTodoList
Add a TODO reference.
addUnparsableArticle(UnparsableArticle, String) - Method in class org.docgene.model.globals.ArticlesModel
Add an unparsable article.
addUnparsableFile(UnparsableUndefinedFile) - Method in class org.docgene.model.globals.ArticlesModel
Add one unparsable file.
addWord(String, boolean) - Method in class org.docgene.model.globals.ArticlesGlossary
Add an word to the glossary.
addWord(ArticlesGlossary.Word) - Method in class org.docgene.model.globals.ArticlesGlossary.Letter
Add an word to the Letter.
addWordAnchor(XMLWord) - Method in class org.docgene.model.globals.ArticlesGlossary
Add a word anchor.
addWordAnchor(XMLWord) - Method in class org.docgene.model.globals.ArticlesGlossary.Word
Add a word anchor to the word.
Alignment - Interface in org.docgene.model
Represent the alignment.
ALIGNMENT_CENTER - Static variable in interface org.docgene.model.JustifiedElement
The value for elements which are aligned on the center.
ALIGNMENT_INHERIT - Static variable in interface org.docgene.model.JustifiedElement
The value for elements where the alignment inherits from the parent
ALIGNMENT_JUSTIFIED - Static variable in interface org.docgene.model.JustifiedElement
The value for elements which are justified.
ALIGNMENT_LEFT - Static variable in interface org.docgene.model.JustifiedElement
The value for elements which are aligned on the left.
ALIGNMENT_NONE - Static variable in interface org.docgene.model.JustifiedElement
The value for elements which have no alignment.
ALIGNMENT_RIGHT - Static variable in interface org.docgene.model.JustifiedElement
The value for elements which are aligned on the right.
allImageFilter - Variable in class org.docgene.main.Configuration
 
allowAutoDisambiguation(boolean) - Method in class org.docgene.model.globals.ArticlesDictionary
Set if the automatic creation of disambiguation articles is allowed.
allowIdenticalTitleIDs(boolean) - Method in class org.docgene.model.globals.ArticlesModel
Set if if the parser accept identical title IDs(default is true).
allowInvisibleChars() - Method in class org.docgene.model.XMLPre
Return true if the invisible char character is supported.
allowMarkdown(boolean) - Method in class org.docgene.main.Configuration
Set if the Markdown format is accepted for articles.
allowMediawiki(boolean) - Method in class org.docgene.main.Configuration
Set if the Wikipedia Mediawiki format is accepted for articles.
AlternateTitle - Class in org.docgene.model
Represents an alternate title.
AlternateTitle(String, boolean, boolean) - Constructor for class org.docgene.model.AlternateTitle
 
altPath - Variable in class org.docgene.model.AbstractAPI
The alternate API link path.
altText - Variable in class org.docgene.model.AbstractAPI
The API alternate text.
AnchorElement - Interface in org.docgene.model
Represent an anchored element.
AND - Static variable in class org.docgene.model.globals.Localization
"and": The name for the "and" text.
api - Variable in class org.docgene.model.AbstractAPI
The API (may be null is AbstractAPI.location is not null).
api - Variable in class org.docgene.model.AbstractXMLAPIDoc
The API.
api - Variable in class org.docgene.model.XMLIncludedAPI
The API.
API_ATTRIBUTE - Static variable in class org.docgene.model.XMLDoxygenAPI
A link to an attribute.
API_CLASS - Static variable in class org.docgene.model.XMLDotNetAPI
A link to a class.
API_CLASS - Static variable in class org.docgene.model.XMLDoxygenAPI
A link to a class.
API_CLASS - Static variable in class org.docgene.model.XMLPythonAPI
A link to a class.
API_CLASS - Static variable in class org.docgene.model.XMLQtAPI
A link to a class.
API_DELEGATE - Static variable in class org.docgene.model.XMLDotNetAPI
A link to a delegate.
API_ENUM - Static variable in class org.docgene.model.XMLDotNetAPI
A link to an enum.
API_ENUM - Static variable in class org.docgene.model.XMLQtAPI
A link to an enum.
API_METHOD - Static variable in class org.docgene.model.XMLDotNetAPI
A link to a method.
API_METHOD - Static variable in class org.docgene.model.XMLDoxygenAPI
A link to a method.
API_METHOD - Static variable in class org.docgene.model.XMLPythonAPI
A link to a method.
API_METHOD - Static variable in class org.docgene.model.XMLQtAPI
A link to a method.
API_MODULE - Static variable in class org.docgene.model.XMLPythonAPI
A link to a module.
API_PATH_CLASS - Static variable in class org.docgene.model.XMLJavaAPI
The default value, only the class name is presented.
API_PATH_FULL - Static variable in class org.docgene.model.XMLJavaAPI
The full class path is presented.
API_PATH_MEMBER - Static variable in class org.docgene.model.XMLJavaAPI
Only the member is presented.
API_PROPERTY - Static variable in class org.docgene.model.XMLDotNetAPI
A link to a property.
API_PROPERTY - Static variable in class org.docgene.model.XMLQtAPI
A link to a property.
API_STRUCT - Static variable in class org.docgene.model.XMLDoxygenAPI
A link to a struct.
API_STRUCTURE - Static variable in class org.docgene.model.XMLDotNetAPI
A link to a structure.
APIMember - Class in org.docgene.model
An API member declaration.
APIMember(String) - Constructor for class org.docgene.model.APIMember
Constructor.
APIMember.Argument - Class in org.docgene.model
An API member argument.
APIOutputTypes - Interface in org.docgene.api
The wiki output types, including those from the plugins.
Area(short, List<Integer>, XMLReference) - Constructor for class org.docgene.model.ImageMap.Area
Constructor.
argument - Variable in class org.docgene.model.XMLIncludedAPIArgument
The argument.
ARIAL - Static variable in interface org.docgene.api.FontFace
"Arial".
Article - Interface in org.docgene.model
Represents an article interface.
ArticleCategory - Class in org.docgene.model.globals
Represents an article category.
ArticleCategory(ArticlesModel) - Constructor for class org.docgene.model.globals.ArticleCategory
Constructor.
ArticleCategory(ArticlesModel, String) - Constructor for class org.docgene.model.globals.ArticleCategory
Constructor.
articleNameAlreadyTaken() - Method in interface org.docgene.model.Article
Return true if the article name was already taken, and the article was not added in the model.
articleNameAlreadyTaken() - Method in class org.docgene.model.XMLArticle
Return true if the article name was already taken, and the article was not added in the model.
articleNameAlreadyTaken() - Method in class org.docgene.model.XMLRawHTMLArticle
Return true if the article name was already taken, and the article was not added in the model.
ArticleRef - Class in org.docgene.model
Represent the reference of an article.
ArticleRef(Article) - Constructor for class org.docgene.model.ArticleRef
Constructor.
ArticleRef(String) - Constructor for class org.docgene.model.ArticleRef
Constructor.
ArticleRef(String, String) - Constructor for class org.docgene.model.ArticleRef
Constructor.
ArticleReference - Interface in org.docgene.model
An article reference.
ArticlesCategories - Class in org.docgene.model.globals
Represdents the articles categories.
ArticlesCategories(ArticlesModel) - Constructor for class org.docgene.model.globals.ArticlesCategories
 
ArticlesDictionary - Class in org.docgene.model.globals
Maintains the dictionary of articles sorted by their first letter.
ArticlesDictionary(ArticlesModel) - Constructor for class org.docgene.model.globals.ArticlesDictionary
Constructor.
ArticlesDictionary.Letter - Class in org.docgene.model.globals
Represents one Letter in the dictionnary.
ArticlesGlossary - Class in org.docgene.model.globals
Maintains a glossary of terms sorted by their first letter.
ArticlesGlossary(ArticlesModel) - Constructor for class org.docgene.model.globals.ArticlesGlossary
Constructor.
ArticlesGlossary.Letter - Class in org.docgene.model.globals
Represents one Letter in the glossary.
ArticlesGlossary.Word - Class in org.docgene.model.globals
Represents one Word in the glossary.
ArticlesModel - Class in org.docgene.model.globals
Represents the root for the model.
ArticlesModel() - Constructor for class org.docgene.model.globals.ArticlesModel
Constructor.
ArticlesModel(boolean) - Constructor for class org.docgene.model.globals.ArticlesModel
Constructor.
ArticlesModel(boolean, boolean) - Constructor for class org.docgene.model.globals.ArticlesModel
Constructor.
A B C D E F G H I J L M N O P R S T U V W X Y 
Skip navigation links

Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence