summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2015-01-13 02:54:28 +0100
committerJonas Smedegaard <dr@jones.dk>2015-01-13 02:54:28 +0100
commit0dcbb5a965086030038db14f64666747ac2736f6 (patch)
treec5b09155b0f6b4ed79c7639e2bdc3a76608c1f7b
parent88776fe4733145b087e328a78a6bdec999fff32a (diff)
Improved markup of markup.
-rw-r--r--EDITING23
1 files changed, 13 insertions, 10 deletions
diff --git a/EDITING b/EDITING
index 3e71da2..f23b287 100644
--- a/EDITING
+++ b/EDITING
@@ -73,28 +73,31 @@ Below syntaxes may not be used for any other semantic purpose.
### Emphasis
- * Surround `*" "*` or `''" "''` (emphasis + doublequote) for technical or foreign term.
- * Surround `"* *"` or `"'' ''"` (doublequote + emphasis) for title.
- * Surround `** **` or `''' '''` (strong emphasis) for essential keyword.
+ * Surround `*` `*` or `''` `''` (emphasis) in general.
+ * Surround `*"` `"*` or `''"` `"''` (emphasis + doublequote) for technical or foreign term.
+ * Surround `"*` `*"` or `"''` `''"` (doublequote + emphasis) for title.
+ * Surround `**` `**` or `'''` `'''` (strong emphasis) for essential keyword.
### Links
* Use canonical URL (not relative, wiki-URL, redirection or backup).
- * Surround `<>` for bare URL.
+ * Surround `<` `>` (angle bracket) for bare URL.
+ * Avoid archive URL (except as such: archiveurl keyword in citation).
+ * Avoid relative or redirection URL.
### Comment or note
- * Surround `[]` (square brackets) for meta comment.
- * Surround `[^`[note][]` ]` or `<`[ref][]` >` for foot-/end-/sidenote.
+ * Surround `[` `]` (square bracket) for meta comment.
+ * Surround `[^`[note][] `]` or `<`[ref][] `>` for foot-/end-/sidenote.
[note]: http://johnmacfarlane.net/pandoc/README.html#footnotes
[ref]: https://meta.wikimedia.org/wiki/Help:Footnotes
### Quotation
- * Surround `"` (doublequote) in general.
+ * Surround `"` `"` (doublequote) in general.
* Use `<blockquote>` for full paragraph or when crossing paragraphs.
- * Surround `'` (singlequote) within another `"`-surrounded quote.
+ * Surround `'` `'` (singlequote) within another `"`-surrounded quote.
* Use `[...]` (dot x 3 in square brackets) to indicate skipped chunk.
* Append citation immediately after each quote.
* Avoid curly quotes (difficult to proof-read or process).
@@ -102,9 +105,9 @@ Below syntaxes may not be used for any other semantic purpose.
### Citation
* Prepend `---` (hyphen-minus x 3) on separate line for simple citation.
- * Use `{{cite }}` ([Citation Style 1][]) to embed bibliography.
+ * Use `{{`[cite][] `}}` to embed bibliography.
* Avoid fancy dash (difficult to proof-read or process).
-[Citation Style 1]: https://en.wikipedia.org/wiki/Help:Citation_Style_1
+[cite]: https://en.wikipedia.org/wiki/Help:Citation_Style_1
-- Jonas Smedegaard <dr@jones.dk> Tue, 13 Jan 2015 02:13:31 +0100