• R/O
  • SSH

YSLib-wiki: Commit

The wiki source of YSLib documentation.


Commit MetaInfo

Revisióna1d7b36cdbb24594d3f7017d4a484ffae9a37e10 (tree)
Tiempo2022-08-31 22:19:09
AutorFrankHB <frankhb1989@gmai...>
CommiterFrankHB

Log Message

WikiRules.en-US.md: Added more rules on typography and fixed some imcomplete statements.

Cambiar Resumen

Diferencia incremental

diff -r 2a974847cd04 -r a1d7b36cdbb2 WikiRules.en-US.md
--- a/WikiRules.en-US.md Fri Aug 12 19:22:26 2022 +0800
+++ b/WikiRules.en-US.md Wed Aug 31 21:19:09 2022 +0800
@@ -132,11 +132,17 @@
132132
133133 Two subsequent newlines indicate an [EOF](http://en.wikipedia.org/wiki/End-of-file) logically. Subsequent newlines out of verbatim quoted text (including source code) should only be used at EOF.
134134
135-Except at the first of line, each word which consists of [alphanumeric](http://en.wikipedia.org/wiki/Alphanumeric) characters should be seperated by a single space character(U+0020) with other words.
135+There are also some default rules on typography implemented by ordinary characters in plain texts:
136136
137-No [space characters](http://en.wikipedia.org/wiki/Space_characters#Spaces_in_Unicode) should be at [EOL](http://en.wikipedia.org/wiki/End-of-line).
138-
139-To keep the semantics rules clear, use [horizontal tab character(U+0009)](http://en.wikipedia.org/wiki/Tab_key#Tab_characters) instead of [other spaces(i.e. U+0020)](http://en.wikipedia.org/wiki/Space_%28punctuation%29) to indent, unless the text is verbatim quoted.
137+* No [space characters](http://en.wikipedia.org/wiki/Space_characters#Spaces_in_Unicode) should be at [EOL](http://en.wikipedia.org/wiki/End-of-line).
138+* For text other than verbatim quoted, no more than one [whitespace characters](https://en.wikipedia.org/wiki/Whitespace_character) should be used to represent a single indent, except there are preferred combination in the language.
139+ * **Rationale** By default, no more than one whitespaces should be used to represent an indent, because there should be no chance to insert a character in the middle of an indent.
140+ * **NOTE** An example of preferred exceptional case is that the hanging indent (in the first line of a paragraph) in east Asian languages where dedicated combination of [fullwidth](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) whitespaces are preferred. Typically, the sequence consists of 2 [ideographic space (U+3000)](https://en.wikipedia.org/wiki/Whitespace_character#Unicode).
141+ * **NOTE** To keep the semantics rules clear, when possible (in horizontal texts and out of the context of making tables) and no other forms are more preferred by the rules of the language, use [horizontal tab character(U+0009)](http://en.wikipedia.org/wiki/Tab_key#Tab_characters) instead of [other spaces (i.e. U+0020)](http://en.wikipedia.org/wiki/Space_%28punctuation%29) to indent.
142+* For Western languages, except at the first of line, each word which consists of [alphanumeric](http://en.wikipedia.org/wiki/Alphanumeric) characters should be seperated by a single space character (U+0020) with other words.
143+* Space characters (U+0020) should be used for alignment when portability is required.
144+ * **Rationale** This makes the visal effect easy to predicate in the usual settings with monospaced fonts in contexts like source code of programs.
145+ * **NOTE** Other spaces like [non-breaking space (U+00A0)](https://en.wikipedia.org/wiki/Non-breaking_space) may be better in specific uses, but not portable as U+0020.
140146
141147 ## [Markdown](http://en.wikipedia.org/wiki/Markdown)
142148
@@ -163,9 +169,11 @@
163169
164170 Headers should be prefixed by `#`s.
165171
166-For sake of compact annotation representation, there should be no redundant characters allowed between the annotated words and annotation (esp. [whitespace characters](https://en.wikipedia.org/wiki/Whitespace_character)), even there are whitespaces in the words. The annotation in this rule includes any language tag annotation defined in previous subclause.
172+There should be no redundant characters allowed between the annotated words and annotation (esp. whitespace characters), even there are whitespaces in the words. The annotation in this rule includes any language tag annotation defined in previous subclause.
167173
168-The whitespace rules in the language annotation is also
174+**Rational** This is for the sake of compact annotation representations.
175+
176+**NOTE** The whitespace rules in the language annotation is also applicable. Instead, it is also allowed to use word combination (instead of the annotation) when gramatically correct, so this rule does not apply.
169177
170178 # Cross references
171179
Show on old repository browser