git: 3d63bd39e7 - main - Documentation: primer: Asciidoctor
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Sun, 16 Jul 2023 11:26:39 UTC
The branch main has been updated by grahamperrin:
URL: https://cgit.FreeBSD.org/doc/commit/?id=3d63bd39e73b3a3568f08b018f65e005e18b5ab6
commit 3d63bd39e73b3a3568f08b018f65e005e18b5ab6
Author: Graham Perrin <grahamperrin@FreeBSD.org>
AuthorDate: 2023-07-16 10:54:08 +0000
Commit: Graham Perrin <grahamperrin@FreeBSD.org>
CommitDate: 2023-07-16 11:26:05 +0000
Documentation: primer: Asciidoctor
Asciidoctor (not AsciiDoctor).
Reviewed-by: carlavilla, salvadore
Approved-by: carlavilla
Pull-request: https://github.com/freebsd/freebsd-doc/pull/223
---
.../fdp-primer/asciidoctor-primer/_index.adoc | 24 +++++++++++-----------
1 file changed, 12 insertions(+), 12 deletions(-)
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 3ad0e15b60..9638651e68 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,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 link:https://docs.asciidoctor.org/home/[Asciidoctor documentation].
+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].
[[asciidoctor-primer-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,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 link:https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#lists[AsciiDoc Syntax Quick Reference].
[[asciidoctor-ordered-lists]]
@@ -214,14 +214,14 @@ 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.
+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.
====
[[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 +230,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]
@@ -243,5 +243,5 @@ extref:{ipsec-must}[IPSec-Must article]
[[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).