1 | Multi-Part Book Title Goes Here |
---|
2 | =============================== |
---|
3 | Author's Name |
---|
4 | v1.0, 2003-12 |
---|
5 | :doctype: book |
---|
6 | |
---|
7 | |
---|
8 | [dedication] |
---|
9 | Example Dedication |
---|
10 | ================== |
---|
11 | The optional dedication goes here. |
---|
12 | |
---|
13 | This document is an AsciiDoc multi-part book skeleton containing |
---|
14 | briefly annotated element placeholders plus a couple of example index |
---|
15 | entries and footnotes. Books are normally used to generate DocBook |
---|
16 | markup and the preface, appendix, bibliography, glossary and index |
---|
17 | section titles are significant ('specialsections'). |
---|
18 | |
---|
19 | NOTE: Multi-part books differ from all other AsciiDoc document formats |
---|
20 | in that top level sections (dedication, preface, book parts, |
---|
21 | appendices, bibliography, glossary, index) must be level zero headings |
---|
22 | (not level one). |
---|
23 | |
---|
24 | |
---|
25 | [preface] |
---|
26 | Example Preface |
---|
27 | ================ |
---|
28 | The optional book preface goes here at section level zero. |
---|
29 | |
---|
30 | Preface Sub-section |
---|
31 | ~~~~~~~~~~~~~~~~~~~ |
---|
32 | NOTE: Preface and appendix subsections start out of sequence at level |
---|
33 | 2 (level 1 is skipped). This only applies to multi-part book |
---|
34 | documents. |
---|
35 | |
---|
36 | |
---|
37 | |
---|
38 | The First Part of the Book |
---|
39 | ========================== |
---|
40 | |
---|
41 | [partintro] |
---|
42 | .Optional part introduction title |
---|
43 | -- |
---|
44 | Optional part introduction goes here. |
---|
45 | -- |
---|
46 | |
---|
47 | The First Chapter |
---|
48 | ----------------- |
---|
49 | Chapters can be grouped by preceeding them with a level 0 Book Part |
---|
50 | title. |
---|
51 | |
---|
52 | Book chapters are at level 1 and can contain sub-sections nested up to |
---|
53 | three deep. |
---|
54 | footnote:[An example footnote.] |
---|
55 | indexterm:[Example index entry] |
---|
56 | |
---|
57 | It's also worth noting that a book part can have it's own preface, |
---|
58 | bibliography, glossary and index. Chapters can have their own |
---|
59 | bibliography, glossary and index. |
---|
60 | |
---|
61 | And now for something completely different: ((monkeys)), lions and |
---|
62 | tigers (Bengal and Siberian) using the alternative syntax index |
---|
63 | entries. |
---|
64 | (((Big cats,Lions))) |
---|
65 | (((Big cats,Tigers,Bengal Tiger))) |
---|
66 | (((Big cats,Tigers,Siberian Tiger))) |
---|
67 | Note that multi-entry terms generate separate index entries. |
---|
68 | |
---|
69 | Here are a couple of image examples: an image:images/smallnew.png[] |
---|
70 | example inline image followed by an example block image: |
---|
71 | |
---|
72 | .Tiger block image |
---|
73 | image::images/tiger.png[Tiger image] |
---|
74 | |
---|
75 | Followed by an example table: |
---|
76 | |
---|
77 | .An example table |
---|
78 | [width="60%",options="header"] |
---|
79 | |============================================== |
---|
80 | | Option | Description |
---|
81 | | -a 'USER GROUP' | Add 'USER' to 'GROUP'. |
---|
82 | | -R 'GROUP' | Disables access to 'GROUP'. |
---|
83 | |============================================== |
---|
84 | |
---|
85 | .An example example |
---|
86 | =============================================== |
---|
87 | Lorum ipum... |
---|
88 | =============================================== |
---|
89 | |
---|
90 | [[X1]] |
---|
91 | Sub-section with Anchor |
---|
92 | ~~~~~~~~~~~~~~~~~~~~~~~ |
---|
93 | Sub-section at level 2. |
---|
94 | |
---|
95 | Chapter Sub-section |
---|
96 | ^^^^^^^^^^^^^^^^^^^ |
---|
97 | Sub-section at level 3. |
---|
98 | |
---|
99 | Chapter Sub-section |
---|
100 | +++++++++++++++++++ |
---|
101 | Sub-section at level 4. |
---|
102 | |
---|
103 | This is the maximum sub-section depth supported by the distributed |
---|
104 | AsciiDoc configuration. |
---|
105 | footnote:[A second example footnote.] |
---|
106 | |
---|
107 | |
---|
108 | The Second Chapter |
---|
109 | ------------------ |
---|
110 | An example link to anchor at start of the <<X1,first sub-section>>. |
---|
111 | indexterm:[Second example index entry] |
---|
112 | |
---|
113 | An example link to a bibliography entry <<taoup>>. |
---|
114 | |
---|
115 | |
---|
116 | |
---|
117 | The Second Part of the Book |
---|
118 | =========================== |
---|
119 | |
---|
120 | The First Chapter of the Second Part |
---|
121 | ------------------------------------ |
---|
122 | Chapters grouped into book parts are at level 1 and can contain |
---|
123 | sub-sections. |
---|
124 | |
---|
125 | |
---|
126 | |
---|
127 | :numbered!: |
---|
128 | |
---|
129 | [appendix] |
---|
130 | Example Appendix |
---|
131 | ================ |
---|
132 | One or more optional appendixes go here at section level zero. |
---|
133 | |
---|
134 | Appendix Sub-section |
---|
135 | ~~~~~~~~~~~~~~~~~~~ |
---|
136 | NOTE: Preface and appendix subsections start out of sequence at level |
---|
137 | 2 (level 1 is skipped). This only applies to multi-part book |
---|
138 | documents. |
---|
139 | |
---|
140 | |
---|
141 | |
---|
142 | [bibliography] |
---|
143 | Example Bibliography |
---|
144 | ==================== |
---|
145 | The bibliography list is a style of AsciiDoc bulleted list. |
---|
146 | |
---|
147 | [bibliography] |
---|
148 | - [[[taoup]]] Eric Steven Raymond. 'The Art of Unix |
---|
149 | Programming'. Addison-Wesley. ISBN 0-13-142901-9. |
---|
150 | - [[[walsh-muellner]]] Norman Walsh & Leonard Muellner. |
---|
151 | 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999. |
---|
152 | ISBN 1-56592-580-7. |
---|
153 | |
---|
154 | |
---|
155 | [glossary] |
---|
156 | Example Glossary |
---|
157 | ================ |
---|
158 | Glossaries are optional. Glossaries entries are an example of a style |
---|
159 | of AsciiDoc labeled lists. |
---|
160 | |
---|
161 | [glossary] |
---|
162 | A glossary term:: |
---|
163 | The corresponding (indented) definition. |
---|
164 | |
---|
165 | A second glossary term:: |
---|
166 | The corresponding (indented) definition. |
---|
167 | |
---|
168 | |
---|
169 | [colophon] |
---|
170 | Example Colophon |
---|
171 | ================ |
---|
172 | Text at the end of a book describing facts about its production. |
---|
173 | |
---|
174 | |
---|
175 | [index] |
---|
176 | Example Index |
---|
177 | ============= |
---|
178 | //////////////////////////////////////////////////////////////// |
---|
179 | The index is normally left completely empty, it's contents are |
---|
180 | generated automatically by the DocBook toolchain. |
---|
181 | //////////////////////////////////////////////////////////////// |
---|