org.apache.maven.doxia.book
public interface BookDoxia
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ROLE
The plexus lookup role.
|
Modifier and Type | Method and Description |
---|---|
BookModel |
loadBook(java.io.File bookDescriptor)
Load a BookModel from a descriptor file.
|
void |
renderBook(BookModel book,
java.lang.String bookRendererId,
java.util.List files,
java.io.File outputDirectory)
Creates a book from a BookModel using the
Locale.getDefault() and UTF-8 as default encoding. |
void |
renderBook(BookModel book,
java.lang.String bookRendererId,
java.util.List files,
java.io.File outputDirectory,
java.util.Locale locale,
java.lang.String inputEncoding,
java.lang.String outputEncoding)
Creates a book from a BookModel.
|
BookModel loadBook(java.io.File bookDescriptor) throws BookDoxiaException
bookDescriptor
- the book descriptor file.BookDoxiaException
- if the model cannot be loaded.void renderBook(BookModel book, java.lang.String bookRendererId, java.util.List files, java.io.File outputDirectory) throws BookDoxiaException
Locale.getDefault()
and UTF-8 as default encoding.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.renderBook(BookModel, String, List, File, Locale, String, String)
,
Locale.getDefault()
void renderBook(BookModel book, java.lang.String bookRendererId, java.util.List files, java.io.File outputDirectory, java.util.Locale locale, java.lang.String inputEncoding, java.lang.String outputEncoding) throws BookDoxiaException
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
.BookDoxiaException
- if the model cannot be loaded.Copyright © 2005-2014. All Rights Reserved.