xml.nav.epub3-nav-create-navigation-doc.xpl Maven / Gradle / Ivy
Input fileset
May already include a (at most one) navigation document, in which case it should
either be marked with a role attribute with value nav, or it
should contain a nav[@epub:type='toc'] element.
If the input fileset does not include a navigation document it is generated from the
content documents.
Fileset from which to generate the navigation document.
Defaults to all the "application/xhtml+xml" documents found in spine, or in the
"source" fileset if the input does not contain a package document.
"toc"
nav element to include in the navigation document.
At most one document is allowed and it is an error if a document is present when the
input fileset already contains a navigation document.
"page-list"
nav element to include in the navigation document.
At most one document is allowed and it is an error if a document is present when the
input fileset already contains a navigation document.
"landmarks"
nav element to include in the navigation document.
At most one document is allowed and it is an error if a document is present when the
input fileset already contains a navigation document.
The EPUB navigation document
Fileset with as single file the navigation document
Copy of sourse fileset with navigation document added and package and HTML documents
updated.
If a navigation document was already present and the output-base-uri
option is set, it will be moved to the new location. If a navigation document needs to
be generated, the output-base-uri option is mandatory.
If a package document is present in the input it will be updated.
If the navigation document was generated from the content documents, the content
documents will be changed so that all body, article,
aside, nav, section, h1,
h2, h3, h4, h5, h6,
hgroup and epub:type='pagebreak' elements have an
id attribute.
The base URI of the generated navigation document.
Mandatory if the input fileset contains no navigation document yet, ignored
otherwise.
Whether to add a hidden attribute to the
epub:type='page-list' element.
The title of the navigation document.
If not specified, the title is "Table of contents", localized to the language of the
content documents.
The xml:lang and lang attributes of the navigation
document.
If not specified, it will be the language of the content documents.
The CSS style sheet to attach to the navigation document.
The reserved
prefix mappings of the resulting package document. By default, prefixes that are
used but not declared in the input are also not declared in the output, and if "schema"
is not used in the input, it is declared in the output.
Whether to be backward compatible with Open Package Format
2.0.1.
px:epub3-create-toc
px:epub3-create-page-list
pxi:epub3-nav-aggregate
px:opf-spine-to-fileset
px:epub3-add-metadata
px:assert
px:fileset-load
px:fileset-filter
px:fileset-filter-in-memory
px:fileset-update
px:fileset-add-entry
px:fileset-join
Get content documents
Check if there is already a navigation doc in the input
Generate navigation doc if not present in input
Filter content documents
If there is a package document, select the spine only
Create toc
Create page list
Omit page list if empty
Update package document
Update metadata with accessibility metadata
tableOfContents
pageNavigation