| Package | Description |
|---|---|
| org.docgene.api |
This package allows to generate a wiki in another application, using the docGenerator API.
|
| org.docgene.model |
Contains the documentation model.
|
| org.docgene.model.globals |
Contains the global elements for the wiki model.
|
| Modifier and Type | Method and Description |
|---|---|
XMLArticle |
DocGeneratorAPI.createArticle(java.lang.String desc)
Creates an article.
|
XMLArticle |
DocGeneratorAPI.createArticle(java.lang.String desc,
boolean hasTOC,
boolean keepCase)
Creates an article.
|
XMLArticle |
DocGeneratorAPI.createArticle(java.lang.String desc,
boolean hasTOC,
boolean keepCase,
java.lang.String... categories)
Creates an article.
|
XMLArticle |
DocGeneratorAPI.createArticle(java.lang.String desc,
java.lang.String... categories)
Creates an article, belonging to one or several categories.
|
XMLArticle |
DocGeneratorAPI.getXMLArticle(java.lang.String desc)
Return the article of a specified description.
|
XMLArticle |
DocGeneratorAPI.importArticle(java.io.File file)
Import an article and add this article to the model.
|
XMLArticle |
DocGeneratorAPI.importArticle(java.net.URL url)
Import an article and add this article to the model.
|
XMLArticle |
DocGeneratorAPI.includeArticle(XMLArticle parentArticle,
java.io.File file,
boolean keepLevels)
Include an article in another parent article.
|
XMLArticle |
DocGeneratorAPI.includeArticle(XMLArticle parentArticle,
java.net.URL url,
boolean keepLevels)
Include an article in another parent article.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DocGeneratorAPI.addAlternateTitle(XMLArticle article,
java.lang.String text,
boolean keepCase,
boolean inDictionnary)
Adds an alternate title to an article.
|
XMLAnchor |
DocGeneratorAPI.addAnchor(XMLArticle article,
ParagraphElementParent parent,
java.lang.String anchorID,
java.lang.String text)
Add an anchor.
|
XMLAnchor |
DocGeneratorAPI.addAnchor(XMLArticle article,
ParagraphElementParent parent,
java.lang.String anchorID,
java.lang.String text,
int type)
Add an anchor.
|
XMLAnchor |
DocGeneratorAPI.addAnchor(XMLArticle article,
java.lang.String anchorID,
java.lang.String text)
Add an anchor at the end of an article.
|
XMLAnchor |
DocGeneratorAPI.addAnchor(XMLArticle article,
java.lang.String anchorID,
java.lang.String text,
int type)
Add an anchor at the end of an article.
|
void |
DocGeneratorAPI.addBreak(XMLArticle article)
Add a break, at the end of an article.
|
void |
DocGeneratorAPI.addEmptyLine(XMLArticle article)
Add an empty line, at the end of an article.
|
XMLExternalLink |
DocGeneratorAPI.addExternalLink(XMLArticle article,
java.net.URL url,
java.lang.String desc)
Add an external link.
|
XMLImage |
DocGeneratorAPI.addImage(XMLArticle article,
java.awt.image.BufferedImage bimg,
boolean br)
Add an image at the end of an article.
|
XMLImage |
DocGeneratorAPI.addImage(XMLArticle article,
java.io.File imageFile,
boolean br)
Add an image at the end of an article.
|
XMLImage |
DocGeneratorAPI.addImage(XMLArticle article,
java.lang.String imageID,
boolean br)
Add an image at the end of an article.
|
XMLImage |
DocGeneratorAPI.addImage(XMLArticle article,
java.net.URL url,
boolean br)
Add an image at the end of an article.
|
XMLList |
DocGeneratorAPI.addList(XMLArticle article,
boolean isUL)
Add a list at the end of an article.
|
void |
DocGeneratorAPI.addMultilineSentence(XMLArticle article,
java.lang.String text)
Add a multiline sentence, at the end of an article.
|
void |
DocGeneratorAPI.addMultilineSentence(XMLArticle article,
java.lang.String text,
SentenceStyle style)
Add a multiline sentence, setting also its style, at the end of an article.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
AnchorElement anchor)
Add a reference at the end of an article.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
AnchorElement anchor,
java.lang.String desc)
Add a reference at the end of an article.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
AnchorElement anchor)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
AnchorElement anchor,
java.lang.String desc)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
java.lang.String refID)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
java.lang.String refID,
java.lang.String desc)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
XMLParentArticle refArticle)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
XMLParentArticle refArticle,
java.lang.String desc)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
java.lang.String refID)
Add a reference at the end of an article.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
java.lang.String refID,
java.lang.String desc)
Add a reference at the end of an article.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
XMLParentArticle refArticle)
Add a reference at the end of an article.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
XMLParentArticle refArticle,
java.lang.String desc)
Add a reference at the end of an article.
|
void |
DocGeneratorAPI.addSeeAlso(XMLArticle article,
java.lang.String ref)
Add a seeAlso for the article.
|
void |
DocGeneratorAPI.addSeeAlso(XMLArticle article,
java.lang.String ref,
java.lang.String desc)
Add a seeAlso for the article.
|
void |
DocGeneratorAPI.addSeeAlso(XMLArticle article,
XMLArticle seeAlsoArticle)
Add a seeAlso for the article.
|
void |
DocGeneratorAPI.addSeeAlso(XMLArticle article,
XMLArticle seeAlsoArticle,
java.lang.String desc)
Add a seeAlso for the article.
|
XMLSentence |
DocGeneratorAPI.addSentence(XMLArticle article,
java.lang.String text)
Add a sentence, at the end of an article.
|
XMLSentence |
DocGeneratorAPI.addSentence(XMLArticle article,
java.lang.String text,
int type)
Add a sentence.
|
XMLSentence |
DocGeneratorAPI.addSentence(XMLArticle article,
java.lang.String text,
int type,
int size)
Add a sentence.
|
XMLSentence |
DocGeneratorAPI.addSentence(XMLArticle article,
java.lang.String text,
SentenceStyle style)
Add a sentence, setting also its style, at the end of an article.
|
void |
DocGeneratorAPI.addTab(XMLArticle article)
Add an tabulation.
|
XMLTable |
DocGeneratorAPI.addTable(XMLArticle article)
Add a not sortable table at the end of an article.
|
XMLTable |
DocGeneratorAPI.addTable(XMLArticle article,
boolean isSortable)
Add a table at the end of an article.
|
XMLTable |
DocGeneratorAPI.addTable(XMLArticle article,
ParagraphElementParent parent,
boolean isSortable)
Add a table.
|
XMLTextStyle |
DocGeneratorAPI.addTextStyle(XMLArticle article,
SentenceStyle style)
Add a text style, at the end of an article.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
int level,
java.lang.String title)
Add a title for the article.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
int level,
java.lang.String title,
boolean keepCase)
Add a title for the article.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
int level,
java.lang.String title,
boolean keepCase,
boolean isSearchable)
Add a title for the article.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
ParagraphElementParent parent,
int level,
java.lang.String title,
boolean keepCase)
Add a title for the article.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
ParagraphElementParent parent,
int level,
java.lang.String title,
boolean keepCase,
boolean isSearchable)
Add a title for the article.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
ParagraphElementParent parent,
java.lang.String title)
Add a title for the article, at level 1.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
java.lang.String title)
Add a title for the article, at the default level (1).
|
ParagraphElementParent |
DocGeneratorAPI.getOrCreateLastParagraphParent(XMLArticle article)
Return the last paragraph parent for an article, or create one if it does not exist.
|
XMLArticle |
DocGeneratorAPI.includeArticle(XMLArticle parentArticle,
java.io.File file,
boolean keepLevels)
Include an article in another parent article.
|
XMLArticle |
DocGeneratorAPI.includeArticle(XMLArticle parentArticle,
java.net.URL url,
boolean keepLevels)
Include an article in another parent article.
|
void |
DocGeneratorAPI.includeArticle(XMLArticle parentArticle,
XMLArticle includedArticle,
boolean keepLevels)
Import an article and add this article to the model.
|
boolean |
DocGeneratorAPI.setCategories(XMLArticle article,
java.lang.String... categories)
Set the categories for an article.
|
void |
DocGeneratorAPI.setMeta(XMLArticle article,
java.lang.String meta)
Set the meta of an article.
|
| Modifier and Type | Class and Description |
|---|---|
class |
XMLIndex
Represents an XML index article.
|
| Modifier and Type | Method and Description |
|---|---|
XMLArticle |
XMLArticle.getArticle()
Return itself.
|
XMLArticle |
XMLCommentList.ArticleComments.getArticle()
Return the article.
|
XMLArticle |
XMLResource.getArticle()
Return the article in which this resource reference is used.
|
XMLArticle |
XMLTodoList.ArticleTodos.getArticle()
Return the article.
|
XMLArticle |
XMLWord.getArticle()
Return the article.
|
XMLArticle |
XMLCategoryReference.getOriginArticle()
Return the article which emit the reference.
|
XMLArticle |
XMLGlossaryReference.getOriginArticle()
Return the article which emit the reference.
|
XMLArticle |
XMLInclude.getOriginArticle()
Return the article which emit the reference.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XMLCommentList.addComment(XMLArticle article,
XMLComment comment)
Add a comment reference.
|
void |
XMLTodoList.addTodo(XMLArticle article,
TodoElement todo)
Add a TODO reference.
|
void |
XMLCommentList.addTODO(XMLArticle article,
TodoElement todo)
Add a comment reference.
|
| Constructor and Description |
|---|
XMLCategoryReference(XMLArticle article,
java.lang.String catID)
Constructor.
|
XMLGlossaryReference(XMLArticle article)
Constructor.
|
XMLInclude(XMLArticle article,
java.lang.String refID,
java.lang.String pack)
Constructor.
|
XMLResource(XMLArticle article)
Constructor.
|
XMLResource(XMLArticle article,
java.lang.String id,
java.lang.String pack)
Constructor.
|
XMLWord(XMLArticle article)
Constructor.
|
XMLWord(XMLArticle article,
java.lang.String word)
Constructor.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ArticlesGlossary
Maintains a glossary of terms sorted by their first letter.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ArticlesModel.addComment(XMLArticle article,
XMLComment comment)
Add a comment to the comment list.
|
void |
ArticlesModel.addTodo(XMLArticle article,
TodoElement todo)
Add a TODO to the TODO list.
|
Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence