org.apache.maven.doxia.docrenderer

Interface DocRenderer

All Known Subinterfaces:

PdfRenderer, RtfRenderer

All Known Implementing Classes:

AbstractITextRender, DefaultPdfRenderer, DefaultRtfRenderer

Deprecated.

Since 1.1, use DocumentRenderer instead.

public interface DocRenderer

Base renderer interface for the document

Version:

$Id: DocRenderer.java 1072376 2011-02-19 16:28:01Z hboutemy $

Author:

Vincent Siveton

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE Deprecated. Plexus lookup.

Method Summary

Modifier and Type	Method and Description
String	getOutputExtension() Deprecated. Get the output extension supported
void	render(File siteDirectory, File outputDirectory) Deprecated. Render all files from a site directory to an output directory
void	render(File siteDirectory, File outputDirectory, File documentDescriptor) Deprecated. Render a document depending a context and a document descriptor

Field Detail

ROLE

static final String ROLE

Deprecated.

Plexus lookup.

Method Detail

render

void render(File siteDirectory,
            File outputDirectory)
     throws DocumentRendererException,
            IOException

Deprecated.

Render all files from a site directory to an output directory

Parameters:

siteDirectory - the input directory contains files to be generated

outputDirectory - the output directory where files are generated

Throws:

DocumentRendererException - if any

IOException - if any

render

void render(File siteDirectory,
            File outputDirectory,
            File documentDescriptor)
     throws DocumentRendererException,
            IOException

Deprecated.

Render a document depending a context and a document descriptor

Parameters:

siteDirectory - the input directory contains files to be generated

outputDirectory - the output directory where file are generated

documentDescriptor - the document descriptor

Throws:

DocumentRendererException - if any

IOException - if any

getOutputExtension

String getOutputExtension()

Deprecated.

Get the output extension supported

Returns:

the ouput extension supported