org.apache.maven.doxia.book

Interface BookDoxia

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
StringROLE
The plexus lookup role.
Method Summary
BookModelloadBook(File bookDescriptor)
Load a BookModel from a descriptor file.
voidrenderBook(BookModel book, String bookRendererId, List files, File outputDirectory)
Creates a book from a BookModel.

Field Detail

ROLE

public String ROLE
The plexus lookup role.

Method Detail

loadBook

public BookModel loadBook(File bookDescriptor)
Load a BookModel from a descriptor file.

Parameters: bookDescriptor the book descriptor file.

Returns: BookModel

Throws: BookDoxiaException if the model cannot be loaded.

renderBook

public void renderBook(BookModel book, String bookRendererId, List files, File outputDirectory)
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.

Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.