Interface DocumentRenderer
- All Known Subinterfaces:
PdfRenderer
- All Known Implementing Classes:
AbstractDocumentRenderer
,AbstractPdfRenderer
,FoPdfRenderer
Deprecated.
Base interface for rendering documents from a set of input files.
- Since:
- 1.1
- Author:
- Vincent Siveton, ltheussl
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Get the output extension associated with this DocumentRenderer.org.apache.maven.doxia.document.DocumentModel
readDocumentModel
(File documentDescriptor) Deprecated.Read a document model from a file.void
render
(File baseDirectory, File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel) Deprecated.Render a document from the files found in a source directory, depending on a rendering context.void
render
(Collection<String> files, File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel) Deprecated.Render a document from a set of files, depending on a rendering context.
-
Field Details
-
ROLE
Deprecated.Plexus lookup role.
-
-
Method Details
-
render
void render(Collection<String> files, File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel) throws DocumentRendererException, IOException Deprecated.Render a document from a set of files, depending on a rendering context.- Parameters:
files
- the path name Strings (relative to a common base directory) of files to include in the document generation.outputDirectory
- the output directory where the document should be generated.documentModel
- the document model, containing all the metadata, etc. If the model contains a TOC, only the files found in this TOC are rendered, otherwise all files from the Collection of files will be processed. If the model is null, render all files individually.- Throws:
DocumentRendererException
- if any.IOException
- if any.
-
render
void render(File baseDirectory, File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel) throws DocumentRendererException, IOException Deprecated.Render a document from the files found in a source directory, depending on a rendering context.- Parameters:
baseDirectory
- the directory containing the source files. This should follow the standard Maven convention, ie containing all the site modules.outputDirectory
- the output directory where the document should be generated.documentModel
- the document model, containing all the metadata, etc. If the model contains a TOC, only the files found in this TOC are rendered, otherwise all files found under baseDirectory will be processed. If the model is null, render all files from baseDirectory individually.- Throws:
DocumentRendererException
- if anyIOException
- if any
-
readDocumentModel
org.apache.maven.doxia.document.DocumentModel readDocumentModel(File documentDescriptor) throws DocumentRendererException, IOException Deprecated.Read a document model from a file.- Parameters:
documentDescriptor
- a document descriptor file that contains the document model.- Returns:
- the document model, containing all the metadata, etc.
- Throws:
DocumentRendererException
- if anyIOException
- if any
-
getOutputExtension
String getOutputExtension()Deprecated.Get the output extension associated with this DocumentRenderer.- Returns:
- the ouput extension.
-