Skip to content

Latest commit

 

History

History
133 lines (103 loc) · 3.47 KB

article.adoc

File metadata and controls

133 lines (103 loc) · 3.47 KB

The Article Title

This is the optional preamble (an untitled section body). Useful for writing simple sectionless documents consisting only of a preamble.

Note
The abstract, preface, appendix, bibliography, glossary and index section titles are significant (specialsections).

Example Abstract

The optional abstract (one or more paragraphs) goes here.

This document is an AsciiDoc article skeleton containing briefly annotated element placeholders plus a couple of example index entries and footnotes.

1. The First Section

Article sections start at level 1 and can be nested up to four levels deep. [1]

And now for something completely different: monkeys, lions and tigers (Bengal and Siberian) using the alternative syntax index entries. Note that multi-entry terms generate separate index entries.

Here are a couple of image examples: an tiger example inline image followed by block images:

Tiger
Figure 1. PNG block image
Ruby gemstone
Figure 2. SVG block image

Followed by an example table:

Table 1. An example table
Option Description

-a USER GROUP

Add USER to GROUP.

-R GROUP

Disables access to GROUP.

Example 1. An example example

Lorum ipum…​

1.1. Sub-section with Anchor

Sub-section at level 2.

1.1.1. A Nested Sub-section

Sub-section at level 3.

Yet another nested Sub-section

Sub-section at level 4.

This is the maximum sub-section depth supported by the distributed AsciiDoc configuration. [2]

2. The Second Section

Article sections are at level 1 and can contain sub-sections nested up to four deep.

An example link to anchor at start of The First Section and the first sub-section.

An example link to a bibliography entry [taoup].

A link to a document in a relative directory.

Appendix A: Example Appendix

AsciiDoc article appendices are just just article sections with specialsection titles.

Appendix Sub-section

Appendix sub-section at level 2.

Example Bibliography

The bibliography list is a style of AsciiDoc bulleted list.

  • [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.

Example Glossary

Glossaries are optional. Glossaries entries are an example of a style of AsciiDoc labeled lists.

A glossary term

The corresponding (indented) definition.

A second glossary term

The corresponding (indented) definition.


1. An example footnote.
2. A second example footnote.