Package | Description |
---|---|
org.docgene.model |
Contains the documentation model.
|
org.docgene.model.globals |
Contains the global elements for the wiki model.
|
Modifier and Type | Interface and Description |
---|---|
interface |
XMLParentArticle
Represents an article which can have children chapters and paragraphs.
|
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.
|
class |
XMLRedirect
Represents an XML redirect article.
|
Modifier and Type | Method and Description |
---|---|
Article |
XMLReference.getOriginArticle()
Return the article which emit the reference.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Article> |
XMLDisambArticle.getDisambArticles()
Return the disambiguated articles.
|
Modifier and Type | Method and Description |
---|---|
void |
XMLDisambArticle.addDisambArticle(Article article)
Add an article to the disambiguation list.
|
int |
OpaqueArticle.compareTo(Article article) |
int |
XMLArticle.compareTo(Article article) |
int |
XMLRawHTMLArticle.compareTo(Article article) |
Constructor and Description |
---|
AbstractMoreInfoRef(Article article)
Constructor.
|
AbstractMoreInfoRef(Article article,
java.lang.String refID,
java.lang.String pack)
Constructor.
|
ArticleRef(Article article)
Constructor.
|
XMLMoreInfo(Article article)
Constructor.
|
XMLMoreInfo(Article article,
java.lang.String refID,
java.lang.String pack)
Constructor.
|
XMLMoreInfoRef(Article article)
Constructor.
|
XMLMoreInfoRef(Article article,
java.lang.String refID,
java.lang.String pack)
Constructor.
|
XMLReference(Article article)
Constructor.
|
XMLReference(Article article,
java.lang.String rawID,
java.lang.String pack)
Constructor.
|
XMLReference(Article article,
java.lang.String rawID,
java.lang.String pack,
boolean isBareReference)
Constructor.
|
XMLSeeAlso(Article article,
java.lang.String refID,
java.lang.String pack)
Constructor.
|
XMLSeeAlsoHeading(Article article,
java.lang.String refID,
java.lang.String pack)
Constructor.
|
XMLSeeArticle(Article article,
java.lang.String refID,
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 |
---|---|
Article |
ArticlesDictionary.addArticle(Article article)
Add an article to the dictionnary.
|
Article |
ArticlesDictionary.addArticle(Article article,
boolean checkName)
Add an article to the dictionnary.
|
Article |
ArticlesModel.addArticle(Article article,
java.lang.String pack)
Add an article.
|
Article |
ArticlesModel.addArticle(Article article,
java.lang.String pack,
boolean checkName,
boolean resolve)
Add an article.
|
Article |
ArticlesDictionary.addArticle(java.lang.String desc,
boolean keepCase,
Article article)
Add an article to the dictionnary.
|
Article |
ArticlesModel.addArticleToDictionnary(Article article)
Add an article to the dictionnary and categories.
|
Article |
ArticlesModel.addArticleToDictionnary(java.lang.String title,
Article article)
Add an article to the dictionnary.
|
Article |
ArticlesDictionary.addArticleToPackage(Article article)
Add an article in its corresponding package.This method should only be called if the article is not included by default in the wiki.
|
Article |
ArticlesModel.getArticle(java.io.File file)
Return the article coresponding to a specified input file.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Article> |
ArticlesModel.getAllArticles()
Return all the articles including those from the packages.
|
java.util.Map<java.lang.String,Article> |
ArticleCategory.getArticles()
Return the articles in this category.
|
java.util.SortedMap<java.lang.String,Article> |
ArticlesDictionary.Letter.getArticles()
Return the Map of articles for the letter.
|
java.util.SortedMap<java.lang.String,Article> |
ArticlesGlossary.Word.getArticles()
Return the Map of articles for the letter.
|
java.util.Map<java.lang.String,Article> |
ArticlesModel.getArticles()
Return the articles without packages.
|
java.util.Map<ArticleRef,Article> |
ArticleCategory.getArticlesByRef()
Return the articles in this category, mapped by their ref.
|
java.util.Map<java.io.File,Article> |
ArticlesModel.getArticlesForFiles()
Return the map from input file to article.
|
java.util.Iterator<Article> |
ArticlesModel.getArticlesIterator()
Return an iterator on all the articles, including packages.
|
java.util.Map<java.lang.String,java.util.List<Article>> |
ArticlesModel.getArticlesMap()
Return the Map of articles for each name, for all packages.
|
java.util.Map<ArticleRef,Article> |
ArticlesModel.getArticlesMapByRef()
Return the Map of articles for each article reference, for all packages.
|
java.util.Map<java.lang.String,Article> |
ArticlesModel.getArticlesPerAllNames()
Return the articles without packages.
|
java.util.List<Article> |
ArticlesCategories.getArticlesToResolve()
Return the list of articles to resolve (may be null).
|
java.util.Collection<Article> |
ArticlesModel.getParsedArticles()
Return the parsed articles.
|
java.util.List<Article> |
ArticlesModel.getRankedArticles()
Return all the articles including those from the packages, possibly takning the page ranks into accounts.
|
Modifier and Type | Method and Description |
---|---|
void |
ArticleCategory.addArticle(Article article)
Add an article.
|
Article |
ArticlesDictionary.addArticle(Article article)
Add an article to the dictionnary.
|
Article |
ArticlesDictionary.addArticle(Article article,
boolean checkName)
Add an article to the dictionnary.
|
void |
ArticlesGlossary.Word.addArticle(Article article,
java.lang.String line)
Add an article to the Word.
|
Article |
ArticlesModel.addArticle(Article article,
java.lang.String pack)
Add an article.
|
Article |
ArticlesModel.addArticle(Article article,
java.lang.String pack,
boolean checkName,
boolean resolve)
Add an article.
|
Article |
ArticlesDictionary.addArticle(java.lang.String desc,
boolean keepCase,
Article article)
Add an article to the dictionnary.
|
Article |
ArticlesModel.addArticleToDictionnary(Article article)
Add an article to the dictionnary and categories.
|
Article |
ArticlesModel.addArticleToDictionnary(java.lang.String title,
Article article)
Add an article to the dictionnary.
|
Article |
ArticlesDictionary.addArticleToPackage(Article article)
Add an article in its corresponding package.This method should only be called if the article is not included by default in the wiki.
|
void |
ArticlesModel.addParsedArticle(Article article)
Add a parsed article.
|
java.lang.String |
ArticlesModel.getNonExistingDesc(Article article)
Return a description which is not used for an article.
|
protected void |
ArticlesModel.refreshCategories(Article article,
boolean resolve)
Integrate the categories of an article in the list of categories.
|
void |
ArticlesCategories.refreshCategories(org.docgene.model.globals.PackagesDependencies dependencies,
Article article,
boolean resolve)
Integrate the categories of an article in the list of categories.
|
boolean |
ArticlesModel.removeArticle(Article article)
Remove an article.
|
void |
ArticlesModel.renameArticle(Article article,
XMLDisambArticle disamb,
java.lang.String newDesc)
Rename an article, making sure it will not use an existing name.
|
void |
ArticlesModel.replaceArticle(Article article)
Replace an article by anotehr version.
|
Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence