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 572956 2007-09-05 14:22:50Z ltheussl $

Author:

Trygve Laugstøl

Field Summary

static java.lang.String

ROLE The plexus lookup role.

Method Summary

org.apache.maven.doxia.book.model.BookModel	loadBook(java.io.File bookDescriptor) Load a BookModel from a descriptor file.
void	renderBook(org.apache.maven.doxia.book.model.BookModel book, java.lang.String bookRendererId, java.util.List files, java.io.File outputDirectory) Creates a book from a BookModel.

Field Detail

ROLE

static final java.lang.String ROLE

The plexus lookup role.

Method Detail

loadBook

org.apache.maven.doxia.book.model.BookModel loadBook(java.io.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(org.apache.maven.doxia.book.model.BookModel book,
                java.lang.String bookRendererId,
                java.util.List files,
                java.io.File outputDirectory)
                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.

Throws:

BookDoxiaException - if the model cannot be loaded.