Index (Doxia Sitetools 2.1.0 API)

A B C D E G H I L M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addAlternativeEditableSourceDirectory(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory: Add an alternative source directory to this site directory.
addBreadcrumb(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body: Method addBreadcrumb.
addBreadcrumb(LinkItem) - Method in class org.apache.maven.doxia.site.Body: Method addBreadcrumb.
addItem(MenuItem) - Method in class org.apache.maven.doxia.site.decoration.Menu: Method addItem.
addItem(MenuItem) - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Method addItem.
addItem(MenuItem) - Method in class org.apache.maven.doxia.site.Menu: Method addItem.
addItem(MenuItem) - Method in class org.apache.maven.doxia.site.MenuItem: Method addItem.
addLink(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body: Method addLink.
addLink(LinkItem) - Method in class org.apache.maven.doxia.site.Body: Method addLink.
addMenu(Menu) - Method in class org.apache.maven.doxia.site.decoration.Body: Method addMenu.
addMenu(Menu) - Method in class org.apache.maven.doxia.site.Body: Method addMenu.
addPoweredBy(Logo) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Method addPoweredBy.
addPoweredBy(Logo) - Method in class org.apache.maven.doxia.site.SiteModel: Method addPoweredBy.
addResourceCondition(ResourceCondition) - Method in class org.apache.maven.doxia.site.skin.SkinModel: Method addResourceCondition.
addResourceName(String) - Method in class org.apache.maven.doxia.site.skin.ResourceCondition: Method addResourceName.
addSiteDirectory(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Deprecated.
use SiteRenderingContext.addSiteDirectory(SiteDirectory)
addSiteDirectory(SiteRenderingContext.SiteDirectory) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Add a site directory, expected to have a Doxia Site layout, ie one directory per Doxia parser module containing files with parser extension.
addSiteLocales(List<Locale>) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Adds passed locales to the list of site locales.
asScriptTag() - Method in class org.apache.maven.doxia.site.ExternalJs
assembleModelInheritance(String, SiteModel, SiteModel, String, String) - Method in class org.apache.maven.doxia.site.inheritance.DefaultSiteModelInheritanceAssembler: Manage inheritance of the site model between a parent and child.
assembleModelInheritance(String, SiteModel, SiteModel, String, String) - Method in interface org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler: Manage inheritance of the site model between a parent and child.
assembler - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool: The component for assembling inheritance.
author(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
author_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

B

Banner - Class in org.apache.maven.doxia.site: Banner logo on the masthead of the site.
Banner - Class in org.apache.maven.doxia.site.decoration: Banner logo on the masthead of the site.
Banner() - Constructor for class org.apache.maven.doxia.site.Banner
Banner() - Constructor for class org.apache.maven.doxia.site.decoration.Banner
body(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Do nothing.
Body - Class in org.apache.maven.doxia.site: The main content.
Body - Class in org.apache.maven.doxia.site.decoration: The main content decoration.
Body() - Constructor for class org.apache.maven.doxia.site.Body
Body() - Constructor for class org.apache.maven.doxia.site.decoration.Body
body_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Do nothing.

C

clone() - Method in class org.apache.maven.doxia.site.Banner: Method clone.
clone() - Method in class org.apache.maven.doxia.site.Body: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.Banner: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.Body: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.Logo: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.Menu: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.Skin: Method clone.
clone() - Method in class org.apache.maven.doxia.site.decoration.Version: Method clone.
clone() - Method in class org.apache.maven.doxia.site.ExternalJs: Method clone.
clone() - Method in class org.apache.maven.doxia.site.Image: Method clone.
clone() - Method in class org.apache.maven.doxia.site.LinkItem: Method clone.
clone() - Method in class org.apache.maven.doxia.site.Logo: Method clone.
clone() - Method in class org.apache.maven.doxia.site.Menu: Method clone.
clone() - Method in class org.apache.maven.doxia.site.MenuItem: Method clone.
clone() - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Method clone.
clone() - Method in class org.apache.maven.doxia.site.PublishDate: Method clone.
clone() - Method in class org.apache.maven.doxia.site.SiteModel: Method clone.
clone() - Method in class org.apache.maven.doxia.site.Skin: Method clone.
clone() - Method in class org.apache.maven.doxia.site.skin.Prerequisites: Method clone.
clone() - Method in class org.apache.maven.doxia.site.skin.ResourceCondition: Method clone.
clone() - Method in class org.apache.maven.doxia.site.skin.SkinModel: Method clone.
clone() - Method in class org.apache.maven.doxia.site.Version: Method clone.
compare(MavenReport, MavenReport) - Method in class org.apache.maven.doxia.tools.ReportComparator
configure(String, Path, Parser) - Method in interface org.apache.maven.doxia.siterenderer.ParserConfigurator: Configures the given parser which is afterwards used to parse the source file with the given path.
contentTransformer - Variable in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader: Field contentTransformer.
contentTransformer - Variable in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader: Field contentTransformer.
contentTransformer - Variable in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader: Field contentTransformer.
ContextCustomizer - Interface in org.apache.maven.doxia.siterenderer: A callback interface to customize the Velocity Context before rendering a document.
copyDirectory(File, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Copy the directory
copyResources(SiteRenderingContext, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Copy resource files from skin, template, and site resources.
copyResources(SiteRenderingContext, File) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer: Copy resource files from skin, template, and site resources.
createContextForSkin(Artifact, Map<String, ?>, SiteModel, String, Locale) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Create a Site Rendering Context for a site using a skin.
createContextForSkin(Artifact, Map<String, ?>, SiteModel, String, Locale) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer: Create a Site Rendering Context for a site using a skin.
createDocumentVelocityContext(DocumentRenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Create a Velocity Context for a Doxia document, containing every information about rendered document.
createSiteTemplateVelocityContext(DocumentContent, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Create a Velocity Context for the site template decorating the document.
createToolManagedVelocityContext(SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Creates a Velocity Context with all generic tools configured wit the site rendering context.
customizeContext(Context, DocumentRenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.scm.siterenderer.ScmAttributesContextCustomizer
customizeContext(Context, DocumentRenderingContext, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.ContextCustomizer: Customize the Velocity context before rendering a document.

D

date(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
date_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
DecorationModel - Class in org.apache.maven.doxia.site.decoration: The <project> element is the root of the site decoration descriptor.
DecorationModel() - Constructor for class org.apache.maven.doxia.site.decoration.DecorationModel
DecorationXpp3Reader - Class in org.apache.maven.doxia.site.decoration.io.xpp3: Class DecorationXpp3Reader.
DecorationXpp3Reader() - Constructor for class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
DecorationXpp3Reader(DecorationXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
DecorationXpp3Reader.ContentTransformer - Interface in org.apache.maven.doxia.site.decoration.io.xpp3
DEFAULT_LOCALE - Static variable in interface org.apache.maven.doxia.tools.SiteTool: The locale by default for a Maven Site.
DefaultSiteModelInheritanceAssembler - Class in org.apache.maven.doxia.site.inheritance: Manage inheritance of the site model.
DefaultSiteModelInheritanceAssembler() - Constructor for class org.apache.maven.doxia.site.inheritance.DefaultSiteModelInheritanceAssembler
DefaultSiteRenderer - Class in org.apache.maven.doxia.siterenderer: DefaultSiteRenderer class.
DefaultSiteRenderer() - Constructor for class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
DefaultSiteTool - Class in org.apache.maven.doxia.tools: Default implementation of the site tool.
DefaultSiteTool() - Constructor for class org.apache.maven.doxia.tools.DefaultSiteTool
DocumentContent - Interface in org.apache.maven.doxia.siterenderer: Document content, that will be merged into a site template.
DocumentRenderer - Interface in org.apache.maven.doxia.siterenderer: Renders a page in a site, whatever the source is: a Doxia source file, a report or anything else.
DocumentRenderingContext - Class in org.apache.maven.doxia.siterenderer: The rendering context of a document.
DocumentRenderingContext(File, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Constructor for rendering context when document is not rendered from a Doxia markup source.
DocumentRenderingContext(File, String, String, String, File, File, Collection<File>) - Constructor for class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Constructor for rendering context when document is a Doxia markup source.
DocumentRenderingContext(File, String, String, String, File, File, Collection<File>, String) - Constructor for class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Constructor for document rendering context.
DocumentRenderingContext(File, String, String, String, String, boolean) - Constructor for class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Deprecated.
Use DocumentRenderingContext(File, String, String, String, File, File, Collection, String) instead.
DocumentRenderingContext(File, String, String, String, String, boolean, String) - Constructor for class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Deprecated.
Use DocumentRenderingContext(File, String, String, String, File, File, Collection, String) instead.
DoxiaDocumentRenderer - Class in org.apache.maven.doxia.siterenderer: Renderer for a document that has a source file to be parsed by Doxia.
DoxiaDocumentRenderer(DocumentRenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer: Constructor.

E

equals(Object) - Method in class org.apache.maven.doxia.site.Body: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Banner: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Body: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Menu: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Skin: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.decoration.Version: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.ExternalJs: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.Image: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.LinkItem: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.Menu: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.MenuItem: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.PublishDate: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.SiteModel: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.Skin: Method equals.
equals(Object) - Method in class org.apache.maven.doxia.site.Version: Method equals.
ExternalJs - Class in org.apache.maven.doxia.site: The configuration of an external JS file to be embedded in the HTML.
ExternalJs() - Constructor for class org.apache.maven.doxia.site.ExternalJs

G

generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
getAddDefaultEntities() - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader: Returns the state of the "add default entities" flag.
getAddDefaultEntities() - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader: Returns the state of the "add default entities" flag.
getAddDefaultEntities() - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader: Returns the state of the "add default entities" flag.
getAlt() - Method in class org.apache.maven.doxia.site.decoration.Banner: Get the alt description for the banner image.
getAlt() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get the alt to use for the image.
getAlt() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get the alt description for the image.
getAlt() - Method in class org.apache.maven.doxia.site.Image: Get the alternative text to use.
getArtifactId() - Method in class org.apache.maven.doxia.site.decoration.Skin: Get the skin artifact ID.
getArtifactId() - Method in class org.apache.maven.doxia.site.Skin: Get the skin artifact ID.
getAttribute(String) - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: getAttribute.
getAttributes() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Gets the map of attributes that can be used to cache items per site rendering context.
getAuthors() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent: Get the authors of the document.
getAuthors() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Get the authors of the document.
getBannerLeft() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get banner logo on the masthead of the site to the left.
getBannerLeft() - Method in class org.apache.maven.doxia.site.SiteModel: Get banner logo on the masthead of the site to the left.
getBannerRight() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get banner logo on the masthead of the site to the right.
getBannerRight() - Method in class org.apache.maven.doxia.site.SiteModel: Get banner logo on the masthead of the site to the right.
getBasedir() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Getter for the field basedir.
getBasedirRelativePath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Get the project root relative path of basedir (when a Doxia source).
getBaseURI() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor: Return the base of this URIPathDescriptor as a URI.
getBody() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get the main site content decoration.
getBody() - Method in class org.apache.maven.doxia.site.SiteModel: Get the main site content.
getBody() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent: Get the html body of the document.
getBody() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Get the html body of the document.
getBorder() - Method in class org.apache.maven.doxia.site.decoration.Banner: Get the border to use for the banner image.
getBorder() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get the border to use for the image.
getBorder() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get the border to use for the menu image.
getBreadcrumbs() - Method in class org.apache.maven.doxia.site.Body: Method getBreadcrumbs.
getBreadcrumbs() - Method in class org.apache.maven.doxia.site.decoration.Body: Method getBreadcrumbs.
getCombineSelf() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get whether to inherit configuration from a parent project site descriptor (merge) or not (override).
getCombineSelf() - Method in class org.apache.maven.doxia.site.SiteModel: Get whether to inherit configuration from a parent project site descriptor (merge) or not (override).
getConfig() - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Get the Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.
getCustom() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get custom configuration for use with customized Velocity templates.
getCustom() - Method in class org.apache.maven.doxia.site.SiteModel: Get custom configuration for use with customized Velocity templates.
getCustomChild(String) - Method in class org.apache.maven.doxia.site.SiteModel
getCustomChild(Xpp3Dom, String) - Static method in class org.apache.maven.doxia.site.SiteUtils: Helper to get site custom DOM element by simply specifying a dotted path.
getCustomValue(String) - Method in class org.apache.maven.doxia.site.SiteModel
getCustomValue(String, String) - Method in class org.apache.maven.doxia.site.SiteModel
getCustomValue(Xpp3Dom, String) - Static method in class org.apache.maven.doxia.site.SiteUtils: Helper to get site custom DOM element value by simply specifying a dotted path.
getCustomValue(Xpp3Dom, String, String) - Static method in class org.apache.maven.doxia.site.SiteUtils: Helper to get site custom DOM element value by simply specifying a dotted path.
getDate() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent: Get the date of the document.
getDate() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Get the date of the document.
getDefaultTitle() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field defaultTitle.
getDescription() - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Get a description of the menu item.
getDoxiaSitetools() - Method in class org.apache.maven.doxia.site.skin.Prerequisites: Get the minimum version of Doxia Sitetools required to use the resulting skin.
getDoxiaSourcePath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Get the relative path to Doxia source from build root.
getDoxiaSourcePath(String) - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Get absolute url of the Doxia source calculate from given base url.
getEdit() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get the base url to edit Doxia document sources.
getEdit() - Method in class org.apache.maven.doxia.site.SiteModel: Get the base url to edit Doxia document sources.
getEditableSourceDirectories() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory: Get the source directories for this site directory.
getEncoding() - Method in class org.apache.maven.doxia.site.skin.SkinModel: Get encoding of text content, like the Velocity template itself.
getExtension() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Get the source document filename extension (when a Doxia source)
getExternalJs() - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Get the URL from which to request the javascript used for rendering the diagrams.
getFallbackPrefix() - Method in class org.apache.maven.doxia.site.PublishDate: Get the prefix to emit in front of the fallback date.
getFallbackValue() - Method in class org.apache.maven.doxia.site.PublishDate: Get the Velocity context key to use as source for the date.
getFooter() - Method in class org.apache.maven.doxia.site.Body: Get if present, the contained text will be used instead of the generated copyright text.
getFooter() - Method in class org.apache.maven.doxia.site.decoration.Body: Get if present, the contained text will be used instead of the generated copyright text.
getFormat() - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Get date format to use.
getFormat() - Method in class org.apache.maven.doxia.site.PublishDate: Get date format to use.
getGenerator() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: What is the generator (if any)?
getGroupId() - Method in class org.apache.maven.doxia.site.decoration.Skin: Get the skin group ID.
getGroupId() - Method in class org.apache.maven.doxia.site.Skin: Get the skin group ID.
getHead() - Method in class org.apache.maven.doxia.site.Body: Get additional content (like JavaScript) to include in the HEAD block of the generated pages.
getHead() - Method in class org.apache.maven.doxia.site.decoration.Body: Get additional content (like JavaScript) to include in the HEAD block of the generated pages.
getHead() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent: Get the html head of the document.
getHead() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Get the html head of the document.
getHeight() - Method in class org.apache.maven.doxia.site.decoration.Banner: Get the height to use for the banner image.
getHeight() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get the height to use for the image.
getHeight() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get the height to use for the menu image.
getHeight() - Method in class org.apache.maven.doxia.site.Image: Get the height to use.
getHref() - Method in class org.apache.maven.doxia.site.decoration.Banner: Get the href of a link to be used for the banner image.
getHref() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get the href to use for the link.
getHref() - Method in class org.apache.maven.doxia.site.LinkItem: Get the href to use for the link.
getImage() - Method in class org.apache.maven.doxia.site.LinkItem: Get the image for the link.
getImage() - Method in class org.apache.maven.doxia.site.Menu: Get the image for the menu.
getImg() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get the source location of an image.
getImg() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get the source location of an menu image.
getInherit() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get the way in which the menu is inherited.
getInherit() - Method in class org.apache.maven.doxia.site.Menu: Get the way in which the menu is inherited.
getInputEncoding() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field inputEncoding.
getInputName() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Deprecated.
Method name does not properly reflect its purpose. Use DocumentRenderingContext.getInputPath() instead.
getInputPath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Getter for the field inputPath.
getIntegrity() - Method in class org.apache.maven.doxia.site.ExternalJs: Get the integrity hash to use for the external JS file emitted in the "script" element's "integrity" attribute.
getInterpolatedSiteDescriptorContent(Map<String, String>, MavenProject, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool: Deprecated.
getInterpolatedSiteDescriptorContent(Map<String, String>, MavenProject, String) - Method in interface org.apache.maven.doxia.tools.SiteTool: Deprecated.
since 2.1.0, use SiteTool.getSiteModel(File, Locale, MavenExecutionRequest, MavenProject, List, RepositorySystemSession, List) instead
getItems() - Method in class org.apache.maven.doxia.site.decoration.Menu: Method getItems.
getItems() - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Method getItems.
getItems() - Method in class org.apache.maven.doxia.site.Menu: Method getItems.
getItems() - Method in class org.apache.maven.doxia.site.MenuItem: Method getItems.
getLastModified() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get timestamp of the last modification of this decoration model.
getLastModified() - Method in class org.apache.maven.doxia.site.SiteModel: Get timestamp of the last modification of this site model.
getLink() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor: Return the link of this URIPathDescriptor as a URI.
getLinks() - Method in class org.apache.maven.doxia.site.Body: Method getLinks.
getLinks() - Method in class org.apache.maven.doxia.site.decoration.Body: Method getLinks.
getLocale() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field locale.
getMenuRef(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
getMenuRef(String) - Method in class org.apache.maven.doxia.site.SiteModel
getMenus() - Method in class org.apache.maven.doxia.site.Body: Method getMenus.
getMenus() - Method in class org.apache.maven.doxia.site.decoration.Body: Method getMenus.
getMenus() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
getMenus() - Method in class org.apache.maven.doxia.site.SiteModel
getMermaid() - Method in class org.apache.maven.doxia.site.SiteModel: Get the configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side.
getModelEncoding() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get the modelEncoding field.
getModelEncoding() - Method in class org.apache.maven.doxia.site.SiteModel: Get the modelEncoding field.
getModelEncoding() - Method in class org.apache.maven.doxia.site.skin.SkinModel: Get the modelEncoding field.
getModuleExcludes() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field moduleExcludes.
getName() - Method in class org.apache.maven.doxia.site.decoration.Banner: Get the name of the banner.
getName() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get the full name of the project.
getName() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get the name to display for the link.
getName() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get the name to display for the menu.
getName() - Method in class org.apache.maven.doxia.site.LinkItem: Get the name to display for the link.
getName() - Method in class org.apache.maven.doxia.site.Menu: Get the name to display for the menu.
getName() - Method in class org.apache.maven.doxia.site.SiteModel: Get the full name of the project site.
getNormalizedPath(String) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool
getOtherAttributes() - Method in class org.apache.maven.doxia.site.ExternalJs: Get other attributes to include in the "script" element for this external JS file, in the form of a whitespace separated list of key=value pairs.
getOutputEncoding() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field outputEncoding.
getOutputName() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer: Deprecated.
Method name does not properly reflect its purpose. Implement and use DocumentRenderer.getOutputPath() instead.
getOutputName() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Deprecated.
Method name does not properly reflect its purpose. Use DocumentRenderingContext.getOutputPath() instead.
getOutputName() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
getOutputPath() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer: The output path of the document.
getOutputPath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Get html output path, relative to site root.
getParserConfigurator() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Return the configurator for parsers.
getParserId() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Get the parserId when document comes from a Doxia source.
getPath() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
getPosition() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get where to place the image regarding the displayed name (left or right).
getPosition() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get where to place the image regarding the displayed name (left or right).
getPosition() - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Get where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
getPosition() - Method in class org.apache.maven.doxia.site.decoration.Version: Get where to place the version published (left, right, navigation-top, navigation-bottom, bottom).
getPosition() - Method in class org.apache.maven.doxia.site.Image: Get where to place the image relative to the displayed name (left or right).
getPosition() - Method in class org.apache.maven.doxia.site.PublishDate: Get where to place the date published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
getPosition() - Method in class org.apache.maven.doxia.site.Version: Get where to place the version published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
getPoweredBy() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Method getPoweredBy.
getPoweredBy() - Method in class org.apache.maven.doxia.site.SiteModel: Method getPoweredBy.
getPrefix() - Method in class org.apache.maven.doxia.site.PublishDate: Get the prefix to emit in front of the date.
getPrerequisites() - Method in class org.apache.maven.doxia.site.skin.SkinModel: Get describes the prerequisites in the build environment for using this skin.
getProcessedContentOutput() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Directory where to save content after Velocity processing (*.vm), but before parsing it with Doxia.
getPublishDate() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
getPublishDate() - Method in class org.apache.maven.doxia.site.SiteModel
getPublishDate() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: If you want to specify a specific publish date instead of the current date.
getRef() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get mark this menu as reference to a pre-defined menu: reports, modules or parent.
getRef() - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Get a reference to a pre-defined menu item, such as a report (specified by the report goal name).
getRef() - Method in class org.apache.maven.doxia.site.Menu: Get mark this menu as reference to a pre-defined menu: reports, modules or parent.
getRef() - Method in class org.apache.maven.doxia.site.MenuItem: Get a reference to a pre-defined menu item, such as a report (specified by the report goal name).
getReferrerpolicy() - Method in class org.apache.maven.doxia.site.ExternalJs: Get the referrerpolicy attribute to use when requesting the external JS file.
getRelativePath() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Get the relative path of the parent directory of this document to site root.
getRelativePath(String, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool: Deprecated.
getRelativePath(String, String) - Method in interface org.apache.maven.doxia.tools.SiteTool: Calculate the relative path between two URLs or between two files.
getRenderingContext() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent: Get the document rendering context.
getRenderingContext() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer: Return the rendering context of the document.
getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer: Return the rendering context of the document.
getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Get the document rendering context.
getResourceConditions() - Method in class org.apache.maven.doxia.site.skin.SkinModel: Method getResourceConditions.
getResourceNames() - Method in class org.apache.maven.doxia.site.skin.ResourceCondition: Method getResourceNames.
getRootDirectory() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Root directory, to calculate relative path to every site directories.
getSiteDescriptor(File, Locale) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool: Get a site descriptor from the project's site directory.
getSiteDescriptor(File, Locale) - Method in interface org.apache.maven.doxia.tools.SiteTool: Get a site descriptor from the project's site directory.
getSiteDirectories() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field siteDirectories.
getSiteLocales() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field siteLocales - a list of locales available for this site context.
getSiteLocales(String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool: Extracts from a comma-separated list the locales that are available in site-tool resource bundle.
getSiteLocales(String) - Method in interface org.apache.maven.doxia.tools.SiteTool: Extracts from a comma-separated list the locales that are available in site-tool resource bundle.
getSiteModel() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field siteModel.
getSiteModel(File, Locale, MavenExecutionRequest, MavenProject, List<MavenProject>, RepositorySystemSession, List<RemoteRepository>) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool
getSiteModel(File, Locale, MavenExecutionRequest, MavenProject, List<MavenProject>, RepositorySystemSession, List<RemoteRepository>) - Method in interface org.apache.maven.doxia.tools.SiteTool: Get a site model for a project.
getSiteModel(File, Locale, MavenProject, List<MavenProject>, RepositorySystemSession, List<RemoteRepository>) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool: Deprecated.
getSiteModel(File, Locale, MavenProject, List<MavenProject>, RepositorySystemSession, List<RemoteRepository>) - Method in interface org.apache.maven.doxia.tools.SiteTool: Deprecated.
since 2.1.0, use SiteTool.getSiteModel(File, Locale, MavenExecutionRequest, MavenProject, List, RepositorySystemSession, List) instead
getSkin() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Get the artifact containing the skin for the site.
getSkin() - Method in class org.apache.maven.doxia.site.SiteModel: Get the artifact containing the skin for the site.
getSkin() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field skin.
getSkinArtifactFromRepository(RepositorySystemSession, List<RemoteRepository>, Skin) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool: Get a skin artifact from one of the repositories.
getSkinArtifactFromRepository(RepositorySystemSession, List<RemoteRepository>, Skin) - Method in interface org.apache.maven.doxia.tools.SiteTool: Get a skin artifact from one of the repositories.
getSkinModel() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field skinModel.
getSrc() - Method in class org.apache.maven.doxia.site.decoration.Banner: Get the source location of an image for the banner.
getSrc() - Method in class org.apache.maven.doxia.site.Image: Get the source location.
getStyle() - Method in class org.apache.maven.doxia.site.Image: Get the style to use.
getTarget() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get where the new document will be displayed when the user follows a link, i.e.
getTarget() - Method in class org.apache.maven.doxia.site.LinkItem: Get where the new document will be displayed when the user follows a link, i.e.
getTemplateClassLoader() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field templateClassLoader.
getTemplateName() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field templateName.
getTemplateProperties() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field templateProperties.
getTimezone() - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Get the timezone to use.
getTimezone() - Method in class org.apache.maven.doxia.site.PublishDate: Get the timezone to use.
getTitle() - Method in class org.apache.maven.doxia.site.decoration.Banner: Get the title for the banner image.
getTitle() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get the title to use for the image.
getTitle() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get the title for the image.
getTitle() - Method in interface org.apache.maven.doxia.siterenderer.DocumentContent: Get the title of the document.
getTitle() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Get the title of the document.
getURL() - Method in class org.apache.maven.doxia.site.ExternalJs: Get the URL to include via "script" element with its "src" attribute in the HTML.
getValue() - Method in class org.apache.maven.doxia.site.PublishDate: Get the Velocity context key to use as source for the date.
getVersion() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
getVersion() - Method in class org.apache.maven.doxia.site.decoration.Skin: Get the skin version.
getVersion() - Method in class org.apache.maven.doxia.site.SiteModel
getVersion() - Method in class org.apache.maven.doxia.site.Skin: Get the skin version.
getVtlCondition() - Method in class org.apache.maven.doxia.site.skin.ResourceCondition: Get the Velocity (VTL) expression to be evaluated to decide if the resource should be included.
getWidth() - Method in class org.apache.maven.doxia.site.decoration.Banner: Get the width to use for the banner image.
getWidth() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Get the width to use for the image.
getWidth() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get the width to use for the menu image.
getWidth() - Method in class org.apache.maven.doxia.site.Image: Get the width to use.

H

hashCode() - Method in class org.apache.maven.doxia.site.Body: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.decoration.Banner: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.decoration.Body: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.decoration.Menu: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.decoration.Skin: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.decoration.Version: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.ExternalJs: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.Image: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.LinkItem: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.Menu: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.MenuItem: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.PublishDate: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.SiteModel: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.Skin: Method hashCode.
hashCode() - Method in class org.apache.maven.doxia.site.Version: Method hashCode.
head(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
head_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

I

i18n - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool: Internationalization.
Image - Class in org.apache.maven.doxia.site: An image.
Image() - Constructor for class org.apache.maven.doxia.site.Image
inline(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
inline_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
isCollapse() - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Get whether to collapse children elements of an item menu (by default).
isCollapse() - Method in class org.apache.maven.doxia.site.MenuItem: Get whether to collapse children elements of an item menu (by default).
isDefaultPublishDate() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
isDefaultPublishDate() - Method in class org.apache.maven.doxia.site.SiteModel
isDefaultVersion() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
isDefaultVersion() - Method in class org.apache.maven.doxia.site.SiteModel
isDoxiaSource() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Is the document rendered from a Doxia source?
isEditable() - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: Is the source document editable?
isEditable() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
isExternalReport() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer: Whether this document is an external report, independent from the site templating.
isExternalReport() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
isInheritAsRef() - Method in class org.apache.maven.doxia.site.decoration.Menu: Get if this is a reference, setting to true means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.
isInheritAsRef() - Method in class org.apache.maven.doxia.site.Menu: Get if this is a reference, setting to true means that it will be populated in the site, whereas if it is false, it is populated in the parent and then inherited.
isLink(String) - Method in class org.apache.maven.doxia.site.SiteModel
isLink(String) - Static method in class org.apache.maven.doxia.site.SiteUtils
isMergeParent() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
isMergeParent() - Method in class org.apache.maven.doxia.site.SiteModel
isOverwrite() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer: Whether to always overwrite the document, or only do so when it is changed.
isOverwrite() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer: Whether to always overwrite the document, or only do so when it is changed.
isRequireParent() - Method in class org.apache.maven.doxia.site.SiteModel: Get whether this "site.xml" should inherit from a parent "site.xml".
isSkipDuplicates() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
isUseTiny() - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Get if Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used.
isValidate() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: If input documents should be validated before parsing.

L

LinkItem - Class in org.apache.maven.doxia.site.decoration: A link in the navigation.
LinkItem - Class in org.apache.maven.doxia.site: A link in the navigation.
LinkItem() - Constructor for class org.apache.maven.doxia.site.decoration.LinkItem
LinkItem() - Constructor for class org.apache.maven.doxia.site.LinkItem
locateDocumentFiles(SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Locate Doxia document source files in the site source context.
locateDocumentFiles(SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer: Locate Doxia document source files in the site source context.
locateDocumentFiles(SiteRenderingContext, boolean) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer: Deprecated.
editable parameter is ignored since SiteRenderingContext.getSiteDirectories() contain this information on a per-directory basis now.
Logo - Class in org.apache.maven.doxia.site.decoration: Power by logo on the navigation.
Logo - Class in org.apache.maven.doxia.site: Power by logo on the navigation.
Logo() - Constructor for class org.apache.maven.doxia.site.decoration.Logo
Logo() - Constructor for class org.apache.maven.doxia.site.Logo

M

Menu - Class in org.apache.maven.doxia.site.decoration: A menu in the navigation.
Menu - Class in org.apache.maven.doxia.site: A menu in the navigation.
Menu() - Constructor for class org.apache.maven.doxia.site.decoration.Menu
Menu() - Constructor for class org.apache.maven.doxia.site.Menu
MenuItem - Class in org.apache.maven.doxia.site.decoration: A menu item.
MenuItem - Class in org.apache.maven.doxia.site: A menu item.
MenuItem() - Constructor for class org.apache.maven.doxia.site.decoration.MenuItem
MenuItem() - Constructor for class org.apache.maven.doxia.site.MenuItem
MERGE - Static variable in class org.apache.maven.doxia.site.decoration.DecorationModel
MERGE - Static variable in class org.apache.maven.doxia.site.SiteModel
mergeDocumentIntoSite(Writer, DocumentContent, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Generate a document output integrated in a site from a document content, i.e.
mergeDocumentIntoSite(Writer, DocumentContent, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer: Generate a document output integrated in a site from a document content, i.e.
MERMAID_VERSION - Static variable in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
MermaidConfiguration - Class in org.apache.maven.doxia.site: The configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side.
MermaidConfiguration() - Constructor for class org.apache.maven.doxia.site.MermaidConfiguration

O

org.apache.maven.doxia.scm.siterenderer - package org.apache.maven.doxia.scm.siterenderer
org.apache.maven.doxia.site - package org.apache.maven.doxia.site
org.apache.maven.doxia.site.decoration - package org.apache.maven.doxia.site.decoration
org.apache.maven.doxia.site.decoration.io.xpp3 - package org.apache.maven.doxia.site.decoration.io.xpp3
org.apache.maven.doxia.site.inheritance - package org.apache.maven.doxia.site.inheritance
org.apache.maven.doxia.site.io.xpp3 - package org.apache.maven.doxia.site.io.xpp3
org.apache.maven.doxia.site.skin - package org.apache.maven.doxia.site.skin
org.apache.maven.doxia.site.skin.io.xpp3 - package org.apache.maven.doxia.site.skin.io.xpp3
org.apache.maven.doxia.siterenderer - package org.apache.maven.doxia.siterenderer
org.apache.maven.doxia.siterenderer.sink - package org.apache.maven.doxia.siterenderer.sink
org.apache.maven.doxia.tools - package org.apache.maven.doxia.tools
OVERRIDE - Static variable in class org.apache.maven.doxia.site.decoration.DecorationModel
OVERRIDE - Static variable in class org.apache.maven.doxia.site.SiteModel

P

ParserConfigurator - Interface in org.apache.maven.doxia.siterenderer: Interface which allows to configure a particular Parser before it is being used.
populateReportsMenu(SiteModel, Locale, Map<String, List<MavenReport>>) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool: Populate the pre-defined reports menu of the site model, if used through <menu ref="reports"/>.
populateReportsMenu(SiteModel, Locale, Map<String, List<MavenReport>>) - Method in interface org.apache.maven.doxia.tools.SiteTool: Populate the pre-defined reports menu of the site model, if used through <menu ref="reports"/>.
Prerequisites - Class in org.apache.maven.doxia.site.skin: Describes the prerequisites a skin can have.
Prerequisites() - Constructor for class org.apache.maven.doxia.site.skin.Prerequisites
PublishDate - Class in org.apache.maven.doxia.site.decoration: Modify display properties for date published.
PublishDate - Class in org.apache.maven.doxia.site: Modify display properties for the date in the header/footer.
PublishDate() - Constructor for class org.apache.maven.doxia.site.decoration.PublishDate
PublishDate() - Constructor for class org.apache.maven.doxia.site.PublishDate
putAttribute(String, Object) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Puts an attribute in the context attributes map, this can be used to cache items per site rendering context.

R

read(InputStream) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader: Method read.
read(InputStream) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader: Method read.
read(InputStream) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader: Method read.
read(InputStream, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader: Method read.
read(InputStream, boolean) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader: Method read.
read(InputStream, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader: Method read.
read(Reader) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
read(Reader) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader
read(Reader) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
read(Reader, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
read(Reader, boolean) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader
read(Reader, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
read(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader: Method read.
read(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader: Method read.
read(XmlPullParser, boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader: Method read.
rebaseLink(String) - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor: Calculate the link as viewed from a different base.
relativizeLink() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor: Calculate the relative link with respect to the base.
removeAttribute(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Removes the mapping for a key from this attributes map if it is present.
removeBreadcrumb(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body: Method removeBreadcrumb.
removeBreadcrumb(LinkItem) - Method in class org.apache.maven.doxia.site.Body: Method removeBreadcrumb.
removeItem(MenuItem) - Method in class org.apache.maven.doxia.site.decoration.Menu: Method removeItem.
removeItem(MenuItem) - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Method removeItem.
removeItem(MenuItem) - Method in class org.apache.maven.doxia.site.Menu: Method removeItem.
removeItem(MenuItem) - Method in class org.apache.maven.doxia.site.MenuItem: Method removeItem.
removeLink(LinkItem) - Method in class org.apache.maven.doxia.site.decoration.Body: Method removeLink.
removeLink(LinkItem) - Method in class org.apache.maven.doxia.site.Body: Method removeLink.
removeMenu(Menu) - Method in class org.apache.maven.doxia.site.decoration.Body: Method removeMenu.
removeMenu(Menu) - Method in class org.apache.maven.doxia.site.Body: Method removeMenu.
removeMenuRef(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
removeMenuRef(String) - Method in class org.apache.maven.doxia.site.SiteModel
removePoweredBy(Logo) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Method removePoweredBy.
removePoweredBy(Logo) - Method in class org.apache.maven.doxia.site.SiteModel: Method removePoweredBy.
removeResourceCondition(ResourceCondition) - Method in class org.apache.maven.doxia.site.skin.SkinModel: Method removeResourceCondition.
removeResourceName(String) - Method in class org.apache.maven.doxia.site.skin.ResourceCondition: Method removeResourceName.
render(Collection<DocumentRenderer>, SiteRenderingContext, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Render a collection of documents into a site.
render(Collection<DocumentRenderer>, SiteRenderingContext, File) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer: Render a collection of documents into a site.
renderDocument(Writer, DocumentRenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer: Render a document written in a Doxia markup language.
renderDocument(Writer, DocumentRenderingContext, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.SiteRenderer: Render a document written in a Doxia markup language.
renderDocument(Writer, SiteRenderer, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer: Render a document in a site.
renderDocument(Writer, SiteRenderer, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer: Render a document in a site.
Renderer - Interface in org.apache.maven.doxia.siterenderer: Deprecated.
use SiteRenderer
RendererException - Exception Class in org.apache.maven.doxia.siterenderer: RendererException class.
RendererException(String) - Constructor for exception class org.apache.maven.doxia.siterenderer.RendererException: Construct a RendererException with a message.
RendererException(String, Throwable) - Constructor for exception class org.apache.maven.doxia.siterenderer.RendererException: Construct a RendererException with a message and a cause.
ReportComparator - Class in org.apache.maven.doxia.tools: Sorts reports.
ReportComparator(Locale) - Constructor for class org.apache.maven.doxia.tools.ReportComparator: Default constructor.
repositorySystem - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool: The component that is used to resolve additional required artifacts.
resolveLink() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor: Resolve the link to the base.
resolvePaths(SiteModel, String) - Method in class org.apache.maven.doxia.site.inheritance.DefaultSiteModelInheritanceAssembler: Resolve relative paths for a SiteModel given a base URL.
resolvePaths(SiteModel, String) - Method in interface org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler: Resolve relative paths for a SiteModel given a base URL.
ResourceCondition - Class in org.apache.maven.doxia.site.skin: Describes the condition for including a specific Skin resource.
ResourceCondition() - Constructor for class org.apache.maven.doxia.site.skin.ResourceCondition

S

sameSite(URI) - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor: Check if this URIPathDescriptor lives on the same site as the given URI.
ScmAttributesContextCustomizer - Class in org.apache.maven.doxia.scm.siterenderer: A ContextCustomizer that adds SCM attributes to the Velocity context for use in templates.
setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader: Sets the state of the "add default entities" flag.
setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader: Sets the state of the "add default entities" flag.
setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader: Sets the state of the "add default entities" flag.
setAlt(String) - Method in class org.apache.maven.doxia.site.decoration.Banner: Set the alt description for the banner image.
setAlt(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set the alt to use for the image.
setAlt(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set the alt description for the image.
setAlt(String) - Method in class org.apache.maven.doxia.site.Image: Set the alternative text to use.
setArtifactId(String) - Method in class org.apache.maven.doxia.site.decoration.Skin: Set the skin artifact ID.
setArtifactId(String) - Method in class org.apache.maven.doxia.site.Skin: Set the skin artifact ID.
setAttribute(String, String) - Method in class org.apache.maven.doxia.siterenderer.DocumentRenderingContext: setAttribute.
setBannerLeft(Banner) - Method in class org.apache.maven.doxia.site.SiteModel: Set banner logo on the masthead of the site to the left.
setBannerLeft(Banner) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set banner logo on the masthead of the site to the left.
setBannerRight(Banner) - Method in class org.apache.maven.doxia.site.SiteModel: Set banner logo on the masthead of the site to the right.
setBannerRight(Banner) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set banner logo on the masthead of the site to the right.
setBody(Body) - Method in class org.apache.maven.doxia.site.SiteModel: Set the main site content.
setBody(Body) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set the main site content decoration.
setBorder(String) - Method in class org.apache.maven.doxia.site.decoration.Banner: Set the border to use for the banner image.
setBorder(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set the border to use for the image.
setBorder(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set the border to use for the menu image.
setBreadcrumbs(List<LinkItem>) - Method in class org.apache.maven.doxia.site.decoration.Body: Set a list of breadcrumbs to display in the navigation.
setBreadcrumbs(List<LinkItem>) - Method in class org.apache.maven.doxia.site.Body: Set a list of breadcrumbs to display in the navigation.
setCollapse(boolean) - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Set whether to collapse children elements of an item menu (by default).
setCollapse(boolean) - Method in class org.apache.maven.doxia.site.MenuItem: Set whether to collapse children elements of an item menu (by default).
setCombineSelf(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set whether to inherit configuration from a parent project site descriptor (merge) or not (override).
setCombineSelf(String) - Method in class org.apache.maven.doxia.site.SiteModel: Set whether to inherit configuration from a parent project site descriptor (merge) or not (override).
setConfig(String) - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Set the Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.
setCustom(Object) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set custom configuration for use with customized Velocity templates.
setCustom(Object) - Method in class org.apache.maven.doxia.site.SiteModel: Set custom configuration for use with customized Velocity templates.
setDefaultTitle(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field defaultTitle.
setDescription(String) - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Set a description of the menu item.
setDoxiaSitetools(String) - Method in class org.apache.maven.doxia.site.skin.Prerequisites: Set the minimum version of Doxia Sitetools required to use the resulting skin.
setEdit(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set the base url to edit Doxia document sources.
setEdit(String) - Method in class org.apache.maven.doxia.site.SiteModel: Set the base url to edit Doxia document sources.
setEncoding(String) - Method in class org.apache.maven.doxia.site.skin.SkinModel: Set encoding of text content, like the Velocity template itself.
setExternalJs(ExternalJs) - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Set the URL from which to request the javascript used for rendering the diagrams.
setFallbackPrefix(String) - Method in class org.apache.maven.doxia.site.PublishDate: Set the prefix to emit in front of the fallback date.
setFallbackValue(String) - Method in class org.apache.maven.doxia.site.PublishDate: Set the Velocity context key to use as source for the date.
setFileComment(String) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer: Method setFileComment.
setFooter(String) - Method in class org.apache.maven.doxia.site.Body: Set if present, the contained text will be used instead of the generated copyright text.
setFooter(String) - Method in class org.apache.maven.doxia.site.decoration.Body: Set if present, the contained text will be used instead of the generated copyright text.
setFormat(String) - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Set date format to use.
setFormat(String) - Method in class org.apache.maven.doxia.site.PublishDate: Set date format to use.
setGroupId(String) - Method in class org.apache.maven.doxia.site.decoration.Skin: Set the skin group ID.
setGroupId(String) - Method in class org.apache.maven.doxia.site.Skin: Set the skin group ID.
setHead(String) - Method in class org.apache.maven.doxia.site.Body: Set additional content (like JavaScript) to include in the HEAD block of the generated pages.
setHead(String) - Method in class org.apache.maven.doxia.site.decoration.Body: Set additional content (like JavaScript) to include in the HEAD block of the generated pages.
setHeight(String) - Method in class org.apache.maven.doxia.site.decoration.Banner: Set the height to use for the banner image.
setHeight(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set the height to use for the image.
setHeight(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set the height to use for the menu image.
setHeight(String) - Method in class org.apache.maven.doxia.site.Image: Set the height to use.
setHref(String) - Method in class org.apache.maven.doxia.site.decoration.Banner: Set the href of a link to be used for the banner image.
setHref(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set the href to use for the link.
setHref(String) - Method in class org.apache.maven.doxia.site.LinkItem: Set the href to use for the link.
setImage(Image) - Method in class org.apache.maven.doxia.site.LinkItem: Set the image for the link.
setImage(Image) - Method in class org.apache.maven.doxia.site.Menu: Set the image for the menu.
setImg(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set the source location of an image.
setImg(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set the source location of an menu image.
setInherit(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set the way in which the menu is inherited.
setInherit(String) - Method in class org.apache.maven.doxia.site.Menu: Set the way in which the menu is inherited.
setInheritAsRef(boolean) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set if this is a reference, setting to true means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.
setInheritAsRef(boolean) - Method in class org.apache.maven.doxia.site.Menu: Set if this is a reference, setting to true means that it will be populated in the site, whereas if it is false, it is populated in the parent and then inherited.
setInputEncoding(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field inputEncoding.
setIntegrity(String) - Method in class org.apache.maven.doxia.site.ExternalJs: Set the integrity hash to use for the external JS file emitted in the "script" element's "integrity" attribute.
setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set a list of menu item.
setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Set a list of menu item.
setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.Menu: Set a list of menu item.
setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.MenuItem: Set a list of menu item.
setLastModified(long) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set timestamp of the last modification of this decoration model.
setLastModified(long) - Method in class org.apache.maven.doxia.site.SiteModel: Set timestamp of the last modification of this site model.
setLinks(List<LinkItem>) - Method in class org.apache.maven.doxia.site.decoration.Body: Set a list of links to display in the navigation.
setLinks(List<LinkItem>) - Method in class org.apache.maven.doxia.site.Body: Set a list of links to display in the navigation.
setLocale(Locale) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field locale.
setMenus(List<Menu>) - Method in class org.apache.maven.doxia.site.decoration.Body: Set a list of menus to include in the navigation.
setMenus(List<Menu>) - Method in class org.apache.maven.doxia.site.Body: Set a list of menus to include in the navigation.
setMermaid(MermaidConfiguration) - Method in class org.apache.maven.doxia.site.SiteModel: Set the configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side.
setModelEncoding(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set the modelEncoding field.
setModelEncoding(String) - Method in class org.apache.maven.doxia.site.SiteModel: Set the modelEncoding field.
setModelEncoding(String) - Method in class org.apache.maven.doxia.site.skin.SkinModel: Set the modelEncoding field.
setModuleExcludes(Map<String, String>) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field moduleExcludes.
setName(String) - Method in class org.apache.maven.doxia.site.decoration.Banner: Set the name of the banner.
setName(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set the full name of the project.
setName(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set the name to display for the link.
setName(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set the name to display for the menu.
setName(String) - Method in class org.apache.maven.doxia.site.LinkItem: Set the name to display for the link.
setName(String) - Method in class org.apache.maven.doxia.site.Menu: Set the name to display for the menu.
setName(String) - Method in class org.apache.maven.doxia.site.SiteModel: Set the full name of the project site.
setOtherAttributes(String) - Method in class org.apache.maven.doxia.site.ExternalJs: Set other attributes to include in the "script" element for this external JS file, in the form of a whitespace separated list of key=value pairs.
setOutputEncoding(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field outputEncoding.
setParserConfigurator(ParserConfigurator) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Set the configurator to use for parsers.
setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set where to place the image regarding the displayed name (left or right).
setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set where to place the image regarding the displayed name (left or right).
setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Set where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.Version: Set where to place the version published (left, right, navigation-top, navigation-bottom, bottom).
setPosition(String) - Method in class org.apache.maven.doxia.site.Image: Set where to place the image relative to the displayed name (left or right).
setPosition(String) - Method in class org.apache.maven.doxia.site.PublishDate: Set where to place the date published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
setPosition(String) - Method in class org.apache.maven.doxia.site.Version: Set where to place the version published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
setPoweredBy(List<Logo>) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set powered by logos list.
setPoweredBy(List<Logo>) - Method in class org.apache.maven.doxia.site.SiteModel: Set powered by logos list.
setPrefix(String) - Method in class org.apache.maven.doxia.site.PublishDate: Set the prefix to emit in front of the date.
setPrerequisites(Prerequisites) - Method in class org.apache.maven.doxia.site.skin.SkinModel: Set describes the prerequisites in the build environment for using this skin.
setProcessedContentOutput(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Where to (eventually) save content after Velocity processing (*.vm), but before parsing it with Doxia?
setPublishDate(Date) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Specify a specific publish date instead of the current date.
setPublishDate(PublishDate) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set modify the date published display properties.
setPublishDate(PublishDate) - Method in class org.apache.maven.doxia.site.SiteModel: Set modify the date published display properties.
setRef(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set mark this menu as reference to a pre-defined menu: reports, modules or parent.
setRef(String) - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Set a reference to a pre-defined menu item, such as a report (specified by the report goal name).
setRef(String) - Method in class org.apache.maven.doxia.site.Menu: Set mark this menu as reference to a pre-defined menu: reports, modules or parent.
setRef(String) - Method in class org.apache.maven.doxia.site.MenuItem: Set a reference to a pre-defined menu item, such as a report (specified by the report goal name).
setReferrerpolicy(String) - Method in class org.apache.maven.doxia.site.ExternalJs: Set the referrerpolicy attribute to use when requesting the external JS file.
setRequireParent(boolean) - Method in class org.apache.maven.doxia.site.SiteModel: Set whether this "site.xml" should inherit from a parent "site.xml".
setResourceConditions(List<ResourceCondition>) - Method in class org.apache.maven.doxia.site.skin.SkinModel: Set resource conditions.
setResourceNames(List<String>) - Method in class org.apache.maven.doxia.site.skin.ResourceCondition: Set a resource name to which this condition applies.
setRootDirectory(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Set the root directory.
setSiteModel(SiteModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field siteModel.
setSkin(Artifact) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field skinJarFile.
setSkin(Skin) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set the artifact containing the skin for the site.
setSkin(Skin) - Method in class org.apache.maven.doxia.site.SiteModel: Set the artifact containing the skin for the site.
setSkinModel(SkinModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field skinModel.
setSrc(String) - Method in class org.apache.maven.doxia.site.decoration.Banner: Set the source location of an image for the banner.
setSrc(String) - Method in class org.apache.maven.doxia.site.Image: Set the source location.
setStyle(String) - Method in class org.apache.maven.doxia.site.Image: Set the style to use.
setTarget(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set where the new document will be displayed when the user follows a link, i.e.
setTarget(String) - Method in class org.apache.maven.doxia.site.LinkItem: Set where the new document will be displayed when the user follows a link, i.e.
setTemplateClassLoader(ClassLoader) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field templateClassLoader.
setTemplateName(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field templateName.
setTemplateProperties(Map<String, ?>) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Setter for the field templateProperties.
setTimezone(String) - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Set the timezone to use.
setTimezone(String) - Method in class org.apache.maven.doxia.site.PublishDate: Set the timezone to use.
setTitle(String) - Method in class org.apache.maven.doxia.site.decoration.Banner: Set the title for the banner image.
setTitle(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set the title to use for the image.
setTitle(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set the title for the image.
setURL(String) - Method in class org.apache.maven.doxia.site.ExternalJs: Set the URL to include via "script" element with its "src" attribute in the HTML.
setUseTiny(boolean) - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Set if Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used.
setValidate(boolean) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Switch on/off validation.
setValue(String) - Method in class org.apache.maven.doxia.site.PublishDate: Set the Velocity context key to use as source for the date.
setVersion(String) - Method in class org.apache.maven.doxia.site.decoration.Skin: Set the skin version.
setVersion(String) - Method in class org.apache.maven.doxia.site.Skin: Set the skin version.
setVersion(Version) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Set modify the version published display properties.
setVersion(Version) - Method in class org.apache.maven.doxia.site.SiteModel: Set modify the version published display properties.
setVtlCondition(String) - Method in class org.apache.maven.doxia.site.skin.ResourceCondition: Set the Velocity (VTL) expression to be evaluated to decide if the resource should be included.
setWidth(String) - Method in class org.apache.maven.doxia.site.decoration.Banner: Set the width to use for the banner image.
setWidth(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Set the width to use for the image.
setWidth(String) - Method in class org.apache.maven.doxia.site.decoration.Menu: Set the width to use for the menu image.
setWidth(String) - Method in class org.apache.maven.doxia.site.Image: Set the width to use.
SiteDirectory(File, boolean) - Constructor for class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
SiteDirectory(File, boolean, boolean) - Constructor for class org.apache.maven.doxia.siterenderer.SiteRenderingContext.SiteDirectory
SiteModel - Class in org.apache.maven.doxia.site: The <site> element is the root of the site decoration descriptor.
SiteModel() - Constructor for class org.apache.maven.doxia.site.SiteModel
SiteModelInheritanceAssembler - Interface in org.apache.maven.doxia.site.inheritance: Manage inheritance of the site model.
SiteRenderer - Interface in org.apache.maven.doxia.siterenderer: Site Renderer interface: render a collection of documents into a site, ie decorated with a site template.
SiteRendererSink - Class in org.apache.maven.doxia.siterenderer.sink: Sink for site rendering of a document, to allow later merge document's output with a template.
SiteRendererSink(DocumentRenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Construct a new SiteRendererSink for a document.
SiteRendererSink(DocumentRenderingContext, MermaidConfiguration) - Constructor for class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
SiteRenderingContext - Class in org.apache.maven.doxia.siterenderer: Context for a site rendering.
SiteRenderingContext() - Constructor for class org.apache.maven.doxia.siterenderer.SiteRenderingContext
SiteRenderingContext.SiteDirectory - Class in org.apache.maven.doxia.siterenderer
SiteTool - Interface in org.apache.maven.doxia.tools: Tool to play with Doxia objects like SiteModel.
SiteToolException - Exception Class in org.apache.maven.doxia.tools: An exception occurring during the execution of this tool.
SiteToolException(String) - Constructor for exception class org.apache.maven.doxia.tools.SiteToolException: Construct a new SiteToolException exception providing a message.
SiteToolException(String, Exception) - Constructor for exception class org.apache.maven.doxia.tools.SiteToolException: Construct a new SiteToolException exception wrapping an underlying Exception and providing a message.
SiteToolException(String, Throwable) - Constructor for exception class org.apache.maven.doxia.tools.SiteToolException: Construct a new SiteToolException exception wrapping an underlying Throwable and providing a message.
SiteUtils - Class in org.apache.maven.doxia.site: Site model utilities.
SiteUtils() - Constructor for class org.apache.maven.doxia.site.SiteUtils
SiteXpp3Reader - Class in org.apache.maven.doxia.site.io.xpp3: Class SiteXpp3Reader.
SiteXpp3Reader() - Constructor for class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader
SiteXpp3Reader(SiteXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader
SiteXpp3Reader.ContentTransformer - Interface in org.apache.maven.doxia.site.io.xpp3
SiteXpp3Writer - Class in org.apache.maven.doxia.site.io.xpp3: Class SiteXpp3Writer.
SiteXpp3Writer() - Constructor for class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer
Skin - Class in org.apache.maven.doxia.site.decoration: A skin artifact declaration.
Skin - Class in org.apache.maven.doxia.site: A skin artifact declaration.
Skin() - Constructor for class org.apache.maven.doxia.site.decoration.Skin
Skin() - Constructor for class org.apache.maven.doxia.site.Skin
SKIN_DESCRIPTOR_LOCATION - Static variable in class org.apache.maven.doxia.site.skin.SkinModel
SkinModel - Class in org.apache.maven.doxia.site.skin: The <skin> element is the root of the skin descriptor.
SkinModel() - Constructor for class org.apache.maven.doxia.site.skin.SkinModel
SkinXpp3Reader - Class in org.apache.maven.doxia.site.skin.io.xpp3: Class SkinXpp3Reader.
SkinXpp3Reader() - Constructor for class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
SkinXpp3Reader(SkinXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader
SkinXpp3Reader.ContentTransformer - Interface in org.apache.maven.doxia.site.skin.io.xpp3
startsWithAnyIgnoreCase(String, String...) - Static method in class org.apache.maven.doxia.site.SiteUtils

T

title(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Reset text buffer, since text content before title must not be in title.
title_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
toString() - Method in class org.apache.maven.doxia.site.Body: Method toString.
toString() - Method in class org.apache.maven.doxia.site.decoration.Banner: Method toString.
toString() - Method in class org.apache.maven.doxia.site.decoration.Body: Method toString.
toString() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel: Method toString.
toString() - Method in class org.apache.maven.doxia.site.decoration.LinkItem: Method toString.
toString() - Method in class org.apache.maven.doxia.site.decoration.Menu: Method toString.
toString() - Method in class org.apache.maven.doxia.site.decoration.MenuItem: Method toString.
toString() - Method in class org.apache.maven.doxia.site.decoration.PublishDate: Method toString.
toString() - Method in class org.apache.maven.doxia.site.decoration.Skin: Method toString.
toString() - Method in class org.apache.maven.doxia.site.decoration.Version: Method toString.
toString() - Method in class org.apache.maven.doxia.site.ExternalJs: Method toString.
toString() - Method in class org.apache.maven.doxia.site.Image: Method toString.
toString() - Method in class org.apache.maven.doxia.site.inheritance.URIPathDescriptor: Construct a string representation of this URIPathDescriptor.
toString() - Method in class org.apache.maven.doxia.site.LinkItem: Method toString.
toString() - Method in class org.apache.maven.doxia.site.Menu: Method toString.
toString() - Method in class org.apache.maven.doxia.site.MenuItem: Method toString.
toString() - Method in class org.apache.maven.doxia.site.MermaidConfiguration: Method toString.
toString() - Method in class org.apache.maven.doxia.site.PublishDate: Method toString.
toString() - Method in class org.apache.maven.doxia.site.SiteModel: Method toString.
toString() - Method in class org.apache.maven.doxia.site.Skin: Method toString.
toString() - Method in class org.apache.maven.doxia.site.Version: Method toString.
transform(String, String) - Method in interface org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader.ContentTransformer: Interpolate the value read from the xpp3 document
transform(String, String) - Method in interface org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader.ContentTransformer: Interpolate the value read from the xpp3 document
transform(String, String) - Method in interface org.apache.maven.doxia.site.skin.io.xpp3.SkinXpp3Reader.ContentTransformer: Interpolate the value read from the xpp3 document

U

URIPathDescriptor - Class in org.apache.maven.doxia.site.inheritance: Describes a link that may be absolute or relative, and that is anchored to an absolute URI.
URIPathDescriptor(String, String) - Constructor for class org.apache.maven.doxia.site.inheritance.URIPathDescriptor: A URIPathDescriptor consists of a base URI and a link.

V

verbatim(SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
verbatim_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
Version - Class in org.apache.maven.doxia.site.decoration: Modify display properties for version published.
Version - Class in org.apache.maven.doxia.site: Modify display properties for version published.
Version() - Constructor for class org.apache.maven.doxia.site.decoration.Version
Version() - Constructor for class org.apache.maven.doxia.site.Version

W

write(OutputStream, SiteModel) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer: Method write.
write(Writer, SiteModel) - Method in class org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer: Method write.
write(String) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

A B C D E G H I L M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form