Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Customize Markdown for recommended natlang usage #95

Merged
merged 3 commits into from
Nov 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions blog/2023-04-01-site-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ tags: [主创团队的话]

如果您想顺着某个链接拓展阅读但连不上,您也得跟我们技术人员一样,
想办法改善下您的网络接入环境:
本站的程序没法<small>儿</small>顺着网线摸到您的路由器,替您做这事<small>儿</small>
本站的程序没法:儿:顺着网线摸到您的路由器,替您做这事:儿:

本站不会提供这些页面的快照:很多网站是动态的,没法<small>儿</small>快照,
本站不会提供这些页面的快照:很多网站是动态的,没法:儿:快照,
并且快照内容的存储和公开分发是个问题。
毕竟本站无意重新发明一遍○度快照或者 Internet Wayback Machine[^注一]。
本站更不会提供这些页面的截图:这不仅会使排版混乱,而且浪费流量。

[^注一]: 这俩服务一个停止公开了,一个在大陆不能用,也很能说明为啥这样不合适……

### 网站为啥叫这个名<small>儿</small>
### 网站为啥叫这个名:儿:

意在[致敬 Mozilla](https://wiki.mozilla.org/Areweyet)。

Expand All @@ -49,14 +49,14 @@ Areweyet 系列中,有些网站是性能看板,有些是类似本站的信
[awfy]: https://arewefastyet.com
[awwy]: https://www.arewewebyet.org

主创同学作为一员草根,觉得 Mozilla 的这一文化很<ruby>好玩<small>儿</small><rt>playful</rt></ruby>:
主创同学作为一员草根,觉得 Mozilla 的这一文化很<ruby>好玩:儿:<rt>playful</rt></ruby>:
我们很多时候正缺乏这样面对工作甚至严肃事业仍然抱持的纯粹快乐心态。
国产软硬件生态适配这件事,对很多人而言都不是兴趣,而是沉重工作;
同样,在一些用户眼里,这件事也是有着政治底色的一件大事业。
主创同学觉得这些同学这样未免太紧张了,
因此便想借此机会,让大家在折腾新世界之余来看本站时候都能轻松一点。

### 不喜欢这个中文名<small>儿</small>,咱没聋哇!
### 不喜欢这个中文名:儿:,咱没聋哇!

「Are we ○○ yet?」句式对应的口语「咱○了吗?」最优搭配是单字的动词。
如果动词长于一个字,那么整句话将超过 4 个音节,就不朗朗上口;
Expand Down
4 changes: 2 additions & 2 deletions blog/2023-04-01-welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ tags: [主创团队的话]
---

经过几个月的断断续续建设,本站所含数据的可视化工作终于到达一种「又不是不能用」的程度了。
为了致敬龙芯生态的此一光荣传统,也就到了本站在各大龙芯交流社区抛头露面~~、丢脸掉份<small>儿</small>~~的时候了。
为了致敬龙芯生态的此一光荣传统,也就到了本站在各大龙芯交流社区抛头露面 ~~、丢脸掉份:儿:~~ 的时候了。

本站意图成为龙架构&reg;(LoongArch&reg;)新世界生态建设的信息整合平台,
致力于服务生态开发者、贡献者,
也力争对最终用户「有点<small>儿</small>用」。
也力争对最终用户「有点:儿:用」。

本站代码[完全开源][this-site],欢迎来上游坐坐!

Expand Down
6 changes: 3 additions & 3 deletions docs/contrib/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ sidebar_position: 1
:::

本站本质上是个 [Docusaurus 3](https://docusaurus.io/) 文档站,
所以在动手码字<small>儿</small>之前,最好读一下 Docusaurus 的文档。
所以在动手码字:儿:之前,最好读一下 Docusaurus 的文档。

对不写代码<small>儿</small>的文字工作者而言,
对不写代码:儿:的文字工作者而言,
Docusaurus 的 [Markdown 特性支持](https://docusaurus.io/docs/markdown-features)文档也会有帮助——Docusaurus
Markdown 能用的特性跟 CommonMark、GitHub Flavored Markdown、MDX 都不太一样!

对于工作量小的变更(diff 不超过 10 行<small>儿</small>或者两三个文件,就能搞定的那种),
对于工作量小的变更(diff 不超过 10 行:儿:或者两三个文件,就能搞定的那种),
可以做了直接提上来;
否则建议先来[上游](https://github.com/loongson-community/areweloongyet)开个 issue 讨论下,有了共识再着手做。
这是为了防止出现做了一大堆,投入许多时间和精力,结果维护者不需要,弄得大家都不愉快的情况。
Expand Down
45 changes: 24 additions & 21 deletions docs/contrib/natlang-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 2
:::

随着龙架构&reg;的生态成熟、市场份额扩张,先前一般被认为不会接触此技术的用户也纷至沓来。
这一般是好事<small>儿</small>,但不巧的是:
这一般是好事:儿:,但不巧的是:
此架构先天带有一些非中立的色彩[^politics]——
这使得先后「入坑」的龙架构&reg;开发者,乃至无技术背景的最终用户群体,具有了明显的异质性。
根据笔者亲身经历,这种异质性在不受尊重、管控的情况下,将会并且已经造成了一些社区裂痕:
Expand All @@ -22,7 +22,7 @@ sidebar_position: 2
龙架构&reg;至今未完整开放授权,且其立场先天不中立;
这些特点是如此明显,至少近(2022~2023)年在中文互联网上对龙芯&reg;有所粗浅了解的网友应该都会清楚。

因此,我们应能够假定一位来自中文互联网的网友,只要 对龙架构发表了建设性的内容,
因此,我们应能够假定一位来自中文互联网的网友,只要 :ta: 对龙架构发表了建设性的内容,
那么该网友对龙架构应该持整体正面看法——

* 要么完全赞同其发展方针、具体执行等,
Expand Down Expand Up @@ -54,7 +54,7 @@ sidebar_position: 2

* 对于来自商业公司的明显宣传性质或立场偏颇的文字,必须以明显方式将其区分于本站其他正文。

例如:使用直接引语而非间接引语;使用 Markdown 块<small>儿</small>引用。
例如:使用直接引语而非间接引语;使用 Markdown 块:儿:引用。

* 注意避免「诉诸权威」逻辑陷阱。

Expand All @@ -75,33 +75,35 @@ sidebar_position: 2

## 中西混排

中日韩文字与西文混排时,应在其间加空格<small>儿</small>
但西文与中日韩全角标点<small>儿</small>相邻则不用空格<small>儿</small>
中日韩文字与西文混排时,应在其间加空格:儿:
但西文与中日韩全角标点:儿:相邻则不用空格:儿:

## 标点符号<small>儿</small>
## 标点符号:儿:

整体上请遵循《标点符号用法》([国家标准 GB/T 15834-2011](http://www.moe.gov.cn/jyb_sjzl/ziliao/A19/201001/W020190128580990138234.pdf))。
但:

* 由于纯粹视觉设计方面的原因,本站更倾向于使用竖排引号<small>儿</small>(形如“「」”的引号<small>儿</small>)。
现有很多文章对引号<small>儿</small>形状的使用不一致,后续都要改掉的。
* 由于纯粹视觉设计方面的原因,本站更倾向于使用竖排引号:儿:(形如“「」”的引号:儿:)。
现有很多文章对引号:儿:形状的使用不一致,后续都要改掉的。

## 儿化标记

本站的多数文章都多多少少有些趣味<small>儿</small>性。
由于笔者和他的许多朋友都操北方方言,他们的口语多少带点<small>儿</small>儿化;
本站的多数文章都多多少少有些趣味:儿:性。
由于笔者和他的许多朋友都操北方方言,他们的口语多少带点:儿:儿化;
为了忠实记录这种轻松的口语氛围,我们争取把所有儿化音都标出来。

按照《现代汉语词典》(如果没记错的话)的体例,
表示儿化的「儿」字要比正文略小一号<small>儿</small>——就像这样。
表示儿化的「儿」字要比正文略小一号:儿:——就像这样。
然而这种用法没有专用的 Unicode 码点(即便有,输入法也不支持),
我们目前也没做自定义的 Markdown 语法来简化书写,
因此现在你只好用比较冗长的下边<small>儿</small>这个写法<small>儿</small>。
如果不做些特殊处理,那恐怕每次都要写 `<small>儿</small>` 才能达到效果了。
因此我们特别实现了自定义的 Markdown 写法:儿::

```md
<small>儿</small>
:儿:
```

也就是当作 emoji 用。

## 「的地得」

为避免歧义、方便读者,请严格按照语法功能区分使用「的地得」。复习一遍:
Expand All @@ -112,17 +114,18 @@ sidebar_position: 2

## 人称代词

使用人称代词指代某人时,除非你能确认被称呼人的个人意愿或偏好,否则一律使用 `tā`
使用人称代词指代某人时,除非你能确认被称呼人的个人意愿或偏好,否则一律使用「:ta:」
使用人称代词指代某群人时,除非你能确认该群体所有个体都同意你拟采用的称呼,
否则一律使用 `tā 们`。
否则一律使用「:ta: 们」。
为了方便打字,我们也自定义了 `:ta:` 这个 Markdown 写法。

虽然目前本站并未涉及到相关风波,且「他」字历史上大部分时间都不表示或暗示性别,
但目前中文互联网上客观存在这么一批人不认为「他」字性别中立,
且现代汉语书面语也确实无法用一个字表达性别未知的第三人称。
为了规避这方面风险[^risk],
也鉴于 2022 年前后的网络汉语已经无法用「他」字简短、精确、中立地传达第三人称的性别信息,
我们为了简短、精确、中立地表示「我们不清楚对方的代词为何」这一信息,
就只能使用汉语拼音了——至少汉语普通话的「」这个读音在可预见的将来都不会带有性别暗示。
就只能使用汉语拼音了——至少汉语普通话的「:ta:」这个读音在可预见的将来都不会带有性别暗示。

[^risk]: 本站迟早被冲,但笔者个人不希望是因为这原因——好歹也基于技术原因来冲吧……

Expand All @@ -131,7 +134,7 @@ sidebar_position: 2
所有可被链接内容佐证的材料,都应伴以链接。

优先使相关句子的中心动词成为链接:
「几月几日,谁<a>提交了</a>什么」,让「提交了」三个字链接到 提交的东西。
「几月几日,谁<a>提交了</a>什么」,让「提交了」三个字链接到 :ta: 提交的东西。

当不方便这么做,或者这样做表意不最佳的时候,基本是因为被链接的内容不对应中心动词:
此时改为使相关的短语成为链接。
Expand All @@ -158,7 +161,7 @@ sidebar_position: 2
因此,还请作者们默认尽量采用偏书面甚至「欧化」的表达方式,
尽量不要做话题提前、省略连词等「汉语特色」的表达。

[^why-this-is-unconditionally-bad]: 当然,能「跟上趟<small>儿</small>」或者说「跟上作者脑回路」的读者,确实没被歧义坑到就是了;但也不要忽视这些读者为了「跟上作者脑回路」而在脑内遍历所有句子结构,所不得不做的额外努力、消耗的额外能量。何况这种努力还未必 100% 成功。因此混用口语/话题句表达与书面表达,几乎一定是件坏事<small>儿</small>,请不要这样做。
[^why-this-is-unconditionally-bad]: 当然,能「跟上趟:儿:」或者说「跟上作者脑回路」的读者,确实没被歧义坑到就是了;但也不要忽视这些读者为了「跟上作者脑回路」而在脑内遍历所有句子结构,所不得不做的额外努力、消耗的额外能量。何况这种努力还未必 100% 成功。因此混用口语/话题句表达与书面表达,几乎一定是件坏事:儿:,请不要这样做。

<details>
<summary>经典案例分析(摘自《龙芯架构参考手册》卷一 2.2.7.1 节)</summary>
Expand All @@ -177,7 +180,7 @@ an Instruction Non-defined Exception will be triggered.
:::

哦哦,这是断句问题:「指令不存在例外」是个专有名词。
问问题的同学当时不熟悉龙架构,不知道这回事<small>儿</small>——
问问题的同学当时不熟悉龙架构,不知道这回事:儿:——
可能他们跳着看《手册》,没发现第 2.1.4 节明确规定了「触发……例外」这个词组的含义,
还介绍了「指令不存在例外」这个概念——
但这个句子本身也并非毫无问题。
Expand All @@ -187,7 +190,7 @@ an Instruction Non-defined Exception will be triggered.
这使读者不自觉地进入口语话题句的「句法解析模式」,
以至于不熟悉专有名词的同学更容易把后半部分理解成「则……不存在例外」了。

:::tip 排版也能帮上忙<small>儿</small>
:::tip 排版也能帮上忙:儿:
在上例中,英文表述没有理解障碍的原因有两方面:

* 能标记中心动词:
Expand Down
6 changes: 3 additions & 3 deletions docs/old-and-new-worlds.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sidebar_position: 3

:::info 我需要关心这问题吗?
简单来讲,如果您不自行编译安装软件,或许就不必关心。
当然,随意浏览下这篇文章,以后见到这俩说法不至于一头雾水,或者其他同学遇到问题您可以给 们指路,也是不错的。
当然,随意浏览下这篇文章,以后见到这俩说法不至于一头雾水,或者其他同学遇到问题您可以给 :ta: 们指路,也是不错的。

* 如果您目前在龙架构电脑上使用 Loongnix、麒麟或者 UOS 这些系统,几个月或一两年之后,一定会有一次全系统升级。
* 如果您不升级,那么本身外界如何变化也与您无关。
Expand Down Expand Up @@ -179,7 +179,7 @@ Macintosh 电脑的不同型号就使用 Old World、New World 来区分。

## 常见的坑

### 执行一个程序,报“没有那个文件或目录”,咋回事<small>儿</small>
### 执行一个程序,报“没有那个文件或目录”,咋回事:儿:

如果您执行一个程序却被告知这个程序不存在,类似这样:

Expand All @@ -196,7 +196,7 @@ zsh: 没有那个文件或目录: ./foo
即上文教你判断一个程序是新世界还是旧世界那里提到的 ELF interpreter。
请换对应您系统的程序版本,或要求软件提供者增加适配。

### 我给龙架构交叉编译的 Go 程序,运行报段错误,咋回事<small>儿</small>
### 我给龙架构交叉编译的 Go 程序,运行报段错误,咋回事:儿:

可能是由于未使用正确的 Go 工具链,导致不经意间构建了与您预期 ABI 相异的二进制。

Expand Down
6 changes: 6 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ import type { PluginOptions as AWLYDataPluginOptions } from './src/plugins/awly-

import awlyAsmDBPlugin from './src/plugins/awly-asmdb-plugin'
import awlyDataPlugin from './src/plugins/awly-data-plugin'
import awlyRemarkNatlangUsage from './src/plugins/awly-remark-natlang-usage'

const commonBeforeDefaultRemarkPlugins = [awlyRemarkNatlangUsage]

const commonRehypePlugins = [
[
Expand Down Expand Up @@ -119,6 +122,7 @@ const config: Config = {
blogTitle: '每周一龙',
blogDescription: '龙架构®新世界生态建设周报《每周一龙》(This Week in LoongArch)。每周一都为大家报道 LoongArch® 社区最前线的第一手新鲜资讯!',
editUrl: 'https://github.com/loongson-community/areweloongyet',
beforeDefaultRemarkPlugins: commonBeforeDefaultRemarkPlugins,
rehypePlugins: commonRehypePlugins,
} satisfies BlogOptions,
],
Expand All @@ -134,6 +138,7 @@ const config: Config = {
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/loongson-community/areweloongyet',
beforeDefaultRemarkPlugins: commonBeforeDefaultRemarkPlugins,
rehypePlugins: commonRehypePlugins,
},
blog: {
Expand All @@ -144,6 +149,7 @@ const config: Config = {
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/loongson-community/areweloongyet',
beforeDefaultRemarkPlugins: commonBeforeDefaultRemarkPlugins,
rehypePlugins: commonRehypePlugins,
},
theme: {
Expand Down
4 changes: 2 additions & 2 deletions newsletter/2023-05-15-this-week-in-loongarch-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ tags: [每周一龙]
[D150089]: https://reviews.llvm.org/D150089
[D150522]: https://reviews.llvm.org/D150522

## 社区整活<small>儿</small>
## 社区整活:儿:

本栏目接受任何网友的投稿,只要内容与 LoongArch&reg; 有关,并可以为读者带来价值,
无论严肃贡献(整的大活<small>儿</small>)或是博君一笑都一概欢迎!
无论严肃贡献(整的大活:儿:)或是博君一笑都一概欢迎!

donmor 同学使用 QEMU 模拟的龙架构验证了很多软件和游戏:

Expand Down
6 changes: 3 additions & 3 deletions newsletter/2023-05-22-this-week-in-loongarch-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ tags: [每周一龙]
* [@zwaizwai](https://github.com/zwaizwai)

当然,除了这些名字之外,还有其他没有出现在讨论串、提交历史的无名英雄。
让我们感谢 们的付出!
让我们感谢 :ta: 们的付出!

## 先「马」再看

Expand Down Expand Up @@ -94,10 +94,10 @@ tags: [每周一龙]
[D150417]: https://reviews.llvm.org/D150417
[D150537]: https://reviews.llvm.org/D150537

## 社区整活<small>儿</small>
## 社区整活:儿:

本栏目接受任何网友的投稿,只要内容与 LoongArch&reg; 有关,并可以为读者带来价值,
无论严肃贡献(整的大活<small>儿</small>)或是博君一笑都一概欢迎!
无论严肃贡献(整的大活:儿:)或是博君一笑都一概欢迎!

上周没有投稿。

Expand Down
6 changes: 3 additions & 3 deletions newsletter/2023-05-29-this-week-in-loongarch-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ tags: [每周一龙]

5 月 26 日,mengqinggang 在 binutils 邮件列表贴出了 [LoongArch linker relaxation 优化][binutils-loong-relax]的补丁。

:::info 这啥玩意<small>儿</small>,这么放松?
:::info 这啥玩意:儿:,这么放松?

Linker relaxation 暂无广泛采用的中文翻译,拙译「链接器弛豫」或「链接器松弛」:
简单地说,该优化是链接器根据编译器、汇编器生成代码时提供的额外信息,将可缩短的较长序列缩短,
Expand Down Expand Up @@ -100,10 +100,10 @@ Linker relaxation 暂无广泛采用的中文翻译,拙译「链接器弛豫
截至发稿时,这些 PRs 都已被合并。
预计到 Rust 1.71.0 正式发布时,龙架构 Rust 开发者将得以享受不逊其他架构的同等开发体验。

## 社区整活<small>儿</small>
## 社区整活:儿:

本栏目接受任何网友的投稿,只要内容与 LoongArch&reg; 有关,并可以为读者带来价值,
无论严肃贡献(整的大活<small>儿</small>)或是博君一笑都一概欢迎!
无论严肃贡献(整的大活:儿:)或是博君一笑都一概欢迎!

本周没有投稿。

Expand Down
8 changes: 4 additions & 4 deletions newsletter/2023-06-05-this-week-in-loongarch-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,15 @@ Sui Jingfeng 为龙芯 2K1000 和 LS7A1000 内置的 Vivante GC1000 GPU IP
[D151655]: https://reviews.llvm.org/D151655
[D151794]: https://reviews.llvm.org/D151794

## 社区整活<small>儿</small>
## 社区整活:儿:

本栏目接受任何网友的投稿,只要内容与 LoongArch&reg; 有关,并可以为读者带来价值,
无论严肃贡献(整的大活<small>儿</small>)或是博君一笑都一概欢迎!
无论严肃贡献(整的大活:儿:)或是博君一笑都一概欢迎!

[KatyushaScarlet](https://github.com/KatyushaScarlet)
[向大家介绍](https://katyusha.net/536.html) 基于 DOSBox-X 整合的游戏模拟器。
[向大家介绍](https://katyusha.net/536.html) :ta: 基于 DOSBox-X 整合的游戏模拟器。
不过似乎在 QEMU 模拟条件下可能无法启动。
感兴趣的同学可以加入 的行列一起折腾!
感兴趣的同学可以加入 :ta: 的行列一起折腾!

## 张贴栏

Expand Down
4 changes: 2 additions & 2 deletions newsletter/2023-06-12-this-week-in-loongarch-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,10 @@ heiher 旋即[推进了](https://github.com/rust-lang/rust/pull/112310)实现。
* `loongarch64-unknown-none`,LA64 LP64D(双精度硬浮点)裸机
* `loongarch64-unknown-none-softfloat`,LA64 LP64S(软浮点)裸机

## 社区整活<small>儿</small>
## 社区整活:儿:

本栏目接受任何网友的投稿,只要内容与 LoongArch&reg; 有关,并可以为读者带来价值,
无论严肃贡献(整的大活<small>儿</small>)或是博君一笑都一概欢迎!
无论严肃贡献(整的大活:儿:)或是博君一笑都一概欢迎!

YANG Xudong [优化了](https://www.postgresql.org/message-id/flat/b522a0c5-e3b2-99cc-6387-58134fb88cbe%40ymatrix.cn)
PostgreSQL 在 LoongArch 上的 CRC 计算,
Expand Down
Loading