Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| rules_conventions_and_policies [2022/09/08 20:13] – admin | rules_conventions_and_policies [2026/01/03 01:26] (current) – [Linkage & Signposting] admin | ||
|---|---|---|---|
| Line 17: | Line 17: | ||
| * Signpost the important terms such as the first time it is used with bold and linkage. Subsequent re-formatting, | * Signpost the important terms such as the first time it is used with bold and linkage. Subsequent re-formatting, | ||
| * If the signposted section is a page header, no need to link. | * If the signposted section is a page header, no need to link. | ||
| + | * ALWAYS try to link child page with ~ (self reference as namespace) where possible. Especially with extensions, as doku __wiki' | ||
| + | |||
| ==== Namespace ==== | ==== Namespace ==== | ||
| Line 58: | Line 60: | ||
| //GDoc and Dokuwiki conventions may not translate. Consider building new conventions specifically for doku.// | //GDoc and Dokuwiki conventions may not translate. Consider building new conventions specifically for doku.// | ||
| - | Must separate __prescriptive__ and __descriptive__ writing. Separate advice (guides) in appendixes | + | Must separate __prescriptive__ and __descriptive__ writing. Separate advice (guides) in appendices |
| - | * Always | + | * Always |
| * **Aim:** add a subtitle summary to supplement the title. Merge the documents before publishing. | * **Aim:** add a subtitle summary to supplement the title. Merge the documents before publishing. | ||
| * Always use section breaks. | * Always use section breaks. | ||
| * Always complete/ | * Always complete/ | ||
| - | * Never edit while writing, Edit in one week. | + | * Never edit while writing. Edit in one week. |
| - | * Never revise | + | * Never revise a document |
| Italic and indent for examples and quotes. | Italic and indent for examples and quotes. | ||
| Line 72: | Line 74: | ||
| * Underline for __emphasis__. | * Underline for __emphasis__. | ||
| * Hyphens --- Used to make extended points and extrapolation of loaded terms. | * Hyphens --- Used to make extended points and extrapolation of loaded terms. | ||
| - | * Square Brackets highlight | + | * Square Brackets highlight |
| * Braces for {mathematical expressions}. | * Braces for {mathematical expressions}. | ||
| * Italic Bold for recurring **//key terms//**. | * Italic Bold for recurring **//key terms//**. | ||
| * Always construct an **Aim** statement for a piece of document and a summative subtitle. | * Always construct an **Aim** statement for a piece of document and a summative subtitle. | ||
| + | |||
| ==== Notes for Style ==== | ==== Notes for Style ==== | ||
| - | Use generic terms where possible. A good convention is to look at the name and see if you can deconstruct | + | Use generic terms where possible. A good convention is to examine |
| * Scripture of Alice -> Book of Alice | * Scripture of Alice -> Book of Alice | ||
| Line 86: | Line 89: | ||
| However, the specialised terms will be retained in the [[Thematic Term Library|Thematic Term Library]]. | However, the specialised terms will be retained in the [[Thematic Term Library|Thematic Term Library]]. | ||
| + | |||
| ==== Writing Tenets ==== | ==== Writing Tenets ==== | ||