|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BookDoxia
An interface to create books in different output formats from a book descriptor.
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 |
---|
static final java.lang.String ROLE
Method Detail |
---|
org.apache.maven.doxia.book.model.BookModel loadBook(java.io.File bookDescriptor) throws BookDoxiaException
bookDescriptor
- the book descriptor file.
BookDoxiaException
- if the model cannot be loaded.void renderBook(org.apache.maven.doxia.book.model.BookModel book, java.lang.String bookRendererId, java.util.List files, java.io.File outputDirectory) throws BookDoxiaException
book
- the BookModel.bookRendererId
- the id of the output format.files
- a list of source files.outputDirectory
- the output directory.
BookDoxiaException
- if the model cannot be loaded.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |