org.apache.maven.doxia.siterenderer

Interface SiteRenderer

All Known Subinterfaces:

Renderer

All Known Implementing Classes:

DefaultSiteRenderer

public interface SiteRenderer

Site Renderer interface: render a collection of documents into a site, ie decorated with a site template.

Author:

Emmanuel Venisse

Method Summary

Modifier and Type	Method and Description
void	copyResources(SiteRenderingContext siteRenderingContext, File outputDirectory) Copy resource files from skin, template, and site resources.
SiteRenderingContext	createContextForSkin(org.apache.maven.artifact.Artifact skin, Map<String,?> attributes, SiteModel siteModel, String defaultTitle, Locale locale) Create a Site Rendering Context for a site using a skin.
Map<String,DocumentRenderer>	locateDocumentFiles(SiteRenderingContext siteRenderingContext) Locate Doxia document source files in the site source context.
default Map<String,DocumentRenderer>	locateDocumentFiles(SiteRenderingContext siteRenderingContext, boolean editable) Deprecated. editable parameter is ignored since SiteRenderingContext.getSiteDirectories() contain this information on a per-directory basis now.
void	mergeDocumentIntoSite(Writer writer, DocumentContent content, SiteRenderingContext siteRenderingContext) Generate a document output integrated in a site from a document content, i.e.
void	render(Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory) Render a collection of documents into a site.
void	renderDocument(Writer writer, DocumentRenderingContext docRenderingContext, SiteRenderingContext siteContext) Render a document written in a Doxia markup language.

Method Detail

render

void render(Collection<DocumentRenderer> documents,
            SiteRenderingContext siteRenderingContext,
            File outputDirectory)
     throws RendererException,
            IOException

Render a collection of documents into a site.

Parameters:

documents - the documents to render.

siteRenderingContext - the SiteRenderingContext to use.

outputDirectory - the output directory to write results.

Throws:

RendererException - if it bombs.

IOException - if it bombs.

mergeDocumentIntoSite

void mergeDocumentIntoSite(Writer writer,
                           DocumentContent content,
                           SiteRenderingContext siteRenderingContext)
                    throws IOException,
                           RendererException

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

Parameters:

writer - the Writer to use.

content - the document content to be merged.

siteRenderingContext - the SiteRenderingContext to use.

Throws:

IOException - if it bombs.

RendererException - if it bombs.

Since:

1.8

createContextForSkin

SiteRenderingContext createContextForSkin(org.apache.maven.artifact.Artifact skin,
                                          Map<String,?> attributes,
                                          SiteModel siteModel,
                                          String defaultTitle,
                                          Locale locale)
                                   throws RendererException,
                                          IOException

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

Parameters:

skin - a skin

attributes - attributes to use

siteModel - a site model

defaultTitle - default title

locale - locale to use

Returns:

a SiteRenderingContext.

Throws:

RendererException - if it bombs.

IOException - if it bombs.

Since:

1.7.3 was previously with skin as File instead of Artifact

copyResources

void copyResources(SiteRenderingContext siteRenderingContext,
                   File outputDirectory)
            throws IOException

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

Parameters:

siteRenderingContext - the SiteRenderingContext to use.

outputDirectory - output directory as file

Throws:

IOException - if it bombs.

Since:

1.7

locateDocumentFiles

Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext)
                                          throws IOException,
                                                 RendererException

Locate Doxia document source files in the site source context.

Parameters:

siteRenderingContext - the SiteRenderingContext to use

Returns:

the Doxia document renderers in a Map keyed by output file path.

Throws:

IOException - if it bombs.

RendererException - if it bombs.

Since:

2.0.0

locateDocumentFiles

@Deprecated
default Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext,
                                                                      boolean editable)
                                                               throws IOException,
                                                                      RendererException

Deprecated. editable parameter is ignored since SiteRenderingContext.getSiteDirectories() contain this information on a per-directory basis now.

Throws:

IOException

RendererException

Since:

1.8

See Also:

locateDocumentFiles(SiteRenderingContext)

renderDocument

void renderDocument(Writer writer,
                    DocumentRenderingContext docRenderingContext,
                    SiteRenderingContext siteContext)
             throws IOException,
                    RendererException

Render a document written in a Doxia markup language. This method is an internal method, used by DoxiaDocumentRenderer.

Parameters:

writer - the writer to render the document to.

docRenderingContext - the document's rendering context, which is expected to have a non-null parser id.

siteContext - the site's rendering context

Throws:

IOException - if it bombs.

RendererException - if it bombs.