mirror of
https://github.com/saveweb/general-writing-laws.git
synced 2024-09-19 11:15:30 -07:00
更新到 0.0.24-beta
也许没有明显的进展
This commit is contained in:
gledos
parent
cddc88acba
commit
620ce541f0
271
README.md
271
README.md
@ -3,7 +3,7 @@
|
||||
```yaml
|
||||
标题: 通用写作律法
|
||||
创建时间: 2023-08-26
|
||||
版本: 0.0.23-beta
|
||||
版本: 0.0.24-beta
|
||||
```
|
||||
|
||||
《<ruby>通用写作律法<rp>(</rp><rt>General Writing Laws</rt><rp>)</rp></ruby>》是由
|
||||
@ -69,7 +69,7 @@ GWLM 18-2、GWLM 18-3。
|
||||
```
|
||||
|
||||
GWLM 0 是收录通用写作律法模块的清单，会收录所有的 GWLM（General Writing Laws Module，
|
||||
通用写作律法模块）内容，并对可行性进行评议，每条 GWLM 都会被分类，分别是「正式」
|
||||
通用写作律法模块）内容，并对可行性评议，每条 GWLM 都会被分类，分别是「正式」
|
||||
「草案」「延期」和「拒绝」。[^bep0]
|
||||
|
||||
[^bep0]: 借用了许多 [BEP 0000][]（BitTorrent 增强建议索引）的设计。
|
||||
@ -102,7 +102,6 @@ GWLM 0 是收录通用写作律法模块的清单，会收录所有的 GWLM（Ge
|
||||
[gwlm-18]: #gwlm-18-简体中文标点符号修补
|
||||
[gwlm-15834]: #gwlm-15834-简体中文标点符号用法模块化
|
||||
|
||||
|
||||
### 延期的 GWLM
|
||||
|
||||
| 序号 | 标题 |
|
||||
@ -171,6 +170,14 @@ GWLM 0 是收录通用写作律法模块的清单，会收录所有的 GWLM（Ge
|
||||
|
||||
通常与纯文本对立，机器可读但人类基本不可读的文件，一般叫做二进制文件。
|
||||
|
||||
+ GWLM 1-?? 块（Markdown）
|
||||
|
||||
+ GWLM 1-?? 内联（Markdown）
|
||||
|
||||
+ GWLM 1-?? 段落排版（段间距与行首缩进）
|
||||
|
||||
请参考〈[GWLM 16-3 段落排版（段间距与行首缩进）](#gwlm-16-3-段落排版段间距与行首缩进)〉小节。
|
||||
|
||||
## GWLM 2 书写系统空间
|
||||
|
||||
```yaml
|
||||
@ -350,7 +357,7 @@ GWLM 0 是收录通用写作律法模块的清单，会收录所有的 GWLM（Ge
|
||||
使用外国的文字通常也是属于「提及」，所以需要使用引号、斜体等方式标记。
|
||||
|
||||
〈GWLM 2-6 外来语修补〉是为引号修补的规则，放弃对一部分具有通用性的直接使用的外来语，
|
||||
使用引号或者斜体等方式进行标记。
|
||||
使用引号或者斜体等方式标记。
|
||||
|
||||
如果文字已经成为了事实上的，直接使用的 [外来语](https://zh.wikipedia.org/wiki/外来语)，
|
||||
比如 DNA、NBA 和 FPS 这些英文缩写，以及 Apple、Facebook、Google 和 Microsoft 这些知名公司。
|
||||
@ -374,7 +381,7 @@ GWLM 0 是收录通用写作律法模块的清单，会收录所有的 GWLM（Ge
|
||||
但是间隔的宽度能看到明显差异，在常规字体自动排版的情况下，顿号的宽度是全角（一个汉字宽度），
|
||||
而西式逗号与空格的宽度加起来仅有半角（半个汉字宽度），这可能会导致顿号排出来的数字不利于数学内容展示。
|
||||
|
||||
〈GWLM 2-7 数学修补〉是为数学内容修补的规则，将数学内容，以西式标点进行书写，包括以下内容。
|
||||
〈GWLM 2-7 数学修补〉是为数学内容修补的规则，将数学内容，以西式标点书写，包括以下内容。
|
||||
|
||||
> [!WARNING]
|
||||
>
|
||||
@ -751,17 +758,34 @@ A1 --> B4 --> C5
|
||||
### GWLM 8-6 仅允许六层标题
|
||||
|
||||
如题，仅允许六个层级的标题，这与 HTML 的标题元素数量相同，HTML 的标题元素分别是
|
||||
`<h1>`、`<h2>`、`<h3>`、`<h4>`、`<h5>`、`<h6>`。
|
||||
`<h1>`、`<h2>`、`<h3>`、`<h4>`、`<h5>` 和 `<h6>`。
|
||||
|
||||
## GWLM 15 Web 内容无障碍指南（WCAG）
|
||||
## GWLM 14 Web 内容无障碍指南（WCAG）
|
||||
|
||||
暂定的规则，需要研究。
|
||||
|
||||
## GWLM 15 纯文本
|
||||
|
||||
使用纯文本来短文可能不会遇到明显问题，但是缺乏一些复杂的排版、字体效果等富文本内容。
|
||||
GWLM 15 将参考各种常用纯文本使用者的观点，整理出各种纯文本的用法。
|
||||
|
||||
### GWLM 15-0 概述
|
||||
|
||||
〔待续〕
|
||||
|
||||
Markdown、Org-mode
|
||||
|
||||
#### 电子邮件纯文本格式
|
||||
|
||||
〔待续〕
|
||||
|
||||
涉及 [RFC 2646][]。
|
||||
|
||||
[RFC 2646]: https://datatracker.ietf.org/doc/html/rfc2646
|
||||
|
||||
## GWLM 16 富文本
|
||||
|
||||
纯文本可以以 GWLM 15834 作为底层参考规范，但富文本缺乏相关的规范。
|
||||
|
||||
GWLM 16 将参考各种常用富文本的作者的观点，整理出各种富文本的用法。
|
||||
富文本缺乏相关的规范。GWLM 16 将参考各种常用富文本使用者的观点，整理出各种富文本的用法。
|
||||
|
||||
### GWLM 16-0 概述
|
||||
|
||||
@ -772,17 +796,17 @@ GWLM 16 将参考各种常用富文本的作者的观点，整理出各种富文
|
||||
| 富文本大类 | HTML | PDF | Word（办公套件） |
|
||||
| ------------ | -------------------- | ---------------- | ---------------- |
|
||||
| 可视化编辑器 | Adobe Dreamweaver 等 | Adobe Acrobat 等 | 自身 |
|
||||
| 纯文本中间态 | Markdown、BBCode 等 | TeX、LaTeX 等 | ／ |
|
||||
| 纯文本中间态 | Markdown、BBCode 等 | LaTeX 等 | ／ |
|
||||
|
||||
备注：HTML、PDF 和 Word 能够互相转换，但可能丢失部分排版信息。
|
||||
|
||||
### GWLM 16-1 字体
|
||||
|
||||
### GWLM 16-1-0 概述
|
||||
#### GWLM 16-1-0 概述
|
||||
|
||||
字体包含：字体、尺寸、字重、倾斜。
|
||||
字体包含：字体、尺寸、字重和倾斜。
|
||||
|
||||
### GWLM 16-1-1 字体
|
||||
#### GWLM 16-1-1 字体
|
||||
|
||||
简介：
|
||||
|
||||
@ -886,7 +910,24 @@ Markdown 在使用 [内联代码](https://spec.commonmark.org/0.30/#code-spans)
|
||||
|
||||
#### GWLM 16-1-2 尺寸
|
||||
|
||||
〔待续〕
|
||||
简介：
|
||||
|
||||
字体的尺寸在矢量字体的时代，可以随意放大缩小。通常文字作品会用最大的字体作为一级标题，之后的级别依次变小，
|
||||
最后与正文的字体相当大小。
|
||||
|
||||
使用：
|
||||
|
||||
大尺寸的字体作为强调或装饰使用，比如 [首字放大](https://zh.wikipedia.org/wiki/首字放大)，
|
||||
以及在论坛的富文本编辑器中，用大号的字体模仿 `<h2>`、`<h3>` 这样的标题使用。
|
||||
|
||||
Markdown：
|
||||
|
||||
Markdown 本身没有对段落中的字体尺寸调整的标记，不过可以借用 HTML 的 `<big>`、`<small>` 元素。
|
||||
然而 `<big>`、`<small>` 元素因为 HTML 与 CSS 分离主义影响，现已被弃用，只是为了兼容性，
|
||||
暂时仍能完成解析，所以应使用 CSS 解决文字大小。
|
||||
|
||||
标题算是能调整字体尺寸的标记，但不建议使用在标题之外的地方，因为这会生成 `<h2>`、`<h3>` 等元素，
|
||||
应确保 HTML 语义的完整、无歧义为优先，这样才能实现无障碍。
|
||||
|
||||
#### GWLM 16-1-3 字重
|
||||
|
||||
@ -899,9 +940,9 @@ Markdown 在使用 [内联代码](https://spec.commonmark.org/0.30/#code-spans)
|
||||
|
||||
CJK 字符等地都没有大规模使用粗体汉字的情况，并且缺乏原生粗体的汉字字体，所以不建议在富文本排版时使用。
|
||||
|
||||
不过大多西式的工具缺乏着重符号，所以会有写作人使用粗体替代。
|
||||
不过大多西式的工具缺乏着重号，所以会有写作人使用粗体替代。
|
||||
|
||||
中英混排时，强调一段同时含有中英文字的情况时，可能是噩梦……因为既需要给汉字添加着重符号（底部点符号），
|
||||
中英混排时，强调一段同时含有中英文字的情况时，可能是噩梦……因为既需要给汉字添加着重号（底部点符号），
|
||||
也要给西文添加粗体状态吧。如何混排使用强调，还需要进一步研究。
|
||||
|
||||
Markdown：
|
||||
@ -925,7 +966,7 @@ Markdown 的粗体使用星号 `**` 或下划线 `__` 作为标记，比如：
|
||||
__这是加粗的句子。__
|
||||
```
|
||||
|
||||
例如在多人参与编写的文档中，可以限定一种标记方式：
|
||||
在多人参与编写的文档中，为了一致性，可以限定一种标记方式：
|
||||
|
||||
+ GWLM Markdown 1-3-1 使用星号 `**` 表示加粗。
|
||||
+ GWLM Markdown 1-3-2 使用下划线 `__` 表示加粗。
|
||||
@ -962,11 +1003,197 @@ Markdown 的斜体使用星号 `*` 或下划线 `_` 作为标记，比如：
|
||||
_这是倾斜的句子。_
|
||||
```
|
||||
|
||||
例如在多人参与编写的文档中，可以限定一种标记方式：
|
||||
在多人参与编写的文档中，为了一致性，可以限定一种标记方式：
|
||||
|
||||
+ GWLM Markdown 1-4-1 使用星号 `*` 表示倾斜。
|
||||
+ GWLM Markdown 1-4-2 使用下划线 `_` 表示倾斜。
|
||||
|
||||
### GWLM 16-2 其他字体效果
|
||||
|
||||
#### GWLM 16-1-0 概述
|
||||
|
||||
其他字体效果包含：下划线、删除线、着重号……
|
||||
|
||||
#### GWLM 16-1-1 下划线
|
||||
|
||||
简介：
|
||||
|
||||
西方的下划线历史，与手稿、打字机有关，是文字成品之前的中间形态使用的标识符：
|
||||
|
||||
```manuscript_typewriter
|
||||
The middle of this.
|
||||
‾‾‾‾‾‾
|
||||
```
|
||||
|
||||
这被称作校对标记（[proofreader's marks](https://en.wikipedia.org/wiki/List_of_proofreader's_marks)），
|
||||
用来指出应该使用斜体的内容，不应该在成品中展示。
|
||||
|
||||
时间来互联网早期，此时没有开箱即用的富文本，早期的电子邮件基本只能使用纯文本，所以在左右添加下划线来表示斜体：
|
||||
|
||||
```email
|
||||
The _middle_ of this.
|
||||
```
|
||||
|
||||
使用：
|
||||
|
||||
〔待续〕
|
||||
|
||||
Markdown：
|
||||
|
||||
〔待续〕
|
||||
|
||||
#### GWLM 16-1-2 删除线
|
||||
|
||||
简介：
|
||||
|
||||
〔待续〕
|
||||
|
||||
使用：
|
||||
|
||||
〔待续〕
|
||||
|
||||
Markdown：
|
||||
|
||||
〔待续〕
|
||||
|
||||
#### GWLM 16-1-3 着重号
|
||||
|
||||
简介：
|
||||
|
||||
〔待续〕
|
||||
|
||||
使用：
|
||||
|
||||
〔待续〕
|
||||
|
||||
Markdown：
|
||||
|
||||
〔待续〕
|
||||
|
||||
### GWLM 16-3 标题
|
||||
|
||||
简介：
|
||||
|
||||
标题通常是一段标记作品名称的字符串，通常是可读的，也存在使用无意义、单纯标号当作标题的情况。
|
||||
|
||||
使用：
|
||||
|
||||
〔待续〕
|
||||
|
||||
Markdown：
|
||||
|
||||
Markdown 有两种标题标记，分别是：
|
||||
|
||||
+ ATX 式标题
|
||||
|
||||
ATX 式标题源自亚伦·斯沃茨设想的 [atx 标记语言][]。尚不明确 atx 的含义，可能指「亚伦 TeX」。
|
||||
|
||||
[atx 标记语言]: https://web.archive.org/web/20040223210813/http://www.aaronsw.com/2002/atx/intro
|
||||
|
||||
```markdown
|
||||
# Test Title a1
|
||||
|
||||
## Test Title a2
|
||||
|
||||
### Test Title a3
|
||||
```
|
||||
|
||||
```html
|
||||
<h1>Test Title a1</h1>
|
||||
<h2>Test Title a2</h2>
|
||||
<h3>Test Title a3</h3>
|
||||
```
|
||||
|
||||
+ Setext 式标题
|
||||
|
||||
这是源自 [Setext](https://en.wikipedia.org/wiki/Setext) 标记语言的标题，缺点是只有 `<h1>` 和 `<h2>` 两种，
|
||||
其他层级的标题仍需要 ATX 式标题。
|
||||
|
||||
```markdown
|
||||
Test Title b1
|
||||
=============
|
||||
|
||||
Test Title b2
|
||||
-------------
|
||||
```
|
||||
|
||||
```html
|
||||
<h1>Test Title b1</h1>
|
||||
<h2>Test Title b2</h2>
|
||||
```
|
||||
|
||||
在多人参与编写的文档中，为了一致性，可以限定一种标记方式：
|
||||
|
||||
+ GWLM Markdown 2-1 仅使用 ATX 式标题标记。
|
||||
+ GWLM Markdown 2-2 在 `<h1>` 和 `<h2>` 时，使用 Setext 式标题标记。
|
||||
|
||||
备注：之所以 Markdown 同时使用了 ATX 和 Setext 两种标题标记，可能是因为 # 在部分文件中表示注释，
|
||||
所以需要 Setext 式标题标记。
|
||||
|
||||
### GWLM 16-4 段落排版（段间距与行首缩进）
|
||||
|
||||
简介：
|
||||
|
||||
```ascii
|
||||
+--+-----------------------------------------------+
|
||||
|a0| Type-A |
|
||||
|a1| ====== |
|
||||
|a2| |
|
||||
|a3| (3) █████████████████████(1)█████████████████ |
|
||||
|a4| ████████████████████ |
|
||||
|a5| (3) █████████████████████(1)██████ |
|
||||
|a6| (3) ... |
|
||||
+--+-----------------------------------------------+
|
||||
|
||||
+--+-----------------------------------------------+
|
||||
|b0| Type-B |
|
||||
|b1| ====== |
|
||||
|b2| |
|
||||
|b3| █████████████████████████(1)█████████████████ |
|
||||
|b4| ████████████████ |
|
||||
|b5| (2) |
|
||||
|b6| █████████████████████████(1)██ |
|
||||
|b7| (2) |
|
||||
|b8| ... |
|
||||
+--+-----------------------------------------------+
|
||||
```
|
||||
|
||||
+ 段落：(1)
|
||||
+ 段间距：(2)、a4 ~ a5
|
||||
+ 行首缩进：(3)
|
||||
+ 行间距：a3 ~ a4、b3 ~ b4
|
||||
|
||||
使用：
|
||||
|
||||
在出版物中，往往使用 A 型段落格式，因为这样更节约纸张，此时的「段间距」与「行间距」往往差距较小。
|
||||
分段情况主要靠行首缩识别。
|
||||
|
||||
在网页等数字格式中，往往使用 B 型段落格式，特点是没有行首缩进，以及较宽的段间距。分段情况主要靠段间距来识别。
|
||||
|
||||
这两种差异可能被叫做「缩进」「空排」，以及其他的说法，总之都是让读者区分段落的工具，通常仅使用一种。
|
||||
|
||||
历史：印刷术、打字机都大大影响了段落排版，其中打字机通常只能一行一行的移动，所以段间距往往直接空一行，
|
||||
这一习惯也一定程度影响到了现代。
|
||||
|
||||
Markdown：
|
||||
|
||||
严格的说，Markdown 本身（解析器）并不是排版工具，排版依靠的是 CSS，所以虽然很多平台和软件支持 Markdown，
|
||||
但各处生成的富文本都有差异，所以 Markdown 也与段落排版的关系不大。
|
||||
|
||||
不过 Markdown 以及 HTML 都有硬换行（断行）的情况：
|
||||
|
||||
```markdown
|
||||
foo\
|
||||
baz
|
||||
```
|
||||
|
||||
```html
|
||||
<p>foo<br />
|
||||
baz</p>
|
||||
```
|
||||
|
||||
一些写作者可能会这样断行，然后当作分段。不建议这么做，应确保 HTML 语义的完整、无歧义为优先，这样才能实现无障碍。
|
||||
|
||||
### GWLM 16-?? 富文本的复合用法
|
||||
|
||||
+ 倾斜与加粗
|
||||
@ -1012,7 +1239,7 @@ Markdown 最初的开发者，以及许多兼容的渲染器都没怎么考虑
|
||||
|
||||
> 有条 issues 在 12月25日 23时20分 发布。
|
||||
|
||||
如果仅有一个时间单位，那么就不进行特殊处理：
|
||||
如果仅有一个时间单位，那么就不特殊处理：
|
||||
|
||||
> 有条 issues 在 25 日 23 时发布。
|
||||
|
||||
@ -2162,7 +2389,7 @@ GWLM 15834-4-17 是替代《GB/T 15834—2011 标点符号用法标准》4.17
|
||||
|
||||
+ GWLM 15834-5-1-10 全宽标点符号排在一行末尾时，应占半角字符的宽度，以使视觉效果更美观。
|
||||
|
||||
+ GWLM 15834-5-1-11 涉及出版工作时，可适当进行标点挤压。
|
||||
+ GWLM 15834-5-1-11 涉及出版工作时，可适当标点挤压。
|
||||
|
||||
#### GWLM 15834-5-2 竖排文稿标点符号的位置和书写形式
|
||||
|
||||
@ -2280,7 +2507,7 @@ GWLM 15834-4-17 是替代《GB/T 15834—2011 标点符号用法标准》4.17
|
||||
|
||||
9. 省略号用法补充规则。
|
||||
|
||||
1. 不应用多于两个省略号（超过 12 个点）。应与连接目录与页面的连珠号进行区别。
|
||||
1. 不应用多于两个省略号（超过 12 个点）。应与连接目录与页数的连珠号区别。
|
||||
|
||||
2. 不应与「等」「等等」「什么的」等词语同时使用。
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user