You need a bookmap to generate PDF, HTML, HTML5 and other outputs. Some of the basic elements of a bookmap have been added to the template, but you will need to populate those elements and add the additional elements that you need to include in the book output. The following table lists and describes the bookmap elements.
Element |
Child elements |
Description |
Booktitle |
|
Parent element for:
MainBook Title Book Title Alt Book Library |
MainBook Title |
The title appears:
On Avaya Documentation Center, at the top on every page of the document. In PDF: The cover of the book and, if Book Title Alt is not specified, in the document footer. |
Book Title Alt |
If specified, this title appears in the footer in PDF. You can also use Book Title Alt to create a two-line title for the avayaquickref-3column output type. |
Book Library |
Title for the book library if you are creating one. Omit this element if you are not creating a documentation library. |
Book Meta |
othermeta/bundle name |
A unique ID for the document that you upload on Avaya Documentation Center.
Important:
You provide the book meta, such as release number and issue number, in the publication properties.
|
Front Matter |
|
Parent element for:
Notices to add a legal page to the book. Book Lists, which is required to include a table of contents in the book. |
|
|
The Notices element is used to add a legal page to the book if one is required. Notices is a child of Front Matter. Book Lists is the required parent of Table of Contents. The Table of Contents element adds a table of contents to the book. Table of Contents is a child of Book Lists. |
Chapter |
|
One chapter is included in the bookmap template. You can add as many chapters as you need. You should create a map for each chapter to contain the chapter contents. Creating chapter-level maps is our best practice as it makes it easier to restructure a publication and it can facilitate reuse. |
Part |
|
The Part element is used to divide a document's chapters into logical groupings. This element makes it possible for you to provide a title and optional introduction under which to group the chapters. |
Appendix |
|
Used for appendices. |
Back Matter |
|
Parent element for Book Lists, which is required to include a glossary or index in the book. |
Book Lists
|
Book Lists is the required parent of Glossary List and Index List. The Glossary List element adds a glossary to the book. This element requires a Map Ref that references a map of glossary topics or a single Topic Ref that references one glossary topic. The Index List element adds an index to the book. |
