Skip to content

Commit

Permalink
Documentation: primer: Asciidoctor
Browse files Browse the repository at this point in the history
Asciidoctor (not AsciiDoctor).
  • Loading branch information
grahamperrin committed Jul 15, 2023
1 parent 2b36092 commit a8482ad
Showing 1 changed file with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Chapter 6. AsciiDoctor Primer
title: Chapter 6. Asciidoctor Primer
prev: books/fdp-primer/doc-build
next: books/fdp-primer/rosetta
description: A brief introduction to AsciiDoctor
tags: ["AsciiDoc", "AsciiDoctor", "Primer", "Introduction", "Guide"]
description: A brief introduction to Asciidoctor
tags: ["AsciiDoc", "Asciidoctor", "Primer", "Introduction", "Guide"]
showBookMenu: true
weight: 7
path: "/books/fdp-primer/"
---

[[asciidoctor-primer]]
= AsciiDoctor Primer
= Asciidoctor Primer
:doctype: book
:toc: macro
:toclevels: 1
Expand Down Expand Up @@ -49,7 +49,7 @@ endif::[]

Most FDP documentation is written with AsciiDoc.
This chapter explains what that means, how to read and understand the documentation source, and the techniques used.
To get a complete reference of the AsciiDoctor capabilities please consult the https://docs.asciidoctor.org/home/[Asciidoctor documentation].
To get a complete reference of the Asciidoctor capabilities please consult the https://docs.asciidoctor.org/home/[Asciidoctor documentation].
Some of the examples used in this chapter have been taken from the https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference[AsciiDoc Syntax Quick Reference].

[[asciidoctor-primer-overview]]
Expand Down Expand Up @@ -97,7 +97,7 @@ To remove */tmp/foo*, use man:rm[1].
[[asciidoctor-headings]]
== Headings

AsciiDoctor supports six headings levels.
Asciidoctor supports six headings levels.
If the document type is `article` only one level 0 (`=`) can be used.
If the document type is `book` then there can be multiple level 0 (`=`) headings.

Expand Down Expand Up @@ -155,7 +155,7 @@ And this is the second paragraph.
[[asciidoctor-lists]]
== Lists

AsciiDoctor supports a few types of lists, the most common are `ordered` and `unordered`.
Asciidoctor supports a few types of lists, the most common are `ordered` and `unordered`.
To get more information about lists, see https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#lists[AsciiDoc Syntax Quick Reference].

[[asciidoctor-ordered-lists]]
Expand Down Expand Up @@ -213,7 +213,7 @@ The URL scheme acts as an implicit macro prefix.
[[asciidoctor-links-internal]]
=== Internal link

To point to another book or article the AsciiDoctor variables should be used.
To point to another book or article the Asciidoctor variables should be used.
For example, if we are in the `cups` article and we want to point to `ipsec-must` these steps should be used.

. Include the [.filename]#urls.adoc# file from [.filename]#~/doc/shared# folder.
Expand All @@ -222,7 +222,7 @@ For example, if we are in the `cups` article and we want to point to `ipsec-must
\include::shared/{lang}/urls.adoc[]
....
+
. Then create a link using the AsciiDoctor variable to the `ipsec-must` article.
. Then create a link using the Asciidoctor variable to the `ipsec-must` article.
+
....
extref:{ipsec-must}[IPSec-Must article]
Expand All @@ -240,5 +240,5 @@ This macro is not often needed. Use cases are https://docs.asciidoctor.org/ascii
[[asciidoctor-conclusion]]
== Conclusion

This is the conclusion of this AsciiDoctor primer.
This is the conclusion of this Asciidoctor primer.
For reasons of space and complexity, several things have not been covered in depth (or at all).

0 comments on commit a8482ad

Please sign in to comment.