summaryrefslogtreecommitdiff
path: root/EDITING
blob: 8d0f6a7103fa925eda5ddb8d7b0e2296a90a19cf (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 -- (dash dash) for sentence break or parenthetical statement.
  8. * Use - (hyphen-minus) for ranges or minus (nothing else).
  9. * Use doublequote (") for short quote (e.g. max. 3 lines or 50 words).
  10. * Use singlequote (') for short quote within short quote.
  11. * Use blockquote (alone) for long quote (nothing else).
  12. * Use cite or --- (dash dash dash) after each short or long quote.
  13. * Use hyperlink or footnote for non-citation related info.
  14. * Use emphasis + doublequote for technical or foreign term.
  15. * Use doublequote + emphasis for title.
  16. * Use strong emphasis for essential keyword (nothing else).
  17. * Use canonical URL (not wikilink or relative URL) in hyperlink.
  18. * Use square brackets (not paranthesis) for meta comment.
  19. * Use verbatim for code or shell command (nothing else).
  20. * Fix or remove visual markup in quoted text (e.g. punctuation abuse).
  21. -- Jonas Smedegaard <dr@jones.dk> Mon, 15 Dec 2014 15:28:48 +0100