From 2fbf18ab00bb6abbeab21aa6eaa642b65999bf29 Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Tue, 14 Mar 2023 10:48:26 +0800 Subject: [PATCH 01/11] =?UTF-8?q?feat(format.md):=E5=A2=9E=E5=8A=A0?= =?UTF-8?q?=E6=A0=BC=E5=BC=8F=E6=89=8B=E5=86=8C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- format.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 format.md diff --git a/format.md b/format.md new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/format.md @@ -0,0 +1 @@ + From d1686a16d066102fe147423567575396e28f1b4c Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Fri, 21 Apr 2023 08:55:23 +0800 Subject: [PATCH 02/11] Update format.md --- format.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/format.md b/format.md index 8b1378917..3ad7c3d5c 100644 --- a/format.md +++ b/format.md @@ -1 +1,13 @@ +# wiki格式手册 +感谢您为本wiki做出自己的贡献！ +在参与贡献之前，您需要阅读以下内容，保证自己的贡献内容符合以下规定： + + +## 外部链接 + +- [标点符号用法（GB/T 15834—2011）](http://www.moe.gov.cn/jyb_sjzl/ziliao/A19/201001/W020190128580990138234.pdf) +- [维基百科：格式手册/标点符号](https://zh.wikipedia.org/wiki/Wikipedia:%E6%A0%BC%E5%BC%8F%E6%89%8B%E5%86%8C/%E6%A0%87%E7%82%B9%E7%AC%A6%E5%8F%B7) +- [中文文案排版指北（简体中文版）](https://mazhuang.org/wiki/chinese-copywriting-guidelines/) +- [中文文案风格指南 - PDFE GUIDELINE](https://pdfe.github.io/GUIDELINE/#/others/copywriter) +- [中文出版物夹用英文的编辑规范](https://www.nppa.gov.cn/nppa/contents/805/102791.shtml) From 222a1daa933e4a0c47fbff87e467fcce3375da96 Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Fri, 21 Apr 2023 08:59:54 +0800 Subject: [PATCH 03/11] Update format.md --- format.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/format.md b/format.md index 3ad7c3d5c..88d5ee3e1 100644 --- a/format.md +++ b/format.md @@ -1,5 +1,6 @@ # wiki格式手册 -感谢您为本wiki做出自己的贡献！ + +在您提交贡献之前，Web3Club-Wiki编辑部 全体成员 感谢您为本Wiki做出自己的贡献！ 在参与贡献之前，您需要阅读以下内容，保证自己的贡献内容符合以下规定： From ab960902e01dd23ccffca4e724c9e71e3b501317 Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Fri, 21 Apr 2023 09:01:12 +0800 Subject: [PATCH 04/11] Update format.md --- format.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/format.md b/format.md index 88d5ee3e1..2deb73db6 100644 --- a/format.md +++ b/format.md @@ -4,6 +4,16 @@ 在参与贡献之前，您需要阅读以下内容，保证自己的贡献内容符合以下规定： +## 标点符号的使用 + +- 请在每句话的末尾添加 **句号**。 +- 请正确使用 **全角** 标点符号与 **半角** 标点符号。汉语请使用全角符号，英语请使用半角符号。中文中夹用英文时，请参考 [中文出版物夹用英文的编辑规范](https://www.nppa.gov.cn/nppa/contents/805/102791.shtml)。 +- 由于 `“……”` 未区分全半角，请使用 `「……」` 作为全角引号，`"..."` 作为半角引号。 +- 注意区分 **顿号** 与 **逗号** 的使用。 +- 注意 **括号** 的位置。句内括号与句外括号的位置不同。 +- 通常使用 **分号** 来表示列表环境中各复句之间的关系。 +- 对于有序列表，推荐在每一项的后面添加 **分号**，在列表最后一项的后面添加 **句号**；对于无序列表，推荐在每一项的后面添加 **句号**。 +- 注意区分各种不同的连接号，如 hyphen（一般使用 U+002D hyphen-minus（-），即键盘上的「减号」代替），U+2013 en dash（–）和 U+2014 em dash（—）。（英文中连接多个人名时，须用 en dash，但是极常误用为 hyphen。其他误用较为罕见，基本上只需记住这一点即可。）详见 [连接号 - 维基百科](https://zh.wikipedia.org/wiki/%E8%BF%9E%E6%8E%A5%E5%8F%B7)。 ## 外部链接 From 12fa09fe4825ebb11b90259d95e7f2abf1d5f1da Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Fri, 21 Apr 2023 09:09:36 +0800 Subject: [PATCH 05/11] Update format.md --- format.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/format.md b/format.md index 2deb73db6..a2387a98f 100644 --- a/format.md +++ b/format.md @@ -4,6 +4,22 @@ 在参与贡献之前，您需要阅读以下内容，保证自己的贡献内容符合以下规定： +## 文档引用与存储的格式 + +- **文件名请务必都小写，以 `-` 分割。** 例如：`file-name.md`。 + +- 请务必确保文档中引用的 **外链** 图片已经全部转存到了 **本库内** 对应的 `images` 文件夹中（防止触发某些网站的防盗链），建议处理成 `MD 文档名称 + 编号` 的形式（可参考已有文档中图片的处理方式）。例如：本篇文档的文件名称为 format，则文档中引用的第一张图片的名字为 `format1.png`。 + +- 推荐使用 SVG 格式的图片，以获取较好的清晰度和缩放效果。 + +- 动图如果无法或者不会制作 SVG 格式的，则推荐使用 APNG 格式[^apng]的文件。Windows 用户可使用 [ScreenToGif](https://www.screentogif.com) 录制，Linux 用户可使用 [Peek](https://github.com/phw/peek) 录制，注意需要在设置里调整为录制 APNG。其他情况则推荐先制作为 MP4 等视频文件再转换为 APNG，如果使用 ffmpeg 则可以使用 `ffmpeg -i filename.mp4 -f apng filename.apng -plays 0` 转换。 + +- 同时具有源文件和导出图像的图片（例如 JPG 文件与 PSD 文件或者 SVG 图像与 TikZ TeX 源代码），建议将源文件以与图片相同的文件名保存于同一目录下。 + +- 请确保您的文档中的引用链接的稳定性。**不推荐** 引用 **自建** 服务中的资源。建议在添加时同时将该外链存于互联网档案馆，以防无法替代的链接失效。 + +- 站内链接请去掉网站域名，并且使用相对路径链接对应 `.md` 文件。例如，在本页面（`intro/format`）中链接杂项简介（`misc`），应使用 `[杂项简介](../misc/index.md)`。可以在链接中添加 hash 来链接到某一节，例如 [`[Pull Request 信息格式规范](./htc.md#pull-request-信息格式规范)`](./htc.md#pull-request-信息格式规范)，hash 的值可以通过位于每个标题右侧的按钮或者位于网页右侧的目录中的链接得到。 + ## 标点符号的使用 - 请在每句话的末尾添加 **句号**。 From 6844c297c28c74b1b80830f35f36a0d869d5b50b Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Sat, 22 Apr 2023 12:57:34 +0800 Subject: [PATCH 06/11] Update format.md --- format.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/format.md b/format.md index a2387a98f..91a122616 100644 --- a/format.md +++ b/format.md @@ -20,6 +20,8 @@ - 站内链接请去掉网站域名，并且使用相对路径链接对应 `.md` 文件。例如，在本页面（`intro/format`）中链接杂项简介（`misc`），应使用 `[杂项简介](../misc/index.md)`。可以在链接中添加 hash 来链接到某一节，例如 [`[Pull Request 信息格式规范](./htc.md#pull-request-信息格式规范)`](./htc.md#pull-request-信息格式规范)，hash 的值可以通过位于每个标题右侧的按钮或者位于网页右侧的目录中的链接得到。 +- 根据 2023年4月22日的公告 [《关于 “相关网页中文翻译” 界面的处理办法》](https://www.mubucm.com/doc/Il3SiRnCmC) 相关wiki知识点下的文章 原文（或经翻译完后） 需要嵌入到语雀平台的 + ## 标点符号的使用 - 请在每句话的末尾添加 **句号**。 From ab7bf72566fd8a17f0c9ee44a7cf62b839ce911a Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Sat, 22 Apr 2023 13:01:15 +0800 Subject: [PATCH 07/11] Update format.md --- format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/format.md b/format.md index 91a122616..3c7898820 100644 --- a/format.md +++ b/format.md @@ -20,7 +20,7 @@ - 站内链接请去掉网站域名，并且使用相对路径链接对应 `.md` 文件。例如，在本页面（`intro/format`）中链接杂项简介（`misc`），应使用 `[杂项简介](../misc/index.md)`。可以在链接中添加 hash 来链接到某一节，例如 [`[Pull Request 信息格式规范](./htc.md#pull-request-信息格式规范)`](./htc.md#pull-request-信息格式规范)，hash 的值可以通过位于每个标题右侧的按钮或者位于网页右侧的目录中的链接得到。 -- 根据 2023年4月22日的公告 [《关于 “相关网页中文翻译” 界面的处理办法》](https://www.mubucm.com/doc/Il3SiRnCmC) 相关wiki知识点下的文章 原文（或经翻译完后） 需要嵌入到语雀平台的 +- 根据 2023年4月22日的公告 [《关于 “相关网页中文翻译” 界面的处理办法》](https://www.mubucm.com/doc/Il3SiRnCmC) 相关wiki知识点下的文章 原文（或经翻译完后） 需要嵌入到语雀平台的 Web3Wiki知识库 之后将文章链接放置到知识点最后。 如您不是Web3Wiki编辑部成员 请将原文及翻译内容发至 web3club@email.cn 邮件标题请注明翻译文章+文章链接 ## 标点符号的使用 From 5d4a43b57f9b451075ce452a0c53683d18b975e4 Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Sun, 23 Apr 2023 18:13:58 +0800 Subject: [PATCH 08/11] Update format.md --- format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/format.md b/format.md index 3c7898820..ee2d655a0 100644 --- a/format.md +++ b/format.md @@ -1,6 +1,6 @@ # wiki格式手册 -在您提交贡献之前，Web3Club-Wiki编辑部 全体成员 感谢您为本Wiki做出自己的贡献！ +在您提交贡献之前，Web3Club - Wiki编辑部 全体成员 感谢您为本Wiki做出自己的贡献！ 在参与贡献之前，您需要阅读以下内容，保证自己的贡献内容符合以下规定： From 98b8c8558e80b7cda6d78222bf78559a7d276167 Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Sun, 23 Apr 2023 18:19:18 +0800 Subject: [PATCH 09/11] Update format.md --- format.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/format.md b/format.md index ee2d655a0..4b560c654 100644 --- a/format.md +++ b/format.md @@ -40,3 +40,8 @@ - [中文文案排版指北（简体中文版）](https://mazhuang.org/wiki/chinese-copywriting-guidelines/) - [中文文案风格指南 - PDFE GUIDELINE](https://pdfe.github.io/GUIDELINE/#/others/copywriter) - [中文出版物夹用英文的编辑规范](https://www.nppa.gov.cn/nppa/contents/805/102791.shtml) + + + + +©️ Web3Club｜Web3Wiki 2023-2023 From 12b05bdd94edc4fc8dfc7300dd876f45d0e0da96 Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Sun, 23 Apr 2023 18:30:25 +0800 Subject: [PATCH 10/11] Update format.md --- format.md | 1 + 1 file changed, 1 insertion(+) diff --git a/format.md b/format.md index 4b560c654..e285be7c4 100644 --- a/format.md +++ b/format.md @@ -45,3 +45,4 @@ ©️ Web3Club｜Web3Wiki 2023-2023 + From 233b000cc4042f8db06ab266cf9df839a45bb951 Mon Sep 17 00:00:00 2001 From: Yanbo Wang Date: Thu, 27 Apr 2023 14:07:54 +0800 Subject: [PATCH 11/11] Update format.md --- format.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/format.md b/format.md index e285be7c4..8a1332288 100644 --- a/format.md +++ b/format.md @@ -22,6 +22,8 @@ - 根据 2023年4月22日的公告 [《关于 “相关网页中文翻译” 界面的处理办法》](https://www.mubucm.com/doc/Il3SiRnCmC) 相关wiki知识点下的文章 原文（或经翻译完后） 需要嵌入到语雀平台的 Web3Wiki知识库 之后将文章链接放置到知识点最后。 如您不是Web3Wiki编辑部成员 请将原文及翻译内容发至 web3club@email.cn 邮件标题请注明翻译文章+文章链接 +- 为保证文档引用链接的稳定性，未来所有的文档相关链接将会逐步处理并转到 语雀 平台 进行安置。 + ## 标点符号的使用 - 请在每句话的末尾添加 **句号**。