public interface BookDoxia
Modifier and Type | Field and Description |
---|---|
static String |
ROLE
The plexus lookup role.
|
Modifier and Type | Method and Description |
---|---|
BookModel |
loadBook(File bookDescriptor)
Load a BookModel from a descriptor file.
|
void |
renderBook(BookModel book,
String bookRendererId,
List 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 files,
File outputDirectory,
Locale locale,
String inputEncoding,
String outputEncoding)
Creates a book from a BookModel.
|
static final String ROLE
BookModel loadBook(File bookDescriptor) throws BookDoxiaException
bookDescriptor
- the book descriptor file.BookDoxiaException
- if the model cannot be loaded.void renderBook(BookModel book, String bookRendererId, List files, 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, String bookRendererId, List files, File outputDirectory, Locale locale, String inputEncoding, 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–2016. All rights reserved.