diff options
Diffstat (limited to 'doc/asciidoc/doc/book-multi.txt')
-rw-r--r-- | doc/asciidoc/doc/book-multi.txt | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/doc/asciidoc/doc/book-multi.txt b/doc/asciidoc/doc/book-multi.txt new file mode 100644 index 0000000..61d5ad3 --- /dev/null +++ b/doc/asciidoc/doc/book-multi.txt @@ -0,0 +1,181 @@ +Multi-Part Book Title Goes Here +=============================== +Author's Name +v1.0, 2003-12 +:doctype: book + + +[dedication] +Example Dedication +================== +The optional dedication goes here. + +This document is an AsciiDoc multi-part book skeleton containing +briefly annotated element placeholders plus a couple of example index +entries and footnotes. Books are normally used to generate DocBook +markup and the preface, appendix, bibliography, glossary and index +section titles are significant ('specialsections'). + +NOTE: Multi-part books differ from all other AsciiDoc document formats +in that top level sections (dedication, preface, book parts, +appendices, bibliography, glossary, index) must be level zero headings +(not level one). + + +[preface] +Example Preface +================ +The optional book preface goes here at section level zero. + +Preface Sub-section +~~~~~~~~~~~~~~~~~~~ +NOTE: Preface and appendix subsections start out of sequence at level +2 (level 1 is skipped). This only applies to multi-part book +documents. + + + +The First Part of the Book +========================== + +[partintro] +.Optional part introduction title +-- +Optional part introduction goes here. +-- + +The First Chapter +----------------- +Chapters can be grouped by preceeding them with a level 0 Book Part +title. + +Book chapters are at level 1 and can contain sub-sections nested up to +three deep. +footnote:[An example footnote.] +indexterm:[Example index entry] + +It's also worth noting that a book part can have it's own preface, +bibliography, glossary and index. Chapters can have their own +bibliography, glossary and index. + +And now for something completely different: ((monkeys)), lions and +tigers (Bengal and Siberian) using the alternative syntax index +entries. +(((Big cats,Lions))) +(((Big cats,Tigers,Bengal Tiger))) +(((Big cats,Tigers,Siberian Tiger))) +Note that multi-entry terms generate separate index entries. + +Here are a couple of image examples: an image:images/smallnew.png[] +example inline image followed by an example block image: + +.Tiger block image +image::images/tiger.png[Tiger image] + +Followed by an example table: + +.An example table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +.An example example +=============================================== +Lorum ipum... +=============================================== + +[[X1]] +Sub-section with Anchor +~~~~~~~~~~~~~~~~~~~~~~~ +Sub-section at level 2. + +Chapter Sub-section +^^^^^^^^^^^^^^^^^^^ +Sub-section at level 3. + +Chapter Sub-section ++++++++++++++++++++ +Sub-section at level 4. + +This is the maximum sub-section depth supported by the distributed +AsciiDoc configuration. +footnote:[A second example footnote.] + + +The Second Chapter +------------------ +An example link to anchor at start of the <<X1,first sub-section>>. +indexterm:[Second example index entry] + +An example link to a bibliography entry <<taoup>>. + + + +The Second Part of the Book +=========================== + +The First Chapter of the Second Part +------------------------------------ +Chapters grouped into book parts are at level 1 and can contain +sub-sections. + + + +:numbered!: + +[appendix] +Example Appendix +================ +One or more optional appendixes go here at section level zero. + +Appendix Sub-section +~~~~~~~~~~~~~~~~~~~ +NOTE: Preface and appendix subsections start out of sequence at level +2 (level 1 is skipped). This only applies to multi-part book +documents. + + + +[bibliography] +Example Bibliography +==================== +The bibliography list is a style of AsciiDoc bulleted list. + +[bibliography] +- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix + Programming'. Addison-Wesley. ISBN 0-13-142901-9. +- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner. + 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999. + ISBN 1-56592-580-7. + + +[glossary] +Example Glossary +================ +Glossaries are optional. Glossaries entries are an example of a style +of AsciiDoc labeled lists. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +[colophon] +Example Colophon +================ +Text at the end of a book describing facts about its production. + + +[index] +Example Index +============= +//////////////////////////////////////////////////////////////// +The index is normally left completely empty, it's contents are +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// |