-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Recommended Practices
This document catalogs a set of recommended practices for composing documents in AsciiDoc. It was copied from the AsciiDoctor Github and all credit goes to the Asciidoctor team.
AsciiDoc offers multiple ways to accomplish the same thing, and is often very lenient with the syntax. This guide helps bring consistency to your documents that will maximize efficiency, improve readability and minimize maintainence.
AsciiDoc doesn’t care which extension you use. GitHub supports the extensions .asciidoc, .adoc and .asc.
|
Note
|
I recommend against using the .asc extension. The connection to AsciiDoc isn’t obvious (at least to me) and it gets identified as a PGP file on Linux. |
Don’t do it!
Sentence per line? (Neo4j recommendation)
AsciiDoc doesn’t treat a wrapped line break as a hard line break.
There are three ways to define a section title. These variants can be classified into two types of styles, atx and setext (historical names).
In the Atx-style, the section title is defined on a single line. The section title begins with one or more equal characters (i.e., =) followed by a space and the section title. The number of leading characters representing the depth. The top-level section is reserved for the document title, so the first section in the document will have two leading characters.
== First Section
This example uses the asymmetric Atx-style. The asymmetric Atx-style is the style I recommend using to define your section titles. It requires the least number of characters and it’s intuitive since the number of leading characters represents the heading level.
When using the HTML backend, this section title will be transformed into an h2 heading (likely wrapped in a section block for styling):
<h2>First Section</h2>
The symmetric Atx-style bookends the section title between a matching pair of delimiters.
== First Section ==
While this syntax may look nicer to some, it requires twice the number of delimiters without adding any additional semantics. Therefore, I consider it a waste of keystrokes and don’t recommend using it. However, either of the Atx-style section titles are better than the Setext style.
In the Setext-style, the section title is defined on two lines. The second line is a string of characters that form an underline below the section title. Here’s an example of a section title from above defined in the Setext-style.
First Section -------------
Since the length of the line is determined by the number of characters in the section title, another dimension must be introduced to determine the level. That dimension is the character used for the underline. The mapping is as follows:
| Character | Heading level |
|---|---|
|
1 (title) |
|
2 |
|
3 |
|
4 |
|
5 |
I strongly recommend against using the Setext style for section titles. Keeping the length of the underline in sync with the title length is an unnecessary task and time waster. A more substantial reason is that the mapping between character and heading level is very difficult to remember and not obvious to new AsciiDoc adopters. All in all, using Setext section titles is a bad practice. Don’t use them!
|
Tip
|
Use the asymmetric Atx-style to define your section titles. |
Since the document title occurs only once in a document, I consider it acceptable to use the Setext style in this instance.
Document Title ============== Author Name <author@example.org>
Be sure to include your name immediately following the document title.
|
Note
|
AsciiDoc only supports an e-mail following the author line. It does not support a personal URL. This feature is planned for Asciidoctor. |
It’s a good practice to also include a revision line following the author line.
Document Title ============== Author Name <author@example.org> v1.0, 2012-02-10
The version number is optional. The revision line may consist of a date only.
Document Title ============== Author Name <author@example.org> 2012-02-10
Delimited blocks contain special text such as code listings, quotes, sidebar text, tables and so on. As you may have guessed, they are bounded by a string of delimiters. The delimiters are defined on a line by themselves. The content goes in between the delimiter lines. Here’s an example of a listing:
---- $ asciidoc -b html5 recommended-practices.adoc ----
Delimited blocks require four or more repeating characters on a line by themselves to mark the boundary of the block. The one exception is the open block, which only requires two - repeating characters.
You may be tempting to extend the line furthur, either to a predetermined length or to match the length of the content.
---------------------------------------------- $ asciidoc -b html5 recommended-practices.adoc ----------------------------------------------
Don’t do this!
Maintaining long delimiter lines is a colossal waste of time, not to mention arbitrary and error prone. I strong urge you to use the minimum number of characters necessary to form a delimited block and move on to drafting the content. The reader will never see these long strings of delimiters anyway since they are not carried over to the output (HTML, DocBook, etc).
|
Note
|
AsciiDoc does not enforce that the length of the line that opens the delimited block match the length of the line that closes the delimited block, but I think it should. Asciidoctor enforces this requirement, so make sure they match. |
TODO
What they are, use them to stay DRY, such as URLs
Save some typing
{counter:counter-name}
Document settings are configured using attribute entries immediately following the document title (without any blank lines in between). There are several options of interest.
You can enable numbering of sections using the numbered attribute (off by default).
:numbered:
You can set the description of the document using the description attribute. The description is included in the header of the document.
:description: This document catalogs a set of recommended practices for writing in AsciiDoc.
You can break any attribute value across several lines by ending the lines in a {plus} preceded by a space.
:description: This document catalogs a set of recommended practices +
for composing documents in AsciiDoc.
You can use this text anywhere in the document by referencing it as an attribute.
{description}
IDs are generated for each section title by default. The ID is generated from the section title, prefixed with an underscore (i.e., _) by default. You can change the prefix using the idprefix attribute.
:idprefix: -
If you want to remove the prefix, assign it to an empty value:
:idprefix:
To disable the auto-generation of section IDs, unset the sectids attribute:
:sectids!:
Set the toc attribute to activate an auto-generated table of contents at the top of document:
:toc:
TODO
don’t include the images directory in each image reference
…
AsciiDoc supports both * (one or more) and - (only one) as markers for a top-level list item.
* first * second * third
or
- first - second - third
However, the dash marker cannot be repeated when defining a list item. This can lead to confusion since AsciiDoc increases the nesting level each time it encounters a different marker. For instance, in the following case, the item that have an asterisk marker is nested inside the first item.
- first * nested item - second - third
This nesting rule is true even when the number of asterisks seems to indicate the level:
*** first * nested item *** second *** third
Yep, that’s right, the second list item is nested inside the first list item.
If you stick to convention, the number of asterisks can represent the nesting level:
* first ** nested item * second * third
Now that’s intuitive.
I strongly recommend using the asterisk marker if you are going to be using nested lists.
If you only have top-level list items, then using either marker is reasonable. I may even recommend using the dash marker for lists that are not intended to have nested items and the asterisk marker for lists that do have nested items. That way it’s easy to identify them as different types.
They exist!
Adjacent lists sometimes like to fuse. To force the start of a new list, offset the two lists by an empty line comment:
* apples * oranges * bananas // * carrots * tomatoes * celery