mirror of
https://github.com/saveweb/general-writing-laws.git
synced 2024-09-19 03:05:30 -07:00
更新到 0.0.21-beta
+ 修复部分细节问题 + 添加〈GWLM 8-0 多级标题概述〉
This commit is contained in:
gledos
parent
951756e115
commit
dab8fe796a
164
README.md
164
README.md
@ -3,7 +3,7 @@
|
||||
```yaml
|
||||
标题: 通用写作律法
|
||||
创建时间: 2023-08-26
|
||||
版本: 0.0.21-beta
|
||||
版本: 0.0.22-beta
|
||||
```
|
||||
|
||||
《<ruby>通用写作律法<rp>(</rp><rt>General Writing Laws</rt><rp>)</rp></ruby>》是由
|
||||
@ -32,6 +32,21 @@ Full support for other writing system, and _General Writing Laws_ translations a
|
||||
|
||||
目前暂未完成各项模块的情况，一定会有编号变动，甚至重构的情况。
|
||||
|
||||
## 待解决的问题
|
||||
|
||||
### 同一标点符号的表示方法
|
||||
|
||||
英文省略号有多写法，分别有：
|
||||
|
||||
| 写法 | 来源 | 备注 |
|
||||
| :---: | :--------------------------------: | ---------------------- |
|
||||
| . . . | _The Chicago Manual of Style_ | 西式句点，之间含有空格 |
|
||||
| ... | _AP Stylebook_ | 西式句点 |
|
||||
| … | _Butterick’s Practical Typography_ | `U+2026` |
|
||||
|
||||
这些写作规则，都有明确的盈利性，所以不方便移植成开放的兼容规则，也许需要从头编写英文的各种写作方法……
|
||||
这应该是一个更复杂的工程。
|
||||
|
||||
## 简介
|
||||
|
||||
《律法》是为了将各种书写规范模块化，而诞生的规则，借鉴了一些 [BEP 0000][]（BitTorrent 增强建议索引）的设计。
|
||||
@ -44,7 +59,7 @@ Full support for other writing system, and _General Writing Laws_ translations a
|
||||
<!-- 因为《律法》是模块化的，所以可以选配各种不同的规范，然后生成仅包含这些规范的个性化《律法》。（此功能暂未实现） -->
|
||||
|
||||
目前《律法》本身的书写规范是：GWLM 2-1、GWLM 2-2、GWLM 2-3、GWLM 2-6、GWLM 2-8、GWLM 3-1、GWLM 18-1、
|
||||
GWLM 18-2、GWLM 18-3
|
||||
GWLM 18-2、GWLM 18-3。
|
||||
|
||||
## GWLM 0 通用写作律法模块
|
||||
|
||||
@ -281,6 +296,15 @@ GWLM 0 是收录通用写作律法模块的清单，会收录所有的 GWLM（Ge
|
||||
|
||||
+ 其他语言待编写。
|
||||
|
||||
示例：
|
||||
|
||||
> 我听说过« Beispiel in Frankreich » «Beispiel in der Schweiz» »Beispiel in Deutschland und Österreich«
|
||||
> 《十万个为什么》『吾輩は猫である』_Steve Jobs_ 这些书名。
|
||||
|
||||
分别是法文、瑞士、德国／奥地利、中文、日文和英文的书名号表示方式。[^53627]
|
||||
|
||||
[^53627]: 德语世界, 《[【学生园地】德语的引号问题](https://www.sohu.com/a/www.sohu.com/a/289535110_653627)》, 搜狐新闻／搜狐号, 2019-01-16. (参照 2023-08-26).
|
||||
|
||||
### GWLM 2-4 括号修补
|
||||
|
||||
〈GWLM 2-4 括号修补〉是为括号修补的规则，直接使用文字来源主体的语言的括号表达方式。
|
||||
@ -385,8 +409,6 @@ GWLM 0 是收录通用写作律法模块的清单，会收录所有的 GWLM（Ge
|
||||
创建时间: 2023-08-26
|
||||
```
|
||||
|
||||
GWLM 3 待修改，因为与 GWLM 2 存在矛盾。＊
|
||||
|
||||
### GWLM 3-1 书写系统规范核心规则
|
||||
|
||||
书写系统规范由词典、语法、正字法、标点符号用法标准以及其他细节组成。
|
||||
@ -540,13 +562,6 @@ GWLM 3-6-1 与 GWLM 3-7-1 的结果看起来相同，当其作用的领域不同
|
||||
|
||||
启用 GWLM 3-2 后，如果提到了不同书写系统的作品名，那么需要使用当地书写系统的书名表达方式： -->
|
||||
|
||||
> 我听说过« Beispiel in Frankreich » «Beispiel in der Schweiz» »Beispiel in Deutschland und Österreich«
|
||||
> 《十万个为什么》『吾輩は猫である』_Steve Jobs_ 这些书名。
|
||||
|
||||
分别是法文、瑞士、德国／奥地利、中文、日文和英文的书名号表示方式。[^53627]
|
||||
|
||||
[^53627]: 德语世界, 《[【学生园地】德语的引号问题](https://www.sohu.com/a/www.sohu.com/a/289535110_653627)》, 搜狐新闻／搜狐号, 2019-01-16. (参照 2023-08-26).
|
||||
|
||||
## GWLM 4 兼容性
|
||||
|
||||
```yaml
|
||||
@ -554,15 +569,17 @@ GWLM 3-6-1 与 GWLM 3-7-1 的结果看起来相同，当其作用的领域不同
|
||||
创建时间: 2023-08-26
|
||||
```
|
||||
|
||||
### 兼容其他规范
|
||||
|
||||
简介里有提到因为《律法》是模块化的，所以可以选配各种不同的规范，所以现有的排版规范也可以使用《律法》来实现。
|
||||
|
||||
《[中文文案排版指北][]》是相当知名的中文文案、排版方案，可以通过启用部分《律法》模块来兼容《指北》，
|
||||
具体是 GWLM 3-0, GWLM 3-1, GWLM 3-2-3, GWLM 3-3-3, GWLM 3-4-3, GWLM 3-6-1。
|
||||
具体需要启用 GWLM 2-1、GWLM 3、GWLM 2-8、GWLM 2-2、GWLM 2-3、GWLM 2-9、GWLM 18-2。
|
||||
|
||||
[中文文案排版指北]: https://github.com/sparanoid/chinese-copywriting-guidelines
|
||||
|
||||
《中文技术文档的写作规范》（ruanyf/document-style-guide）是阮一峰编写的中文技术文档排版方案，
|
||||
可以通过启用部分《律法》模块来兼容《中文技术文档的写作规范》，具体需要启用
|
||||
GWLM 2-1、GWLM 3、GWLM 2-8、GWLM 2-2、GWLM 2-3、GWLM 2-9、GWLM 8-6
|
||||
|
||||
## GWLM 5 表情
|
||||
|
||||
```yaml
|
||||
@ -623,6 +640,105 @@ Emoji 被视作半角字符，并且连续使用时，Emoji 之间也需要有
|
||||
|
||||
暂定的数学规则，需要研究。
|
||||
|
||||
## GWLM 8 多级标题
|
||||
|
||||
### GWLM 8-0 多级标题概述
|
||||
|
||||
文字作品有许多种结构，现在流行的是树状结构，比如下面的大纲演示：
|
||||
|
||||
> 《魔法从入门到放弃》
|
||||
>
|
||||
> + 前言
|
||||
> + 关键词
|
||||
> + 1 魔法的原理
|
||||
> + 1.1 魔法与术式
|
||||
> + 1.2 个人现实
|
||||
> + 1.3 相信的心就是你的魔法
|
||||
> + 1.4 ……
|
||||
> + 2 试着使用魔法吧
|
||||
> + 2.1 魔道具挑选指南
|
||||
> + 2.2 ……
|
||||
|
||||
```mermaid
|
||||
---
|
||||
title: "《魔法从入门到放弃》的树状结构"
|
||||
---
|
||||
flowchart TD
|
||||
|
||||
A1[魔法从入门到放弃]
|
||||
B1[前言]
|
||||
B2[关键词]
|
||||
B3[魔法的原理]
|
||||
C1[魔法与术式]
|
||||
C2[个人现实]
|
||||
C3[相信的心就是你的魔法]
|
||||
C4["……"]
|
||||
B4[试着使用魔法吧]
|
||||
C5[魔道具挑选指南]
|
||||
C6["……"]
|
||||
|
||||
A1 --> B1
|
||||
A1 --> B2
|
||||
A1 --> B3 --> C1
|
||||
B3 --> C2
|
||||
B3 --> C3
|
||||
B3 --> C4
|
||||
A1 --> B4 --> C5
|
||||
B4 --> C6
|
||||
```
|
||||
|
||||
许多书籍、论文以及技术文档都是类似的结构，这类结构会让文字作品出现多级标题：
|
||||
|
||||
> 1. 一级标题《魔法从入门到放弃》
|
||||
> 2. 二级标题〈魔法的原理〉
|
||||
> 3. 三级标题〈相信的心就是你的魔法〉
|
||||
|
||||
或者：
|
||||
|
||||
> 1. 主标题《魔法从入门到放弃》
|
||||
> 2. 一级标题〈魔法的原理〉
|
||||
> 3. 二级标题〈相信的心就是你的魔法〉
|
||||
|
||||
「一级标题、二级标题、三级标题、……」或「根标题、一级标题、二级标题、……」，
|
||||
这些排列方法都只是代号，没有本质区别。
|
||||
|
||||
多级标题是树状结构，也就意味着层级关系明确，应以相邻的标题层级连接，比如在二级标题〈魔法的原理〉下，
|
||||
再编写的〈相信的心就是你的魔法〉标题，应该使用三级标题。
|
||||
|
||||
### GWLM 8-1 禁用多级标题
|
||||
|
||||
如题，仅允许一个层级的标题，即：
|
||||
|
||||
> 1. 一级标题《魔法从入门到放弃》
|
||||
|
||||
### GWLM 8-2 仅允许二层标题
|
||||
|
||||
如题，仅允许两个层级的标题，即：
|
||||
|
||||
> 1. 一级标题《魔法从入门到放弃》
|
||||
> 2. 二级标题〈魔法的原理〉
|
||||
|
||||
### GWLM 8-3 仅允许三层标题
|
||||
|
||||
如题，仅允许三个层级的标题，即：
|
||||
|
||||
> 1. 一级标题《魔法从入门到放弃》
|
||||
> 2. 二级标题〈魔法的原理〉
|
||||
> 3. 三级标题〈相信的心就是你的魔法〉
|
||||
|
||||
### GWLM 8-4 仅允许四层标题
|
||||
|
||||
如题，仅允许四个层级的标题。
|
||||
|
||||
### GWLM 8-5 仅允许五层标题
|
||||
|
||||
如题，仅允许五个层级的标题。
|
||||
|
||||
### GWLM 8-6 仅允许六层标题
|
||||
|
||||
如题，仅允许六个层级的标题，这与 HTML 的标题元素数量相同，HTML 的标题元素分别是
|
||||
`<h1>`、`<h2>`、`<h3>`、`<h4>`、`<h5>`、`<h6>`。
|
||||
|
||||
## GWLM 16 纯文本与富文本
|
||||
|
||||
暂定的规则，需要研究。
|
||||
@ -717,6 +833,26 @@ Emoji 被视作半角字符，并且连续使用时，Emoji 之间也需要有
|
||||
| 「 | `U+300C` | ｢ | `U+FF62` |
|
||||
| 」 | `U+300D` | ｣ | `U+FF63` |
|
||||
|
||||
## GWLM 100 连续汉字问题
|
||||
|
||||
〔内容待填充〕
|
||||
|
||||
> 〇〇中学学生会会长。
|
||||
|
||||
> 〇〇车站站体体积很大。
|
||||
|
||||
> 列车车长。
|
||||
|
||||
> 上海南站站。
|
||||
|
||||
> 上海火车站站。
|
||||
|
||||
## GWLM 101 冗余首字母缩写综合征
|
||||
|
||||
〔内容待填充〕
|
||||
|
||||
ATM（自动取款机）有时为了标明其机器属性，也会使用 ATM 机（ATM machine），这样的拼写方式叫做 [RAS syndrome](https://en.wikipedia.org/wiki/RAS_syndrome)（redundant acronym syndrome, 冗余首字母缩写综合征），比如 HIV 病毒、LCD 显示器甚至是 IP 协议……
|
||||
|
||||
## GWLM 15834 简体中文标点符号用法模块化
|
||||
|
||||
```yaml
|
||||
|
||||
Loading…
Reference in New Issue
Block a user