From 0dcbb5a965086030038db14f64666747ac2736f6 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Tue, 13 Jan 2015 02:54:28 +0100 Subject: Improved markup of markup. --- EDITING | 23 +++++++++++++---------- 1 file 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 `
` 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 Tue, 13 Jan 2015 02:13:31 +0100 -- cgit v1.2.3