public interface Renderer
Site Renderer interface: render a collection of documents into a site, ie decored with a site template (eventually packaged as skin).
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ROLE
Plexus lookup role.
|
Modifier and Type | Method and Description |
---|---|
void |
copyResources(SiteRenderingContext siteRenderingContext,
java.io.File outputDirectory)
Copy resource files from skin, template, and site resources.
|
void |
copyResources(SiteRenderingContext siteRenderingContext,
java.io.File resourcesDirectory,
java.io.File outputDirectory)
Deprecated.
since 1.7, use copyResources without resourcesDirectory parameter
|
SiteRenderingContext |
createContextForSkin(org.apache.maven.artifact.Artifact skin,
java.util.Map<java.lang.String,?> attributes,
DecorationModel decoration,
java.lang.String defaultWindowTitle,
java.util.Locale locale)
Create a Site Rendering Context for a site using a skin.
|
SiteRenderingContext |
createContextForTemplate(java.io.File templateFile,
java.util.Map<java.lang.String,?> attributes,
DecorationModel decoration,
java.lang.String defaultWindowTitle,
java.util.Locale locale)
Deprecated.
Deprecated without replacement, use skins only.
|
void |
generateDocument(java.io.Writer writer,
SiteRendererSink sink,
SiteRenderingContext siteRenderingContext)
Deprecated.
since 1.8, use mergeDocumentIntoSite
|
java.util.Map<java.lang.String,DocumentRenderer> |
locateDocumentFiles(SiteRenderingContext siteRenderingContext)
Deprecated.
since 1.8, use locateDocumentFiles with editable parameter
|
java.util.Map<java.lang.String,DocumentRenderer> |
locateDocumentFiles(SiteRenderingContext siteRenderingContext,
boolean editable)
Locate Doxia document source files in the site source context.
|
void |
mergeDocumentIntoSite(java.io.Writer writer,
DocumentContent content,
SiteRenderingContext siteRenderingContext)
Generate a document output integrated in a site from a document content,
i.e.
|
void |
render(java.util.Collection<DocumentRenderer> documents,
SiteRenderingContext siteRenderingContext,
java.io.File outputDirectory)
Render a collection of documents into a site.
|
void |
renderDocument(java.io.Writer writer,
RenderingContext docRenderingContext,
SiteRenderingContext siteContext)
Render a document written in a Doxia markup language.
|
void render(java.util.Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, java.io.File outputDirectory) throws RendererException, java.io.IOException
documents
- the documents to render.siteRenderingContext
- the SiteRenderingContext to use.outputDirectory
- the output directory to write results.RendererException
- if it bombs.java.io.IOException
- if it bombs.void generateDocument(java.io.Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) throws RendererException
writer
- the Writer to use.sink
- the Site Renderer Sink that received the Doxia events during document content rendering.siteRenderingContext
- the SiteRenderingContext to use.RendererException
- if it bombs.void mergeDocumentIntoSite(java.io.Writer writer, DocumentContent content, SiteRenderingContext siteRenderingContext) throws RendererException
writer
- the Writer to use.content
- the document content to be mergedsiteRenderingContext
- the SiteRenderingContext to use.RendererException
- if it bombs.SiteRenderingContext createContextForSkin(org.apache.maven.artifact.Artifact skin, java.util.Map<java.lang.String,?> attributes, DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale) throws RendererException, java.io.IOException
skin
- attributes
- decoration
- defaultWindowTitle
- locale
- java.io.IOException
- if it bombs.RendererException
@Deprecated SiteRenderingContext createContextForTemplate(java.io.File templateFile, java.util.Map<java.lang.String,?> attributes, DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale) throws java.net.MalformedURLException
templateFile
- attributes
- decoration
- defaultWindowTitle
- locale
- java.net.MalformedURLException
- if it bombs.#createContextForSkin(File, Map, DecorationModel, String, Locale)
void copyResources(SiteRenderingContext siteRenderingContext, java.io.File resourcesDirectory, java.io.File outputDirectory) throws java.io.IOException
siteRenderingContext
- resourcesDirectory
- outputDirectory
- java.io.IOException
- if it bombs.void copyResources(SiteRenderingContext siteRenderingContext, java.io.File outputDirectory) throws java.io.IOException
siteRenderingContext
- outputDirectory
- java.io.IOException
- if it bombs.java.util.Map<java.lang.String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext) throws java.io.IOException, RendererException
siteRenderingContext
- java.io.IOException
- if it bombs.RendererException
- if it bombs.java.util.Map<java.lang.String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext, boolean editable) throws java.io.IOException, RendererException
siteRenderingContext
- mark
- Doxia document renderer as editable? (should not mark editable if generated Doxia source)java.io.IOException
- if it bombs.RendererException
- if it bombs.void renderDocument(java.io.Writer writer, RenderingContext docRenderingContext, SiteRenderingContext siteContext) throws RendererException, java.io.FileNotFoundException, java.io.UnsupportedEncodingException
DoxiaDocumentRenderer
.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 contextRendererException
- if it bombs.java.io.FileNotFoundException
- if it bombs.java.io.UnsupportedEncodingException
- if it bombs.