org.apache.maven.doxia.book
Interface BookDoxia

All Known Implementing Classes:

DefaultBookDoxia

public interface BookDoxia

An interface to create books in different output formats from a book descriptor.

Version:

$Id: BookDoxia.java 1090706 2011-04-09 23:15:28Z hboutemy $

Author:

Trygve Laugstøl

Field Summary

static String

ROLE The plexus lookup role.

Method Summary

BookModel	loadBook(File bookDescriptor) Load a BookModel from a descriptor file.
void	renderBook(BookModel book, String bookRendererId, List<File> files, File outputDirectory) Creates a book from a BookModel using the Locale.getDefault() and UTF-8 as default encoding.
void	renderBook(BookModel book, String bookRendererId, List<File> files, File outputDirectory, Locale locale, String inputEncoding, String outputEncoding) Creates a book from a BookModel.

Field Detail

ROLE

static final String ROLE

The plexus lookup role.

Method Detail

loadBook

BookModel loadBook(File bookDescriptor)
                   throws BookDoxiaException

Load a BookModel from a descriptor file.

Parameters:

bookDescriptor - the book descriptor file.

Returns:

BookModel

Throws:

BookDoxiaException - if the model cannot be loaded.

renderBook

void renderBook(BookModel book,
                String bookRendererId,
                List<File> files,
                File outputDirectory)
                throws BookDoxiaException

Creates a book from a BookModel using the Locale.getDefault() and UTF-8 as default encoding.

Parameters:

book - the BookModel.

bookRendererId - the id of the output format.

files - a list of source files.

outputDirectory - the output directory.

Throws:

BookDoxiaException - if the model cannot be loaded.

See Also:

renderBook(BookModel, String, List, File, Locale, String, String), Locale.getDefault()

renderBook

void renderBook(BookModel book,
                String bookRendererId,
                List<File> files,
                File outputDirectory,
                Locale locale,
                String inputEncoding,
                String outputEncoding)
                throws BookDoxiaException

Creates a book from a BookModel.

Parameters:

book - the BookModel.

bookRendererId - the id of the output format.

files - a list of source files.

outputDirectory - the output directory.

locale - the wanted locale.

inputEncoding - the input encoding when processing files.

outputEncoding - the output encoding when writing files in ouputDirectory.

Throws:

BookDoxiaException - if the model cannot be loaded.

Since:

1.1