EDITING



Wiki editing guideline
======================

Ideally, text authors should apply only semantic (not visual) markup.
Unfortunately, Markdown and Mediawiki formats only cover visual markup.

These are suggestions for pseudo-semantic Markdown/Mediawiki markup,
suitable for post-processing into both web-based and print formats.

  * Use -- (dash dash) for sentence break or parenthetical statement.
  * Use - (hyphen-minus) for ranges or minus (nothing else).
  * Use doublequote (") for short quote (e.g. max. 3 lines or 50 words).
  * Use singlequote (') for short quote within short quote.
  * Use blockquote (alone) for long quote (nothing else).
  * Use cite or --- (dash dash dash) after each short or long quote.
  * Use hyperlink or footnote for non-citation related info.
  * Use emphasis + doublequote for technical or foreign term.
  * Use doublequote + emphasis for title.
  * Use strong emphasis for essential keyword (nothing else).
  * Use canonical URL (not wikilink or relative URL) in hyperlink.
  * Use square brackets (not paranthesis) for meta comment.
  * Use verbatim for code or shell command (nothing else).
  * Fix or remove visual markup in quoted text (e.g. punctuation abuse).

 -- Jonas Smedegaard <dr@jones.dk>  Mon, 15 Dec 2014 15:28:48 +0100