Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
rules_conventions_and_policies [2022/09/08 20:13] adminrules_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, **in the same way**, is not necessary nor prohibited (but it would be a lot of work).   * Signpost the important terms such as the first time it is used with bold and linkage. Subsequent re-formatting, **in the same way**, is not necessary nor prohibited (but it would be a lot of work).
   * 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's auto link adjustment does not cover extension blocks__.
 +
  
 ==== 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 to classifications (study) of the main body. The derivative and generative contents (product) will exist under their own context as a project.+Must separate __prescriptive__ and __descriptive__ writing. Separate advice (guides) in appendices to classifications (study) of the main body. The derivative and generative content (product) will exist within its own context as a project.
  
-  * Always began a project writing in small, segregated documents that carry a distinct +  * Always begin a project by writing in small, separate documents that focus on a distinct topic.
     * **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/perfect ONE piece of content to establish a writing style before writing another similar piece of content.   * Always complete/perfect ONE piece of content to establish a writing style before writing another similar piece of content.
-  * Never edit while writingEdit in one week.  +  * Never edit while writingEdit in one week.  
-  * Never revise until a document is completed.+  * Never revise a document until it is complete.
  
 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 previous defined [Concepts]. +  * Square Brackets highlight previously defined [Concepts]. 
   * 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 the name into a composition of terms suppose you are explaining English to someone who is learning it. If you can, use the basic lexicon that you would use to explain the term to that beginner.+Use generic terms where possible. A good convention is to examine the name and see if you can deconstruct it into a composition of terms, such as when explaining English to someone learning it. If you can, use the basic lexicon that you would use to explain the term to that beginner.
  
   * 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 ====
Driven by DokuWiki
rules_conventions_and_policies.1662682418.txt.gz · Last modified: 2022/09/08 20:13 by admin