From nobody Wed Nov 30 19:20:06 2022 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 4NMptt57ZXz4hfW7 for ; Wed, 30 Nov 2022 19:20:06 +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 4NMptt4fPFz4MPX; Wed, 30 Nov 2022 19:20:06 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1669836006; 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=1CdXaJIev9ruzG0MgQRyyCj4jPkHgkQU+tV1VqhRrVQ=; b=xRYswGlkX0s4FsknA44GfU3TPeRvY1O40gMyHuTm3dChpZML44hUBHllcILmsdQ5zcCTzY BNfepvT8z22VOQpQlg+qlgRY2YNP88KAApU2K+lcGej995cgA1I+29087JKx2jllZtCP0y 4dKA8aRhSHl6yHFmcNxoFSHMSXLqTCC6MSLcwMC9jX6E05oC4W9t0+7njHe5O1udZPX0uK efHKkQUwYOYiISP6j8Wx/aYrmpA62ZWgP4epcecin+LfDU18s+UJbfM03QzvQrdJkX71oa CoplkeMENxRsRwN9A2K3ZjgQA/RcoY+NimuzZD+ZvOw08kVSdwKHZOBjhYWqyg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1669836006; 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=1CdXaJIev9ruzG0MgQRyyCj4jPkHgkQU+tV1VqhRrVQ=; b=wp/LaqzMhrkJRioRZOB/iL7t8JUzblzo+7y1w9j7FFOIMUDHSem5/+0Hr4GyZmBKCI8xce bAEe9AmQEj/u0ibNr72IXg4xxSKZlpU7HFzNgCLGSbmDCsz/2iDMGcS4PwZI2VnX7cQ1vx X/2vn0eVyu+nMBymM1/qeObvEWxBADFgU09k1sdqtV3eOf1SWFtnxj0g6namRWIT5wRGte 9BUXNUU1nOCkoh1kylh33gg2GcPKLYKPMczHtISmf1u0yDebycVNO/Af3Yw+sw4/n+T7vr KZzf1d5ulr5bwRsy9z+t7mSV0nJzXydJ0UN2OfjZYA9wiMpEXkzy2ljinHlldA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1669836006; a=rsa-sha256; cv=none; b=Wl20FEopQC/A9N7GrdevypYVTGG2LbPWQYZPg5S3iGNVJQe0qex0BfbH/bHB6S/P6EGhFi bzHpJeBPVauJVpqbnelvnYyJ8mEjnm/Br43G2zXBssL5oLnx0FyrJvR1MJHAmKOktJOwbb 48T62RVVEYKVaeHktWAYdbvFyRwrFpjzu2gXa7jKSbq2ZUIsz29plkGpjbeb5RiF2MygeS I5o/tREhwsZtGRatF+khipHhE6ExcwhtYu0zNNxUauPtJrfWqCo7RO7xq0Ned/VYY7zubk Qiqv16mrHffDbci1MsJtL0kmmlfnnml+0GoR6a7FxAFgXpElTu/vrkB7nvbNvg== 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 4NMptt3cttz16xM; Wed, 30 Nov 2022 19:20:06 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 2AUJK6nt034986; Wed, 30 Nov 2022 19:20:06 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2AUJK6uY034983; Wed, 30 Nov 2022 19:20:06 GMT (envelope-from git) Date: Wed, 30 Nov 2022 19:20:06 GMT Message-Id: <202211301920.2AUJK6uY034983@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Graham Perrin Subject: git: a9f81805c3 - main - fdp-primer: reduce confusion around section levels 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: a9f81805c39b8a6e0ec6e87ce6d7151764ea850c Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by grahamperrin: URL: https://cgit.FreeBSD.org/doc/commit/?id=a9f81805c39b8a6e0ec6e87ce6d7151764ea850c commit a9f81805c39b8a6e0ec6e87ce6d7151764ea850c Author: Graham Perrin AuthorDate: 2022-11-30 19:16:52 +0000 Commit: Graham Perrin CommitDate: 2022-11-30 19:16:52 +0000 fdp-primer: reduce confusion around section levels Approved by: carlavilla Differential revision: https://reviews.freebsd.org/D37572 --- .../content/en/books/fdp-primer/structure/_index.adoc | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/documentation/content/en/books/fdp-primer/structure/_index.adoc b/documentation/content/en/books/fdp-primer/structure/_index.adoc index d92af964e1..b35fb23373 100644 --- a/documentation/content/en/books/fdp-primer/structure/_index.adoc +++ b/documentation/content/en/books/fdp-primer/structure/_index.adoc @@ -147,9 +147,16 @@ This section contains specific notes about particular documents managed by the F The books are written in AsciiDoc. -The books are organized as an AsciiDoc `book`. -The books are divided into ``part``s, each of which contains several ``chapter``s. -``chapter``s are further subdivided into sections (`=`) and subsections (`==`, `===`) and so on. +For each FreeBSD book, the AsciiDoc document type (aka doctype) is `book`. +Books have ``part``s, each of which contains several ``chapter``s. + +When the document is converted to HTML 5 (using the built-in `html5` backend): + +* AsciiDoc section level 0 (`=`) at the beginning of a ``chapter`` of a `book` will be `

` +* AsciiDoc section level 1 (`==`) must be used for the first logical section of a chapter, and will be `

` +* AsciiDoc section level 2 (`===`) must be used for the first logical subsection, and will be `

` + +– and so on. Reference: link:https://docs.asciidoctor.org/asciidoc/latest/sections/titles-and-levels/[Section Titles and Levels | Asciidoctor Docs]. [[structure-document-books-physical]] === Physical Organization