diff --git a/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc b/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc index 3ad0e15b60f2..33f97af8cb32 100644 --- a/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc +++ b/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc @@ -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 @@ -49,8 +49,8 @@ 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 link:https://docs.asciidoctor.org/home/[Asciidoctor documentation]. -Some of the examples used in this chapter have been taken from the link:https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference[AsciiDoc Syntax Quick Reference]. +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]] == Overview @@ -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. @@ -155,8 +155,8 @@ And this is the second paragraph. [[asciidoctor-lists]] == Lists -AsciiDoctor supports a few types of lists, the most common are `ordered` and `unordered`. -To get more information about lists, see link:https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#lists[AsciiDoc Syntax Quick Reference]. +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]] === Ordered lists @@ -206,22 +206,14 @@ And this would be rendered as. [[asciidoctor-links-external]] === External links -To point to another website the `link` macro should be used. +The `link:` macro prefix is https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#links[*not* required] when the target starts with a URL scheme such as `https:` or `mailto:`. -.... -link:https://www.FreeBSD.org[FreeBSD] -.... - -[NOTE] -==== -As the AsciiDoctor documentation describes, the `link` macro is not required when the target starts with a URL scheme like `https`. -However, it is a good practice to do this anyway to ensure that AsciiDoctor renders the link correctly, especially in non-latin languages like Japanese. -==== +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. @@ -230,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] @@ -240,8 +232,13 @@ And this would be rendered as. + extref:{ipsec-must}[IPSec-Must article] +[[asciidoctor-link-macro]] +=== The link macro + +This macro is not often needed. Use cases are https://docs.asciidoctor.org/asciidoc/latest/macros/link-macro/#when-to-use-the-link-macro[specified in Asciidoctor Docs]. + [[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).