On Style
- Kotlyn Vineyard
- Eryn Vineyard
Welcome to the authoritative1 style guide2 for the Vineyard. Some of this was referenced from the Associated Press Style Guide. This should be considered a living document and may change without prior notice.
Note
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this section are to be interpreted as described in RFC 2119.
Formats
The formats listed below are REQUIRED to be used.
- Dates:
YYYY-MM-DD - Times:
HH:MM:SS, 24 hour time - Timestamp:
YYYY-MM-DD HH:MM:SS, 24 hour time
If a quote uses different formats, it MUST be replaced. For example:
It is currently 10:00pm in New York
MUST be rewritten as:
It is currently [22:00] in New York
Units
The units listed below are REQUIRED to be used. Units SHOULD NOT be abbreviated.
- Temperature: Celsius
- Length: Meters (Metric)
- Mass: Grams (Metric)
- Data: Binary (IEEE 1541). Byte-based units SHOULD be used unless it makes more sense to use bit-based units.
If a quote uses different units, it MUST be replaced. For example:
[Interstate-10] is the fourth-largest Interstate in the [United States] at 2,460.34 miles
MUST be rewrititen as:
[Interstate-10] is the fourth-largest Interstate in the [United States] at [3,959.53 kilometers]
Numbers
Numbers less than ten SHOULD be written out; except in the following cases:
- Ages (35 years old)
- Dimensions (2 by 4 is the best plank)
- Money (10 dollar latte)
- Dates (7th of May)
- Temperature (90 degrees Celsius)
- Percentages (95% confident)
Sentences SHOULD NOT begin with a number; unless the number is for a year (2025 is a year).
Editorial
- Pages SHOULD be written in Markdown.
- Lines MUST NOT extend past 80 columns.
- Footnotes SHOULD be located in the same section as their usage.
- Sidenotes MUST NOT interrupt content.
- A page MUST be fully readable in:
- Firefox (desktop/mobile web, print, reader)
- Chromium (desktop/mobile web, print, reader)
- W3M, Lynx
- Sources MUST be provided
- Quotes MUST be properly cited and use the
Quote
Frontmatter MUST be ordered in:
titledatecreatedlayoutauthorstagsdescription
Footnotes
Kinda pushing it ↩
Last edited
