Index (Doxia :: Site Renderer 1.7 API)

A B C D G H I L O R S T W

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(File, 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(File, 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(SiteRendererSink, 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
DocumentRenderer - Interface in org.apache.maven.doxia.siterenderer: Renders a page, 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.
generateDocument(Writer, SiteRendererSink, SiteRenderingContext) - Method in interface org.apache.maven.doxia.siterenderer.Renderer: Generate a document output from a Doxia SiteRenderer Sink.
getAttribute(String) - Method in class org.apache.maven.doxia.siterenderer.RenderingContext: getAttribute.
getAuthors() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Getter for the field authors.
getBasedir() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext: Getter for the field basedir.
getBody() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: getBody.
getDate() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Getter for the field date.
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.
getExtension() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext: Getter for the field extension.
getHead() - Method in class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: getHead.
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
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: Getter for the field outputName.
getParserId() - Method in class org.apache.maven.doxia.siterenderer.RenderingContext: Getter for the field parserId.
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: Getter for the field relativePath.
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: Getter for the field renderingContext.
getResourceStream(String) - Method in class org.apache.maven.doxia.siterenderer.SkinResourceLoader
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.
getSkinJarFile() - Method in class org.apache.maven.doxia.siterenderer.SiteRenderingContext: Getter for the field skinJarFile.
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 class org.apache.maven.doxia.siterenderer.sink.SiteRendererSink: Getter for the field title.

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
isExternalReport() - Method in interface org.apache.maven.doxia.siterenderer.DocumentRenderer: Whether this document is an external report.
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
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) - Method in interface org.apache.maven.doxia.siterenderer.Renderer: Locate Doxia document source files in the site source context.

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.
renderDocument(Writer, Renderer, SiteRenderingContext) - Method in class org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer: Render a document.
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: Constructor for RenderingContext when document is not rendered from a Doxia source.
RenderingContext(File, String, String, String) - Constructor for class org.apache.maven.doxia.siterenderer.RenderingContext: Constructor for 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.
setSkinJarFile(File) - 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: Skin resource loader: gets content from context classloader, which should contain skin artifact, and normalizes newlines (see DOXIASITETOOLS-87.
SkinResourceLoader() - Constructor for class org.apache.maven.doxia.siterenderer.SkinResourceLoader

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

A B C D G H I L O R S T W