A

addModuleDirectory(File, String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Add a extra-module source directory: used for Maven 1.x ${basedir}/xdocs layout, which contains xdoc and fml.

addSiteDirectory(File) - 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.

anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

author() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

author_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

B

body() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

Do nothing.

body_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

Do nothing.

C

copyDirectory(File, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Copy the directory

copyResources(SiteRenderingContext, File, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Copy resource files.

copyResources(SiteRenderingContext, File) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Copy resource files from skin, template, and site resources.

copyResources(SiteRenderingContext, File, File) - Method in interface org.apache.maven.doxia.siterenderer.Renderer

Deprecated.

since 1.7, use copyResources without resourcesDirectory parameter

copyResources(SiteRenderingContext, File) - Method in interface org.apache.maven.doxia.siterenderer.Renderer

Copy resource files from skin, template, and site resources.

createContextForSkin(Artifact, Map<String, ?>, DecorationModel, 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, ?>, DecorationModel, String, Locale) - Method in interface org.apache.maven.doxia.siterenderer.Renderer

Create a Site Rendering Context for a site using a skin.

createContextForTemplate(File, Map<String, ?>, DecorationModel, String, Locale) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Deprecated.

createContextForTemplate(File, Map<String, ?>, DecorationModel, String, Locale) - Method in interface org.apache.maven.doxia.siterenderer.Renderer

Deprecated.

Deprecated without replacement, use skins only.

createDocumentVelocityContext(RenderingContext, 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.

D

date() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

date_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

DefaultSiteRenderer - Class in org.apache.maven.doxia.siterenderer

DefaultSiteRenderer class.

DefaultSiteRenderer() - Constructor for class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

 

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.

DoxiaDocumentRenderer - Class in org.apache.maven.doxia.siterenderer

Renderer for a document that has a source file to be parsed by Doxia.

DoxiaDocumentRenderer(RenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer

Constructor.

G

generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Generate a document output from a Doxia SiteRenderer Sink, i.e. merge the document content into the site template.

generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.Renderer

Deprecated.

since 1.8, use mergeDocumentIntoSite

getAttribute(String) - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

getAttribute.

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.

getBasedir() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Getter for the field basedir.

getBasedirRelativePath() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Get the relative path of basedir (when a Doxia source)

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.

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.

getDecoration() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Getter for the field decoration.

getDefaultWindowTitle() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Getter for the field defaultWindowTitle.

getDoxiaSourcePath() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Get the relative path to Doxia source from build root.

getDoxiaSourcePath(String) - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Get url of the Doxia source calculate from given base url.

getExtension() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Get the source document filename extension (when a Doxia source)

getGenerator() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

What is the generator (if any)?

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.

getInputEncoding() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Getter for the field inputEncoding.

getInputName() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Getter for the field inputName.

getLastModified(Resource) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader

Deprecated.

 

getLocale() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Getter for the field locale.

getModuleExcludes() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Getter for the field moduleExcludes.

getModules() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Getter for the field modules.

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

The name of the output document.

getOutputName() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer

The name of the output document.

getOutputName() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Get html output name, relative to site root.

getParserId() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Get the parserId when document comes from a Doxia source.

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.siterenderer.SiteRenderingContext

If you want to specify a specific publish date instead of the current date.

getRelativePath() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Get the relative path to site root.

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 RenderingContext of the document.

getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer

Return the RenderingContext of the document.

getRenderingContext() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

Get the document rendering context.

getResourceStream(String) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader

Deprecated.

 

getRootDirectory() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Root directory, to calculate relative path to every site directories.

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.

getSkin() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Getter for the field skin.

getSkinModel() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Getter for the field skinModel.

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.

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.

H

head() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

head_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

I

init(ExtendedProperties) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader

Deprecated.

 

isDoxiaSource() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Is the document rendered from a Doxia source?

isEditable() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

Is the source document editable?

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

 

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.

isSourceModified(Resource) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader

Deprecated.

 

isUsingDefaultTemplate() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

isUsingDefaultTemplate.

isValidate() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

If input documents should be validated before parsing.

L

locateDocumentFiles(SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Locate Doxia document source files in the site source context.

locateDocumentFiles(SiteRenderingContext, boolean) - 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.Renderer

Deprecated.

since 1.8, use locateDocumentFiles with editable parameter

locateDocumentFiles(SiteRenderingContext, boolean) - Method in interface org.apache.maven.doxia.siterenderer.Renderer

Locate Doxia document source files in the site source context.

M

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. merge the document content into the site template.

mergeDocumentIntoSite(Writer, DocumentContent, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.Renderer

Generate a document output integrated in a site from a document content, i.e. merge the document content into the site template.

O

onSectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

onSectionTitle_(int) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

org.apache.maven.doxia.siterenderer - package org.apache.maven.doxia.siterenderer

 

org.apache.maven.doxia.siterenderer.sink - package org.apache.maven.doxia.siterenderer.sink

 

R

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.Renderer

Render a collection of documents into a site.

renderDocument(Writer, RenderingContext, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Render a document written in a Doxia markup language.

renderDocument(Writer, Renderer, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer

Render a document in a site.

renderDocument(Writer, Renderer, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer

Render a document in a site.

renderDocument(Writer, RenderingContext, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.Renderer

Render a document written in a Doxia markup language.

Renderer - Interface in org.apache.maven.doxia.siterenderer

Site Renderer interface: render a collection of documents into a site, ie decored with a site template (eventually packaged as skin).

RendererException - Exception in org.apache.maven.doxia.siterenderer

RendererException class.

RendererException(String) - Constructor for exception org.apache.maven.doxia.siterenderer.RendererException

Construct a RendererException with a message.

RendererException(String, Throwable) - Constructor for exception org.apache.maven.doxia.siterenderer.RendererException

Construct a RendererException with a message and a cause.

RenderingContext - Class in org.apache.maven.doxia.siterenderer

The rendering context of a document.

RenderingContext(File, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext

Deprecated.

RenderingContext(File, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext

Constructor for RenderingContext when document is not rendered from a Doxia markup source.

RenderingContext(File, String, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext

Deprecated.

RenderingContext(File, String, String, String, String, boolean) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext

 

RenderingContext(File, String, String, String, String, boolean, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext

Constructor for document RenderingContext.

ROLE - Static variable in interface org.apache.maven.doxia.siterenderer.Renderer

Plexus lookup role.

S

setAttribute(String, String) - Method in class org.apache.maven.doxia.siterenderer.RenderingContext

setAttribute.

setDecoration(DecorationModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Setter for the field decoration.

setDefaultWindowTitle(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Setter for the field defaultWindowTitle.

setInputEncoding(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Setter for the field inputEncoding.

setLocale(Locale) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Setter for the field locale.

setModuleExcludes(Map<String, String>) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Setter for the field moduleExcludes.

setOutputEncoding(String) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Setter for the field outputEncoding.

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.

setRootDirectory(File) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Set the root directory.

setSkin(Artifact) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Setter for the field skinJarFile.

setSkinModel(SkinModel) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Setter for the field skinModel.

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.

setUsingDefaultTemplate(boolean) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Setter for the field usingDefaultTemplate.

setValidate(boolean) - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext

Switch on/off validation.

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(RenderingContext) - Constructor for class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

Construct a new SiteRendererSink for a document.

SiteRenderingContext - Class in org.apache.maven.doxia.siterenderer

Context for a site rendering.

SiteRenderingContext() - Constructor for class org.apache.maven.doxia.siterenderer.SiteRenderingContext

 

SkinResourceLoader - Class in org.apache.maven.doxia.siterenderer

Deprecated.

SkinResourceLoader() - Constructor for class org.apache.maven.doxia.siterenderer.SkinResourceLoader

Deprecated.

 

T

text(String) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

title() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

Reset text buffer, since text content before title mustn't be in title.

title_() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink

W

write(String) - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink