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 |
---|---|
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.
|
Modifier and Type | Interface and Description |
---|---|
interface |
TitledElement
Represent a titled element (chapter of title).
|
Modifier and Type | Class and Description |
---|---|
class |
XMLAnchor
Represent an anchor in an article.
|
class |
XMLChapter
Represents a chapter.
|
class |
XMLNoteRef
Represent the a reference to a note.
|
class |
XMLTerm
Represent the content of a <term> tag.
|
class |
XMLTitle
Represents a title.
|
class |
XMLWord
Represent a word anchor in an article.
|
Modifier and Type | Method and Description |
---|---|
AnchorElement |
XMLArticle.getAnchor(java.lang.String id)
Return the AnchorElement of a specified id (including the included articles or templates).
|
default AnchorElement |
XMLParentArticle.getAnchor(java.lang.String id)
Return the AnchorElement of a specified id (including the included articles or templates).
|
default AnchorElement |
ArticleReference.getAnchorElement()
Return the referenced anchor element.
|
AnchorElement |
XMLRedirect.getAnchorElement()
Return the referenced anchor element.
|
AnchorElement |
XMLReference.getAnchorElement()
Return the referenced anchor element.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,AnchorElement> |
XMLArticle.getAnchorElements()
Return all the anchor elements of the articles sorted by their title.
|
default java.util.Map<java.lang.String,AnchorElement> |
XMLParentArticle.getAnchorElements()
Return all the anchor elements of the articles sorted by their title. return null by default.
|
Modifier and Type | Method and Description |
---|---|
void |
XMLArticle.addAnchor(AnchorElement anchor)
Add an Anchor to the article.
|
default void |
ArticleReference.bind(XMLParentArticle article,
AnchorElement anchor)
Set the referenced article and associated anchor.
|
void |
XMLRedirect.bind(XMLParentArticle article,
AnchorElement anchor)
Set the referenced article and associated chapter or title.
|
void |
XMLReference.bind(XMLParentArticle article,
AnchorElement anchor)
Set the referenced article and associated chapter or title.
|
Modifier and Type | Method and Description |
---|---|
AnchorElement |
ArticlesGlossary.Word.getAnchorElement()
Return the referenced anchor element.
|
Modifier and Type | Method and Description |
---|---|
void |
ArticlesGlossary.Word.bind(XMLParentArticle article,
AnchorElement anchor)
Set the referenced article and associated chapter or title.
|
Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence