From nobody Sun Jul 16 11:26:39 2023 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4R3jbM6MYqz4mvvm for ; Sun, 16 Jul 2023 11:26:39 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4R3jbM5xQjz4GyV; Sun, 16 Jul 2023 11:26:39 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1689506799; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=43ruwL66qaYeqsGaFt/Bj45CLbkREkqhOreDf1xg6p8=; b=RvuP0aKF+cKVdZy+rR2Nn7BTXyyitxUbA4gkVnt5hTgzedFi9vRSUAY2zgTRTdizDG2l8I uUz4ce8K8BLMIMhU6pjlkO4t7g0lBQ/o0hVBbVD6cVsNumtUGhdRyJ8EZ8GmbtZ1pFAFTs A/4Yt+SNOkVNpG9rU9A7PRi6rB5SVLXWDijfy+uWPQpURugA4Ys085torAcy+5934NW01L IioMmaKBEL0k4OjSKJaosAjA/zU02cpX2EWZ8otqiP+7+gQ38jRcyPHBQ9kEetuU2jXdON hHQzHQUbpPa0Qhry1cEt1xuDH2vBZ8PXNx2JZoRmQyrDOM15SeZsiSwgXTlonA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1689506799; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=43ruwL66qaYeqsGaFt/Bj45CLbkREkqhOreDf1xg6p8=; b=DbZHfOQpM4uPxybdqpgvl8Xn6hP3PB7MJUjW0zyxPRGhizKyLEy6lB7/vQbNNDIeieIwRA vLcIH8ijuf9cwp3xb0O9JuKcfWI3kt9AthDuYxyfJIVDZF9h1WPUf+PvkKufih4Ohxikzu DaJqJw0ChXR1tFxnqfCLocDZ8Ze/nBTfCsMMiifZLAO5HGhFwP+OlkNFVv0H3kNvjYsj4H WB2TQCb9CeH0D66NJOSpZgTR8JHr4ZWdaJ+JWyWL1Pq34159h2anAKZI0BVFDhJf6ERFbl 8/DTfsTQqhQwmUo8KsfETZQ6wSeEwTYp7qbcH9Eu7ydSpoCMoAwPd1DzMFTGQg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1689506799; a=rsa-sha256; cv=none; b=SgiwDGAzpgQKPL1UaGq1tDcVjk5X9k5QuwCEY+4+889zq4+StWbAGaQFwwkHK91tiwdzbl Kx5Y+c8uQdKvah3fmN5Gg2KQv9f2lxDqAP6ZSu7Qr1Nivv1dExb30AVLkgka9MTC0dkJS+ 6f792S6KbYcphPrZwHYHKQHHQBx1jCnroXa03seI4tCTnQ9ppU2Uq31D5FLsid1JAUvFFN 5D38AaLQp1L72mViavqZHJl2d9AptBqJwz4TubzlAfC1lw0wiPLYTh5mKi4mVCBnPqL0GV yILTQwKqDKYLvpuNWBzRnPWMW+32Mmzwb4a66v7m+xhUaMLSKO53UT4Z4RAqTA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4R3jbM50VhzgC9; Sun, 16 Jul 2023 11:26:39 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 36GBQdPQ066877; Sun, 16 Jul 2023 11:26:39 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 36GBQdF2066876; Sun, 16 Jul 2023 11:26:39 GMT (envelope-from git) Date: Sun, 16 Jul 2023 11:26:39 GMT Message-Id: <202307161126.36GBQdF2066876@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Graham Perrin Subject: git: 3d63bd39e7 - main - Documentation: primer: Asciidoctor List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: grahamperrin X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 3d63bd39e73b3a3568f08b018f65e005e18b5ab6 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by grahamperrin: URL: https://cgit.FreeBSD.org/doc/commit/?id=3d63bd39e73b3a3568f08b018f65e005e18b5ab6 commit 3d63bd39e73b3a3568f08b018f65e005e18b5ab6 Author: Graham Perrin AuthorDate: 2023-07-16 10:54:08 +0000 Commit: Graham Perrin 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).