Page Menu
Home
FreeBSD
Search
Configure Global Search
Log In
Files
F166739390
D37572.diff
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Flag For Later
Award Token
Size
1 KB
Referenced Files
None
Subscribers
None
D37572.diff
View Options
diff --git a/documentation/content/en/books/fdp-primer/structure/_index.adoc b/documentation/content/en/books/fdp-primer/structure/_index.adoc
--- a/documentation/content/en/books/fdp-primer/structure/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/structure/_index.adoc
@@ -147,9 +147,16 @@
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 `<h1>`
+* AsciiDoc section level 1 (`==`) must be used for the first logical section of a chapter, and will be `<h2>`
+* AsciiDoc section level 2 (`===`) must be used for the first logical subsection, and will be `<h3>`
+
+– 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
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Mon, Aug 17, 12:35 AM (3 h, 39 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
36845486
Default Alt Text
D37572.diff (1 KB)
Attached To
Mode
D37572: fdp-primer: reduce confusion around section levels
Attached
Detach File
Event Timeline
Log In to Comment