Package | Description |
---|---|
org.docgene.api |
This package allows to generate a wiki in another application, using the docGenerator API.
|
org.docgene.main |
Contains the entry point of the application.
|
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 |
---|---|
XMLParentArticle |
DocGeneratorAPI.getArticle(java.lang.String desc)
Return the article of a specified description.
|
Modifier and Type | Method and Description |
---|---|
InternalMenuItem |
DocGeneratorAPI.addInternalMenuItem(XMLMenu menu,
XMLParentArticle article)
Add an internal menu item to a menu.
|
InternalMenuItem |
DocGeneratorAPI.addInternalMenuItem(XMLMenu menu,
XMLParentArticle article,
java.lang.String desc)
Add an internal menu item to a menu.
|
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,
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.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
Configuration.getWikiTitle(XMLParentArticle article)
Return the wiki title, which will be shown in the index page and the articles.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractXMLParentArticle
An abstract XMLParent article.
|
class |
OpaqueArticle
An article which is just an opaque reference.
|
class |
XMLArticle
Represents an XML article.
|
class |
XMLDisambArticle
Represents an XML disambiguation article.
|
class |
XMLFallbackArticle
Represents a fallback article.
|
class |
XMLIndex
Represents an XML index article.
|
class |
XMLRawHTMLArticle
The element for a raw html article.
|
Modifier and Type | Method and Description |
---|---|
XMLParentArticle |
Article.getArticle()
Return the XMLArticle which is really accessed through this Article.
|
XMLParentArticle |
XMLDisambArticle.getArticle()
Return this.
|
XMLParentArticle |
XMLFallbackArticle.getArticle()
Return this.
|
XMLParentArticle |
XMLMap.getArticle()
Return the article in which this Map is used.
|
XMLParentArticle |
XMLMessageBox.getArticle()
Return the article in which this message box is used.
|
XMLParentArticle |
XMLRedirect.getArticle()
Return the XMLArticle which is really accessed through this Article.
|
XMLParentArticle |
ArticleReference.getReferencedArticle()
Return the referenced article.
|
XMLParentArticle |
XMLInclude.getReferencedArticle()
Return the referenced article.
|
XMLParentArticle |
XMLRedirect.getReferencedArticle()
Return the XMLArticle which is really accessed through this Article.
|
XMLParentArticle |
XMLReference.getReferencedArticle()
Return the referenced article.
|
XMLParentArticle |
XMLIndex.getReferToArticle()
Set the article on which the index is referring to.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,XMLParentArticle> |
AbstractXMLParentArticle.getArticleParents()
Return the articles which include this article.
|
java.util.Map<java.lang.String,XMLParentArticle> |
OpaqueArticle.getArticleParents() |
java.util.Map<java.lang.String,XMLParentArticle> |
XMLParentArticle.getArticleParents()
Return the articles which include this article.
|
java.util.Map<java.lang.String,XMLParentArticle> |
XMLRawHTMLArticle.getArticleParents() |
java.util.SortedMap<java.lang.String,XMLParentArticle> |
AbstractXMLParentArticle.getLinksFrom()
Return the articles from which there is a reference to this article.
|
java.util.SortedMap<java.lang.String,XMLParentArticle> |
OpaqueArticle.getLinksFrom() |
java.util.SortedMap<java.lang.String,XMLParentArticle> |
XMLParentArticle.getLinksFrom()
Return the articles from which there is a reference to this article.
|
java.util.SortedMap<java.lang.String,XMLParentArticle> |
XMLRawHTMLArticle.getLinksFrom()
Return the articles from which there is a reference to this article.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractXMLParentArticle.addArticleParent(XMLParentArticle article)
Add an article which include this article.
|
void |
OpaqueArticle.addArticleParent(XMLParentArticle article) |
void |
XMLParentArticle.addArticleParent(XMLParentArticle article)
Add an article which include this article.
|
void |
XMLRawHTMLArticle.addArticleParent(XMLParentArticle article) |
void |
AbstractXMLParentArticle.addLinkFromArticle(XMLParentArticle article)
Add an article from which there is a reference to this article.
|
void |
OpaqueArticle.addLinkFromArticle(XMLParentArticle article) |
void |
XMLParentArticle.addLinkFromArticle(XMLParentArticle article)
Add an article from which there is a reference to this article.
|
void |
XMLRawHTMLArticle.addLinkFromArticle(XMLParentArticle article)
Add an article from which there is a reference to this article.
|
void |
AbstractXMLParentArticle.addReference(XMLParentArticle article)
Add an article reference.
|
default void |
ArticleReference.bind(XMLParentArticle article)
Set the referenced article.
|
void |
XMLInclude.bind(XMLParentArticle article)
Set the referenced article.
|
void |
XMLRedirect.bind(XMLParentArticle article)
Set the referenced article.
|
void |
XMLReference.bind(XMLParentArticle article)
Set the referenced 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.
|
protected java.lang.String |
AbstractMoreInfoRef.getDescription(XMLParentArticle article,
java.lang.String refID)
Return the description associated to an ID and an article.
|
protected java.lang.String |
XMLReference.getDescription(XMLParentArticle article,
java.lang.String refID)
Return the description associated to an ID and an article.
|
protected java.lang.String |
XMLSeeArticle.getDescription(XMLParentArticle article,
java.lang.String refID)
Return the description associated to an ID and an article.
|
default java.lang.String |
ExternalLink.getURLAsString(XMLParentArticle article)
Return the path of the link relative to its article.
|
void |
XMLIndex.setReferTo(XMLParentArticle referToArticle)
Set the article on which the index is referring to.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractXMLParentArticle.setLinkFromArticles(java.util.SortedMap<java.lang.String,XMLParentArticle> linksFrom)
Set the articles from which there is a reference to this article.
|
void |
OpaqueArticle.setLinkFromArticles(java.util.SortedMap<java.lang.String,XMLParentArticle> linksFrom) |
void |
XMLParentArticle.setLinkFromArticles(java.util.SortedMap<java.lang.String,XMLParentArticle> linksFrom)
Set the articles from which there is a reference to this article.
|
void |
XMLRawHTMLArticle.setLinkFromArticles(java.util.SortedMap<java.lang.String,XMLParentArticle> linksFrom)
Set the articles from which there is a reference to this article.
|
Constructor and Description |
---|
XMLMap(XMLParentArticle article)
Constructor.
|
XMLMessageBox(XMLParentArticle article)
Constructor.
|
XMLMessageBox(XMLParentArticle article,
java.io.File href)
Constructor.
|
XMLMessageBox(XMLParentArticle article,
java.lang.String id,
java.lang.String pack)
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 |
---|---|
XMLParentArticle |
InternalMenuItem.getArticle()
Return the referenced article.
|
XMLParentArticle |
ArticlesModel.getArticle(ArticleRef articleRef)
Return an article specified by its reference.
|
XMLParentArticle |
ArticlesModel.getArticle(java.lang.String refID)
Return an article specified by its reference.
|
XMLParentArticle |
ArticlesModel.getArticle(java.lang.String refID,
java.lang.String pack)
Return an article specified by its reference.
|
XMLParentArticle |
ArticlesModel.getArticle(java.lang.String refID,
java.lang.String origPack,
java.lang.String pack)
Return an article specified by its reference.
|
XMLParentArticle |
ArticlesModel.getFirstArticle(java.lang.String refID)
Return the first article specified by its reference, regardless of the package in which the article is defined.
|
XMLParentArticle |
ArticlesModel.getFirstArticle(java.lang.String refID,
boolean includePackages)
Return the first article specified by its reference, regardless of the package in which the article is defined.
|
XMLParentArticle |
ArticlesGlossary.Word.getReferencedArticle()
Return the referenced article.
|
XMLParentArticle |
ArticlesModel.getTransitiveArticle(java.lang.String refID,
java.lang.String origPack,
java.lang.String pack)
Return the concrete article for a specified id and package.
|
Modifier and Type | Method and Description |
---|---|
void |
ArticlesGlossary.Word.bind(XMLParentArticle article)
Set the referenced article.
|
void |
InternalMenuItem.bind(XMLParentArticle article)
Set the referenced article.
|
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