summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--EDITING21
1 files changed, 21 insertions, 0 deletions
diff --git a/EDITING b/EDITING
new file mode 100644
index 0000000..5801fb2
--- /dev/null
+++ b/EDITING
@@ -0,0 +1,21 @@
+Wiki editing guideline
+======================
+
+Ideally, text authors should apply only semantic (not visual) markup.
+Unfortunately the Markdown format only supports visual markup.
+
+These are suggestions for pseudo-semantic markup using Markdown or
+Mediawiki, suitable for post-processing also into print formats.
+
+ * Use emphasis + doublequote for foreign terms.
+ * Use doublequote + emphasis for titles.
+ * Use strong emphasis only for essential keywords, and very sparsely.
+ * Use blockquote only for citation (not as emphasis for other blocks).
+ * Use blockquote for citation block (not blockquote + other quotes).
+ * Use bibliography at each citation (preferrably at the end).
+ * Use canonical URL in hyperlink (not wikilink or relative URL).
+ * Use hyperlink only in footnote and bibliography (not in text body).
+ * Use square brackets for meta comments (not paranthesis).
+ * Use verbatim only for code and shell commands.
+
+ -- Jonas Smedegaard <dr@jones.dk> Mon, 15 Dec 2014 13:09:24 +0100