summaryrefslogtreecommitdiff
path: root/EDITING
blob: a26e8a4bb36b8c0629db49de008a0e875d026948 (plain)
  1. Wiki editing guideline
  2. ======================
  3. Ideally, text authors should apply only semantic (not visual) markup.
  4. Unfortunately, Markdown and Mediawiki formats only cover visual markup.
  5. These are suggestions for pseudo-semantic Markdown/Mediawiki markup,
  6. suitable for post-processing into both web-based and print formats.
  7.   * Use emphasis + doublequote for foreign terms.
  8.   * Use doublequote + emphasis for titles.
  9.   * Use strong emphasis only for essential keywords, and very sparsely.
  10.   * Use blockquote only for citation (not as emphasis for other blocks).
  11.   * Use blockquote for citation block (not blockquote + other quotes).
  12.   * Use bibliography at each citation (preferrably at the end).
  13.   * Use direct link (not bibliography) for "see also" style refences.
  14.   * Use canonical URL in hyperlink (not wikilink or relative URL).
  15.   * Use square brackets for meta comments (not paranthesis).
  16.   * Use verbatim only for code and shell commands.
  17.  -- Jonas Smedegaard <dr@jones.dk>  Mon, 15 Dec 2014 15:28:48 +0100