Conventions used on this site
Printed manuals used to open with a page that explained their own typography, so that readers knew what a hand in the margin or a bold word meant before they ran into one. This site borrows the look of those manuals, so it borrows that page too.
Structure
Each post is treated as a chapter. Sections are numbered 1.1, 1.2, and so on, and subsections 1.1.1, 1.1.2. Figures and tables follow the same scheme: Figure 1-2 is the second figure in a post, and Table 1-1 is the first table.
Pages that aren’t posts, like this one, mark their sections with a section sign (§) instead of a number. A small square marks the end of a post.
Symbols in the margin
Notes and warnings aren’t boxed. Instead, a symbol in the left margin points at the line where they begin:
On wide screens, quotations from other people hang an opening quotation mark in the margin.
Text conventions
| Convention | Used for |
|---|---|
| Italics | Emphasis, titles of works, and terms being introduced. |
Monospace |
Code, commands, file names, and anything you’d type. |
| Underlined text | Links to other pages and sites. |
| Spaced capitals | Labels, dates, and other navigation aids. |
Code samples
Code is set in monospace on a lightly shaded ground, with keywords in blue and the language in a black tab at the top right:
vale --config=.vale.ini docs/
Any departure from these conventions is a misprint.