This commit is contained in:
Penny777
2024-05-17 11:01:35 +00:00
committed by GitHub
8 changed files with 159 additions and 2749 deletions

View File

@@ -1,220 +0,0 @@
<a name="0.1.0"></a>
# [0.1.0](https://github.com/sparanoid/chinese-copywriting-guidelines/compare/v0.0.10...v0.1.0) (2018-10-14)
### Bug Fixes
* **grunt:** duplicated default task ([14c907f](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/14c907f))
### Features
* **docs:** switch license to MIT to meet OSI reqirements ([b48b912](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/b48b912))
<a name="0.0.10"></a>
## [0.0.10](https://github.com/sparanoid/chinese-copywriting-guidelines/compare/v0.0.9...v0.0.10) (2018-10-14)
### Bug Fixes
* **docs:** update adverb ([79fa169](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/79fa169))
* **docs:** wrong external link indicator ([ad6fffa](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/ad6fffa))
### Features
* **docs:** add `text spacing` notice, fixes https://github.com/sparanoid/chinese-copywriting-guidelines/issues/51 ([949547e](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/949547e))
* **docs:** add another bad example to spacing ([a3fbf58](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/a3fbf58))
* **docs:** add jxlwqq/chinese-typesetting ([#62](https://github.com/sparanoid/chinese-copywriting-guidelines/issues/62)) ([161c82c](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/161c82c))
* **docs:** add python lib hint, fixes https://github.com/sparanoid/chinese-copywriting-guidelines/issues/50 ([94b00c6](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/94b00c6))
* **docs:** examples cleanup ([3d8de98](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/3d8de98))
* **docs:** update punctuations ([c44d96a](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/c44d96a))
* **package:** update contributors ([03f8e8e](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/03f8e8e))
<a name="0.0.9"></a>
## [0.0.9](https://github.com/sparanoid/chinese-copywriting-guidelines/compare/v0.0.8...v0.0.9) (2016-02-17)
### Bug Fixes
* **docs:** wrong TOC anchors ([d0468e7](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/d0468e7))
### Features
* **docs:** update link redirects, props @ReadmeCritic ([02bb41c](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/02bb41c))
* **docs:** update repo link ([bc736c2](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/bc736c2))
* **package:** update contributors ([ec9ae8d](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/ec9ae8d))
<a name="0.0.8"></a>
## [0.0.8](https://github.com/sparanoid/chinese-copywriting-guidelines/compare/v0.0.7...v0.0.8) (2015-12-11)
### Bug Fixes
* **docs:** avoid slangs ([d42d646](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/d42d646))
* **docs:** wrong TOC anchors ([585e71e](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/585e71e))
### Features
* **docs:** add language list ([61a43f4](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/61a43f4))
* **docs:** add Python library from hjiang/scripts ([1104e24](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/1104e24))
* **docs:** initial English version ([a732199](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/a732199))
* **docs:** re-evaluate V2EX ([200eb49](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/200eb49))
* **docs:** update spacing rule for links ([a2569b3](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/a2569b3))
* **docs:** use original titles for references ([db596b1](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/db596b1))
* **package:** update contributors ([c8e29af](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/c8e29af))
<a name="0.0.7"></a>
## [0.0.7](https://github.com/sparanoid/chinese-copywriting-guidelines/compare/v0.0.6...v0.0.7) (2015-10-25)
### Features
* **docs:** add badge for HTML version ([ee62ad5](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/ee62ad5))
* **docs:** add languages section ([b495cc5](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/b495cc5))
* **docs:** add new tool ([2afe771](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/2afe771))
* **docs:** remove custom emojis ([b5c5733](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/b5c5733))
* **docs:** simplify examples ([1ce86f4](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/1ce86f4))
* **docs:** simplify TOC ([be7f513](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/be7f513))
* **package:** update contributors ([855514d](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/855514d))
<a name="0.0.6"></a>
## [0.0.6](https://github.com/sparanoid/chinese-copywriting-guidelines/compare/v0.0.5...v0.0.6) (2015-08-12)
### Features
* **grunt:** better version handling ([6662796](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/6662796))
* **package:** update contributors ([48f7cb8](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/48f7cb8))
* **package:** update contributors ([bea8e17](https://github.com/sparanoid/chinese-copywriting-guidelines/commit/bea8e17))
<a name="0.0.5"></a>
### 0.0.5 (2015-07-08)
#### Bug Fixes
* **docs:**
* typo HTML5, fixes #19 ([9a009b3d](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/9a009b3d5d99e21692153c3086fff10b21407dc7))
* wrong heading ([c2ec2d82](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/c2ec2d82cbab504ee3185b546457c2e148361884))
* **package:** license not defined ([ac6b463c](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/ac6b463c6903d8e8cfad7cb23b6bd772de8bc6d6))
#### Features
* **docs:** avoid unidiomatic jargons ([f2d982d7](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/f2d982d73fa60788c69908039825a772b45a814f))
<a name="0.0.4"></a>
### 0.0.4 (2015-04-22)
#### Bug Fixes
* **docs:**
* typo ([0cb547e3](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/0cb547e3c1ab3354490cbfcf6c11f7b9cb113ea1))
* avoid personal writing style ([0fcf17b5](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/0fcf17b5a22b75443b64ad67b7a037288472d6d4))
#### Features
* **docs:**
* add usage for degrees and percentages ([ad2c239b](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/ad2c239b70c48cb86f1aa9f6cc5622e3a89ca44d))
* more specific plugin description ([db8e5f72](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/db8e5f7261e0f38b7bf91eec87e373d9abe83765))
* remove vanity PR tips ([ccc36d6f](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/ccc36d6f3c8361e3636c4ca0f6b44cffbf15d9c5))
* add new sections to Spacing ([7dc13730](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/7dc137300534f3f4552422d9b5ab961928d2d51d))
<a name="0.0.3"></a>
### 0.0.3 (2014-09-15)
#### Bug Fixes
* **docs:**
* no personal emotions here ([a7be2e78](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/a7be2e788b02fe32360ce76a2a065030254821cc))
* correct tip position ([86d64f6f](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/86d64f6fe923c58778b792b6f085b71ec60b5263))
* incorrect note description ([e1e6d227](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/e1e6d227e522f61e3941b10af5cc8a4ae0c8417e))
* remove wrong example ([85b57cc0](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/85b57cc04608fb7016f95c96fbf3d5791284e980))
#### Features
* **docs:**
* simplified table data ([36979a52](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/36979a520d6faa423bafbb9ec63b19cb3f721e92))
* no more emojis ([ba6a83a6](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/ba6a83a6b4642b31c1ba8105fa0ddd3195d4fad1))
* remove tools description ([0c4870ca](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/0c4870ca30e334f98ce249814ca62e34acfdae1d))
* add more examples ([477798b1](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/477798b15c0036487a4bb979d27d50091b3a96d2))
* change chapter order ([a8fb6cff](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/a8fb6cff1c4201437f9b5a4ab0049eb23da133d6))
* table for tool list ([d9b77e28](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/d9b77e28594b7d9e36b0167862661fc5e95aa595))
* less aggressive, more decent examlples ([e6bcb84f](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/e6bcb84f9bee7fc27b4bb296b027f9412acc2459))
* add more tools ([00141d48](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/00141d488ed8888df61f7ada4c915d31b3e91b1f))
* update description ([7c1d7e78](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/7c1d7e78d3e4be8f7e4ef9fea5201087f1ba6b6b))
* add spacing exception for product names ([b8cec964](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/b8cec964b0b5d8c46fd6b9e3dfd0000badca07f8))
<a name="0.0.2"></a>
### 0.0.2 (2014-07-15)
#### Bug Fixes
* **doc:** Chinese Simplified quote marks confusion ([8666d01f](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/8666d01f9c16ddd650d54ca99cf1431e5553f3c8))
#### Features
* **docs:**
* add numerical digit usage, this could fix GH-8 ([c486b70b](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/c486b70b968da9168109cd50542a373b9f00c112))
* add more usage of punctuation marks ([b77c78b4](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/b77c78b47af127fe1d745a59439bdfc4c7af0846))
* better TOC anchors, add tools section ([b374670f](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/b374670f6cbad87cebd1bed07cfd5663cb224e0a))
* simplified rules ([a2f11ce6](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/a2f11ce6696548d3b7c2b7483a3a22edd880c2fb))
* simplified chapter titles ([e457f3ec](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/e457f3eccab2ca30813c66e5267c561c2a2f2f16))
* add deps check badge ([c9f9c21f](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/c9f9c21f80f1da1fb6d432f8b4e2b2b301cb6600))
<a name="0.0.1"></a>
### 0.0.1 (2014-07-01)
#### Bug Fixes
* **docs:**
* remove leftovers ([e8b347e1](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/e8b347e133c9bbd7ad7f7bdf7575f65c9c386bd7))
* fix typo ([1f4ebf16](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/1f4ebf1622f8e6363aa509d9c227e07dd61f5bb6))
* fix table link ([a63fe5b4](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/a63fe5b495df9dc28ce2149135941d2abdf80ede))
* remove unrelated example ([48594a58](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/48594a580bd272a9036401e957d49f1d5bd383e2))
* fix toc ([5c7bb2bd](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/5c7bb2bdac5ae2c724753956f9271bc22da99d6e))
* fix capital ([824d0241](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/824d024189dce50912770c49caa512f22bdbcd75))
* fix several punctuation marks ([6bd5aaa4](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/6bd5aaa466a4b90b9d8715183c992033dab54ffc))
#### Features
* one more rule for punctuation marks ([a2887783](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/a2887783a9c7482d728d66f75998d2db8ef72f82))
* create a LICENSE ([638dc085](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/638dc0851d9f5cd5b935e98a878cae9ce9896f7d))
* **build:** add change log support ([18c54966](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/18c54966053f2b710ba0b7619afa6f3e1b09db07))
* **docs:**
* remove dead company ([595a8aa4](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/595a8aa4efe33530b3eb81e1104303e0c1bbd2e5))
* update bad examples ([984bf9e0](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/984bf9e0740e9d2f47debcbcd3b02becdccad5af))
* add more examples ([f3d66a08](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/f3d66a086e9fd50fa76ef645a71a715a07946e39))
* add wandoujia.com ([299a4751](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/299a475107979bac0e04865c8495ad88d0021a8c))
* add quotation marks usage ([984271fe](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/984271fea0f4b1656768196146c23f3016126cb5))
* add related references ([89b361ab](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/89b361aba39ae12a02a7082b4c17dc1d1ba1b9b3))
* add toc ([6bf68d35](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/6bf68d3503ae45077c348c823b932aab86502324))
* add example for styling uppercased text ([555ecc65](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/555ecc6595c608727f033d7dcb53c15129e887f6))
* add init content ([651418c6](http://github.com/sparanoid/chinese-copywriting-guidelines/commit/651418c6765236804279f059aeea0db290f9d5b0))

View File

@@ -1,296 +0,0 @@
# Chinese Copywriting Guidelines
Chinese copywriting guidelines for better written communication.
Other languages:
- [English](README.en.md)
- [Chinese Traditional](README.md)
- [Chinese Simplified](README.zh-Hans.md)
* * *
## Spacing
> Research shows that, people adding no space between Chinese and English suffer from pathetic relationships. 70% of them are married by the age of 34, with someone they don't love; 30% of them left everything for their cats and died. Blank spaces are essential to both romance and writing.
>
> 與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js)
### Place one space before/after English words
Good:
> 在 LeanCloud 上,數據儲存是圍繞 `AVObject` 進行的。
Bad:
> 在LeanCloud上數據儲存是圍繞`AVObject`進行的。
>
> 在 LeanCloud上數據儲存是圍繞`AVObject` 進行的。
An example of complete and correct usage:
> 在 LeanCloud 上,數據儲存是圍繞 `AVObject` 進行的。每個 `AVObject` 都包含了與 JSON 兼容的 key-value 對應的數據。數據是 schema-free 的,你不需要在每個 `AVObject` 上提前指定存在哪些键,只要直接設定對應的 key-value 即可。
Exceptions: For product and brand names, please refer to the writing format of the official definition. For example, use “豆瓣FM” instead of “豆瓣 FM”.
### Place one space before/after numbers
Good:
> 今天出去買菜花了 5000 元。
Bad:
> 今天出去買菜花了 5000元。
>
> 今天出去買菜花了5000元。
### Place one space between numbers and units
Good:
> 我家的光纖入屋寬頻有 10 GbpsSSD 一共有 20 TB。
Bad:
> 我家的光纖入屋寬頻有 10GbpsSSD 一共有 20TB。
Exceptions: There should not be any spacing between numbers and degrees/percentages.
Good:
> 角度為 90° 的角,就是直角。
>
> 新 MacBook Pro 有 15% 的 CPU 性能提升。
Bad:
> 角度為 90 ° 的角,就是直角。
>
> 新 MacBook Pro 有 15 % 的 CPU 性能提升。
### No additional spaces before/after punctuation in fullwidth form
Good:
> 剛剛買了一部 iPhone好開心
Bad:
> 剛剛買了一部 iPhone ,好開心!
>
> 剛剛買了一部 iPhone 好開心!
### `text-spacing` to the rescue?
[`text-spacing`](https://www.w3.org/TR/css-text-4/#text-spacing-property) and [`-ms-text-autospace`](https://msdn.microsoft.com/library/ms531164(v=vs.85).aspx) provided by CSS Text Module Level and Microsoft can specify the autospacing and narrow space width adjustment of text. However it's not popular, and on other platforms such as OS X and iOS we can not use this feature. So it's better for you to keep up the habit.
## Punctuation
### Avoid duplicate punctuation
Although the punctuation usage of China mainland admits to duplicate the punctuations, the sentence may become unpleasing to the eye by doing that.
Good:
> 德國隊竟然戰勝了巴西隊!
>
> 她竟然對你說「喵」?!
Bad:
> 德國隊竟然戰勝了巴西隊!!
>
> 德國隊竟然戰勝了巴西隊!!!!!!!!
>
> 她竟然對你說「喵」??!!
>
> 她竟然對你說「喵」?!?!??!!
## Fullwidth and halfwidth
If youre not familiar with fullwidth and halfwidth forms please refer to article [Halfwidth and fullwidth](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) on Wikipedia.
### Use punctuation in fullwidth form
Good:
> 嗨!你知道嘛?今天前台的小妹跟我說「喵」了哎!
>
> 核磁共振成像NMRI是什麼原理都不知道JFGI
Bad:
> 嗨! 你知道嘛? 今天前台的小妹跟我說 "喵" 了哎!
>
> 嗨!你知道嘛?今天前台的小妹跟我說"喵"了哎!
>
> 核磁共振成像 (NMRI) 是什麼原理都不知道? JFGI!
>
> 核磁共振成像(NMRI)是什麼原理都不知道?JFGI!
Exception: inline English titles of books and journals with italics, instead of fullwidth title marks.
### Use numbers in halfwidth form
Good:
> 這件蛋糕只賣 1000 元。
Bad:
> 這件蛋糕只賣 元。
Exceptions: fullwidth numbers are acceptable for better visual alignment in graphic design.
### Use punctuation in halfwidth form for English sentences
Good:
> 賈伯斯那句話是怎麼說的「Stay hungry, stay foolish.」
>
> 推薦你閱讀 *Hackers & Painters: Big Ideas from the Computer Age*,非常地有趣。
Bad:
> 賈伯斯那句話是怎麼說的「Stay hungrystay foolish。」
>
> 推薦你閱讀《HackersPaintersBig Ideas from the Computer Age》非常的有趣。
## Nouns
### Capitalize properly
Capitalization is a matter of English, which is beyond the scope of this wiki. Here we exemplify some typical scenarios.
Good:
> 使用 GitHub 登錄
>
> 我們的客戶有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。
Bad:
> 使用 github 登錄
>
> 使用 GITHUB 登錄
>
> 使用 Github 登錄
>
> 使用 gitHub 登錄
>
> 使用 gイんĤЦ8 登錄
>
> 我們的客戶有 github、foursquare、microsoft corporation、google、facebook, inc.。
>
> 我們的客戶有 GITHUB、FOURSQUARE、MICROSOFT CORPORATION、GOOGLE、FACEBOOK, INC.。
>
> 我們的客戶有 Github、FourSquare、MicroSoft Corporation、Google、FaceBook, Inc.。
>
> 我們的客戶有 gitHub、fourSquare、microSoft Corporation、google、faceBook, Inc.。
>
> 我們的客戶有 gイんĤЦ8、キouЯƧquムгє、๓เςг๏ร๏Ŧt ς๏гק๏гคtเ๏ภn、900913、ƒ4ᄃëв๏๏к, IПᄃ.。
注意當網頁中需要配合整體視覺風格而出現全部大寫小寫的情形HTML 中請使用標準的大小寫規範進行書寫;並通過 `text-transform: uppercase;``text-transform: lowercase;` 對表現形式進行定義。
### Avoid jargons
Good:
> 我們需要一位熟悉 TypeScript、HTML5至少理解一種框架如 React、Next.js的前端開發者。
Bad:
> 我們需要一位熟悉 Ts、h5至少理解一種框架如 RJS、nextjs的 FED。
## Dispute
The following usages comprise of personal characteristics. As such, from the perspective of copywriting guidelines, they are **still correct** regardless of whether they comply with the following rules.
### Add extra spaces before/after links
Usage:
> 請 [提交一个 issue](#) 並分配给相關同事。
>
> 訪問我們網站的最新動態,請 [點擊這裡](#) 進行訂閱!
compared with:
> 請[提交一个 issue](#) 並分配给相關同事。
>
> 訪問我們網站的最新動態,請[點擊這裡](#)進行訂閱!
### Use corner brackets for Chinese Simplified
Usage:
> 「老师,『有条不紊』的『紊』是什么意思?」
compared with:
> “老师,‘有条不紊’的‘紊’是什么意思?”
## Tools
Repository | Category | Language
---------- | -------- | --------
[pangu.js](https://github.com/vinta/pangu.js) | pangu | JavaScript
[pangu-go](https://github.com/vinta/pangu) | pangu | Go
[pangu.java](https://github.com/vinta/pangu.java) | pangu | Java
[pangu.py](https://github.com/vinta/pangu.py) | pangu | Python
[pangu.rb](https://github.com/dlackty/pangu.rb) | pangu | Ruby
[pangu.php](https://github.com/cchlorine/pangu.php) | pangu | PHP
[pangu.vim](https://github.com/hotoo/pangu.vim) | pangu | Vim
[vue-pangu](https://github.com/serkodev/vue-pangu) | pangu | Vue.js (Web Converter)
[intellij-pangu](https://plugins.jetbrains.com/plugin/19665-pangu) | pangu | Intellij Platform Plugin
[autocorrect](https://github.com/huacnlee/autocorrect) | autocorrect | Rust, WASM, CLI tool
[autocorrect-node](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-node) | autocorrect | Node.js
[autocorrect-py](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-py) | autocorrect | Python
[autocorrect-rb](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-rb) | autocorrect | Ruby
[autocorrect-java](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-java) | autocorrect | Java
[autocorrect-go](https://github.com/longbridgeapp/autocorrect) | autocorrect | Go
[autocorrect-php](https://github.com/NauxLiu/auto-correct) | autocorrect | PHP
[autocorrect-vscode](https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect) | autocorrect | VS Code Extension
[autocorrect-idea-plugin](https://plugins.jetbrains.com/plugin/20244-autocorrect) | autocorrect | Intellij Platform Plugin
[jxlwqq/chinese-typesetting](https://github.com/jxlwqq/chinese-typesetting) | other | PHP
[sparanoid/space-lover](https://github.com/sparanoid/space-lover) | other | PHP (WordPress)
[sparanoid/grunt-auto-spacing](https://github.com/sparanoid/grunt-auto-spacing) | other | Node.js (Grunt)
[hjiang/scripts/add-space-between-latin-and-cjk](https://github.com/hjiang/scripts/blob/master/add-space-between-latin-and-cjk) | other | Python
[hustcc/hint](https://github.com/hustcc/hint) | other | Python
[n0vad3v/Tekorrect](https://github.com/n0vad3v/Tekorrect) | other | Python
## Examples of “Who is doing this?”
Website | Copywriting | UGC
------- | ----------- | ---
[Apple China](https://www.apple.com/cn/) | Yes | N/A
[Apple Hong Kong](https://www.apple.com/hk/) | Yes | N/A
[Apple Taiwan](https://www.apple.com/tw/) | Yes | N/A
[Microsoft China](https://www.microsoft.com/zh-cn/) | Yes | N/A
[Microsoft Hong Kong](https://www.microsoft.com/zh-hk/) | Yes | N/A
[Microsoft Taiwan](https://www.microsoft.com/zh-tw/) | Yes | N/A
[LeanCloud](https://leancloud.cn/) | Yes | N/A
[V2EX](https://www.v2ex.com/) | Yes | Yes
[Apple4us](https://apple4us.com/) | Yes | N/A
[Ruby China](https://ruby-china.org/) | Yes | Yes
[少數派](https://sspai.com/) | Yes | N/A
## References
- [Guidelines for Using Capital Letters - ThoughtCo.](https://www.thoughtco.com/guidelines-for-using-capital-letters-1691724)
- [Letter case - Wikipedia](https://en.wikipedia.org/wiki/Letter_case)
- [Punctuation - Oxford Dictionaries](https://en.oxforddictionaries.com/grammar/punctuation)
- [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/)
- [How to Use English Punctuation Correctly - wikiHow](https://www.wikihow.com/Use-English-Punctuation-Correctly)
- [格式 - openSUSE](https://zh.opensuse.org/index.php?title=Help:%E6%A0%BC%E5%BC%8F)
- [Halfwidth and fullwidth forms - Wikipedia](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms)
- [引號 - 維基百科](https://zh.wikipedia.org/wiki/%E5%BC%95%E8%99%9F)
- [Interrobang - Wikipedia](https://en.wikipedia.org/wiki/Interrobang)
## Forks
The usage of forked projects may differ from this project.
- [mzlogin/chinese-copywriting-guidelines](https://github.com/mzlogin/chinese-copywriting-guidelines)

360
README.md
View File

@@ -1,299 +1,257 @@
# 中文文案排版指北
# 中文文案排版指北 NextDAO 修订版
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/chinese-copywriting-guidelines/localized.svg)](https://crowdin.com/project/chinese-copywriting-guidelines)
[![Built with Almace Scaffolding](https://d349cztnlupsuf.cloudfront.net/amsf-badge.svg)](https://sparanoid.com/note/chinese-copywriting-guidelines/)
统一中文文案、排版的相关用法,降低社区成员之间的沟通成本,增强社区气质。
統一中文文案、排版的相關用法,降低團隊成員之間的溝通成本,增強網站氣質。
Other languages:
- [English](README.en.md)
- [Chinese Traditional](README.md)
- [Chinese Simplified](README.zh-Hans.md)
-----
* * *
## 空格
> 「有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。
### 中英文之间需要增加空格
正确:
> 在 LeanCloud 上,数据存储是围绕 `AVObject` 进行的。
错误:
> 在LeanCloud上数据存储是围绕`AVObject`进行的。
>
> 與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js)
> 在 LeanCloud上数据存储是围绕`AVObject` 进行的。
### 中英文之間需要增加空格
完整的正确用法:
正確:
> 在 LeanCloud 上,数据存储是围绕 `AVObject` 进行的。每个 `AVObject` 都包含了与 JSON 兼容的 key-value 对应的数据。数据是 schema-free 的,你不需要在每个 `AVObject` 上提前指定存在哪些键,只要直接设定对应的 key-value 即可。
> 在 LeanCloud 上,數據儲存是圍繞 `AVObject` 進行的
例外「豆瓣FM」等产品名词按照官方所定义的格式书写
錯誤:
### 中文与数字之间需要增加空格
> 在LeanCloud上數據儲存是圍繞`AVObject`進行的。
正确:
> 在 LeanCloud上數據儲存是圍繞`AVObject` 進行的
> 今天出去买菜花了 5000 元
完整的正確用法
错误
> 在 LeanCloud 上,數據儲存是圍繞 `AVObject` 進行的。每個 `AVObject` 都包含了與 JSON 兼容的 key-value 對應的數據。數據是 schema-free 的,你不需要在每個 `AVObject` 上提前指定存在哪些键,只要直接設定對應的 key-value 即可
> 今天出去买菜花了 5000元
>
> 今天出去买菜花了5000元。
例外「豆瓣FM」等產品名詞按照官方所定義的格式書寫。
### 数字与单位之间需要增加空格
### 中文與數字之間需要增加空格
正确:
正確:
> 我家的光纤入屋宽带有 10 GbpsSSD 一共有 20 TB
> 今天出去買菜花了 5000 元。
错误:
錯誤:
> 我家的光纤入屋宽带有 10GbpsSSD 一共有 20TB
> 今天出去買菜花了 5000元。
例外:度数/百分比/单字符单位/单字符进制/单字符罩杯与数字之间不需要增加空格:
> 今天出去買菜花了5000元。
### 數字與單位之間需要增加空格
正確:
> 我家的光纖入屋寬頻有 10 GbpsSSD 一共有 20 TB。
錯誤:
> 我家的光纖入屋寬頻有 10GbpsSSD 一共有 20TB。
例外:度數/百分比與數字之間不需要增加空格:
正確:
> 角度為 90° 的角,就是直角。
正确:
> 角度为 90° 的角,就是直角。
>
> 新 MacBook Pro 有 15% 的 CPU 性能提升。
>
> 我给你转了 1e你给我 3000u 就好了。
>
> 出 1000U有人收吗
>
> 加入 10g 盐。
>
> 你的罩杯有 36D 吗?
錯誤
> 角度為 90 ° 的角,就是直角。
错误
> 角度为 90 ° 的角,就是直角。
>
> 新 MacBook Pro 有 15 % 的 CPU 性能提升。
>
> 我给你转了 1 e你给我 3000 u 就好了。
>
> 出 1000 U有人收吗
>
> 加入 10 g 盐。
>
> 你的罩杯有 36 D 吗?
### 全形標點與其他字符之不加空格
### 全角标点与其他字符之不加空格
> 剛剛買了一部 iPhone心!
> 刚刚买了一部 iPhone心!
錯誤
错误
> 剛剛買了一部 iPhone ,好心!
> 刚刚买了一部 iPhone ,好心!
>
> 刚刚买了一部 iPhone 好开心!
> 剛剛買了一部 iPhone 好開心!
### 前后有汉字,那么中间的数字和符号组成可以不用加空格
### `text-spacing` to the rescue?
正确:
CSS Text Module Level 4 的 [`text-spacing`](https://www.w3.org/TR/css-text-4/#text-spacing-property) 和 Microsoft 的 [`-ms-text-autospace`](https://msdn.microsoft.com/library/ms531164(v=vs.85).aspx) 可以實現自動為中英文之間增加空白。不過目前並未普及,另外在其他應用場景,例如 macOS、iOS、Windows 等用戶介面目前並不存在這個特性,所以請繼續保持隨手加空格的習慣。
> 还有 8-9 分钟
>
> 如何证明「1 + 1 = 2」这个等式呢
## 標點符號
错误:
### 不重複使用標點符號
> 还有 8 - 9 分钟
>
> 如何证明「1+1=2」这个等式呢
雖然中國大陸的標點符號用法允許重複使用標點符號,但是這麼做會破壞句子的美觀性。
例外:内容是引用的
正確:
> 如何证明「1 + 1 = 2」这个等式呢
> 德國隊竟然戰勝了巴西隊!
### 「=」和中文或英文中间有空格
> 她竟然對你說「喵」?!
正确:
錯誤:
> New Zealand = NZ = 奶子
> 德國隊竟然戰勝了巴西隊!!
错误:
> 德國隊竟然戰勝了巴西隊!!!!!!!!
> New Zealand=NZ=奶子
> 她竟然對你說「喵」??!!
> 她竟然對你說「喵」?!?!??!!
## 全形和半形
## 标点符号
不明白什麼是全形(全角)與半形(半角)符號?請查看維基百科條目『[全形和半形](https://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)』。
### 全角和半角
### 使用全形中文標點
不明白什么是全角(全形)与半角(半形)符号?请查看维基百科条目『[全角和半角](https://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)』。
正確:
### 使用全角中文标点
> 嗨!你知道嘛?今天前台的小妹跟我說「喵」了哎!
正确:
> 核磁共振成像NMRI是什麼原理都不知道JFGI
> 嗨!你知道嘛?今天前台的小妹跟我说「喵」了哎
>
> 核磁共振成像NMRI是什么原理都不知道JFGI
錯誤
错误
> 嗨! 你知道嘛? 今天前台的小妹跟我 "喵" 了哎!
> 嗨! 你知道嘛? 今天前台的小妹跟我 "喵" 了哎
>
> 嗨!你知道嘛?今天前台的小妹跟我说"喵"了哎!
>
> 核磁共振成像 (NMRI) 是什么原理都不知道? JFGI!
>
> 核磁共振成像(NMRI)是什么原理都不知道?JFGI!
> 嗨!你知道嘛?今天前台的小妹跟我說"喵"了哎!
例外:中文句子内夹有英文书籍名、报刊名时,不应借用中文书名号,应以英文斜体表示。
> 核磁共振成像 (NMRI) 是什麼原理都不知道? JFGI!
### 数字使用半角字符
> 核磁共振成像(NMRI)是什麼原理都不知道?JFGI!
正确:
例外:中文句子內夾有英文書籍名、報刊名時,不應借用中文書名號,應以英文斜體表示
> 这个蛋糕只卖 1000 元
### 數字使用半形字符
错误:
正確:
> 这个蛋糕只卖 元。
> 這件蛋糕只賣 1000 元
例外:在设计稿、宣传海报中如出现极少量数字的情形时,为方便文字对齐,是可以使用全角数字的
錯誤:
### 遇到完整的英文整句、特殊名词,其内容使用半角标点
> 這件蛋糕只賣 元。
正确:
例外:在設計稿、宣傳海報中如出現極少量數字的情形時,為方便文字對齊,是可以使用全形數字的。
> 乔布斯那句话是怎么说的「Stay hungry, stay foolish.」
>
> 推荐你阅读 *Hackers & Painters: Big Ideas from the Computer Age*,非常地有趣。
### 遇到完整的英文整句、特殊名詞,其內容使用半形標點
错误:
正確:
> 乔布斯那句话是怎么说的「Stay hungrystay foolish。」
>
> 推荐你阅读《HackersPaintersBig Ideas from the Computer Age》非常的有趣。
> 賈伯斯那句話是怎麼說的「Stay hungry, stay foolish.」
## 名词
> 推薦你閱讀 *Hackers & Painters: Big Ideas from the Computer Age*,非常地有趣。
### 不要使用不地道的缩写
錯誤
正确
> 賈伯斯那句話是怎麼說的「Stay hungrystay foolish。」
> 我们需要一位熟悉 TypeScript、HTML5至少理解一种框架如 React、Next.js的前端开发者。
> 推薦你閱讀《HackersPaintersBig Ideas from the Computer Age》非常的有趣。
错误:
## 名詞
> 我们需要一位熟悉 Ts、h5至少理解一种框架如 RJS、nextjs的 FED。
### 專有名詞使用正確的大小寫
## 以下规则推荐遵守,但不作强制要求
大小寫相關用法原屬於英文書寫範疇,不屬於本 wiki 討論內容,在這裡只對部分易錯用法進行簡述。
### 专有名词使用正确的大小写
正確:
大小写相关用法原属于英文书写范畴,不属于本 wiki 讨论内容,在这里只对部分易错用法进行简述。
> 使用 GitHub 登錄
注意有些词并不是专有名词例如K 线T 恤
> 我們的客戶有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。
正确:
錯誤:
> 使用 GitHub 登录
>
> 我们的客户有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。
> 使用 github 登錄
不正确,但可接受:
> 使用 GITHUB
> 使用 github
>
> 使用 GITHUB 登录
>
> 使用 Github 登录
>
> 使用 gitHub 登录
> 使用 Github 登錄
### 不重复使用标点符号
> 使用 gitHub 登錄
虽然中国大陆的标点符号用法允许重复使用标点符号,但是这么做会破坏句子的美观性。
> 使用 gイんĤЦ8 登錄
正确:
> 我們的客戶有 github、foursquare、microsoft corporation、google、facebook, inc.。
> 德国队竟然战胜了巴西队!
>
> 她竟然对你说「喵」?!
> 我們的客戶有 GITHUB、FOURSQUARE、MICROSOFT CORPORATION、GOOGLE、FACEBOOK, INC.。
不正确,但可接受:
> 我們的客戶有 Github、FourSquare、MicroSoft Corporation、Google、FaceBook, Inc.。
> 德国队竟然战胜了巴西队!!
>
> 德国队竟然战胜了巴西队!!!!!!!!
>
> 她竟然对你说「喵」??!!
>
> 她竟然对你说「喵」?!?!??!!
>
> 我們的客戶有 gitHub、fourSquare、microSoft Corporation、google、faceBook, Inc.。
### 品牌间联名用 × 分开
> 我們的客戶有 gイんĤЦ8、キouЯƧquムгє、๓เςг๏ร๏Ŧt ς๏гק๏гคtเ๏ภn、900913、ƒ4ᄃëв๏๏к, IПᄃ.。
品牌联名合作在英文里叫做「crossover」也就是交叉的意思用乘号预示着合作双赢
注意當網頁中需要配合整體視覺風格而出現全部大寫小寫的情形HTML 中請使用標準的大小寫規範進行書寫;並通過 `text-transform: uppercase;``text-transform: lowercase;` 對表現形式進行定義。
正确:
### 不要使用不道地的縮寫
> NextDAO × Binance
正確
不正确,但可接受
> 我們需要一位熟悉 TypeScript、HTML5至少理解一種框架如 React、Next.js的前端開發者。
> NextDAO X Binance
>
> NextDAO x Binance
錯誤:
### 多文字内容推荐换行
> 我們需要一位熟悉 Ts、h5至少理解一種框架如 RJS、nextjs的 FED
对于多行以上的聊天文字,推荐在对话框中进行分段换行
## 爭議
正确:
以下用法略帶有個人色彩,即:無論是否遵循下述規則,從語法的角度來講都是**正確**的
> 假设自己手中只有一张可打 20 个洞的投资决策卡。每做一次投资,就在卡片上打一个洞。相对地,能做投资决定的次数也就减少一次
>
> 假如投资人真受到这样的限制,他无们就会耐心地等待绝佳的投资机会出现,而不会轻率地作决定。
### 超連結之間增加空格
正确,但不那么推荐:
用法:
> 假设自己手中只有一张可打 20 个洞的投资决策卡。每做一次投资,就在卡片上打一个洞。相对地,能做投资决定的次数也就减少一次。假如投资人真受到这样的限制,他无们就会耐心地等待绝佳的投资机会出现,而不会轻率地作决定。
> 請 [提交一個 issue](#) 並分配给相關同事。
> 訪問我們網站的最新動態,請 [點擊這裡](#) 進行訂閱!
對比用法:
> 請[提交一個 issue](#) 並分配给相關同事。
> 訪問我們網站的最新動態,請[點擊這裡](#)進行訂閱!
### 簡體中文使用直角引號
用法:
> 「老师,『有条不紊』的『紊』是什么意思?」
對比用法:
> “老师,‘有条不紊’的‘紊’是什么意思?”
## 工具
倉庫 | 系列 | 語言
--- | -- | ---
[pangu.js](https://github.com/vinta/pangu.js) | pangu | JavaScript
[pangu-go](https://github.com/vinta/pangu) | pangu | Go
[pangu.java](https://github.com/vinta/pangu.java) | pangu | Java
[pangu.py](https://github.com/vinta/pangu.py) | pangu | Python
[pangu.rb](https://github.com/dlackty/pangu.rb) | pangu | Ruby
[pangu.php](https://github.com/cchlorine/pangu.php) | pangu | PHP
[pangu.vim](https://github.com/hotoo/pangu.vim) | pangu | Vim
[vue-pangu](https://github.com/serkodev/vue-pangu) | pangu | Vue.js (Web Converter)
[intellij-pangu](https://plugins.jetbrains.com/plugin/19665-pangu) | pangu | Intellij Platform Plugin
[autocorrect](https://github.com/huacnlee/autocorrect) | autocorrect | Rust, WASM, CLI tool
[autocorrect-node](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-node) | autocorrect | Node.js
[autocorrect-py](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-py) | autocorrect | Python
[autocorrect-rb](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-rb) | autocorrect | Ruby
[autocorrect-java](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-java) | autocorrect | Java
[autocorrect-go](https://github.com/longbridgeapp/autocorrect) | autocorrect | Go
[autocorrect-php](https://github.com/NauxLiu/auto-correct) | autocorrect | PHP
[autocorrect-vscode](https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect) | autocorrect | VS Code Extension
[autocorrect-idea-plugin](https://plugins.jetbrains.com/plugin/20244-autocorrect) | autocorrect | Intellij Platform Plugin
[jxlwqq/chinese-typesetting](https://github.com/jxlwqq/chinese-typesetting) | other | PHP
[sparanoid/space-lover](https://github.com/sparanoid/space-lover) | other | PHP (WordPress)
[sparanoid/grunt-auto-spacing](https://github.com/sparanoid/grunt-auto-spacing) | other | Node.js (Grunt)
[hjiang/scripts/add-space-between-latin-and-cjk](https://github.com/hjiang/scripts/blob/master/add-space-between-latin-and-cjk) | other | Python
[hustcc/hint](https://github.com/hustcc/hint) | other | Python
[n0vad3v/Tekorrect](https://github.com/n0vad3v/Tekorrect) | other | Python
## 誰在這樣做?
網站 | 文案 | UGC
--- | --- | ---
[Apple 中國](https://www.apple.com/cn/) | Yes | N/A
[Apple 香港](https://www.apple.com/hk/) | Yes | N/A
[Apple 台灣](https://www.apple.com/tw/) | Yes | N/A
[Microsoft 中國](https://www.microsoft.com/zh-cn/) | Yes | N/A
[Microsoft 香港](https://www.microsoft.com/zh-hk/) | Yes | N/A
[Microsoft 台灣](https://www.microsoft.com/zh-tw/) | Yes | N/A
[LeanCloud](https://leancloud.cn/) | Yes | N/A
[V2EX](https://www.v2ex.com/) | Yes | Yes
[Apple4us](https://apple4us.com/) | Yes | N/A
[Ruby China](https://ruby-china.org/) | Yes | Yes
[少數派](https://sspai.com/) | Yes | N/A
## 參考文獻
- [Guidelines for Using Capital Letters - ThoughtCo.](https://www.thoughtco.com/guidelines-for-using-capital-letters-1691724)
- [Letter case - Wikipedia](https://en.wikipedia.org/wiki/Letter_case)
- [Punctuation - Oxford Dictionaries](https://en.oxforddictionaries.com/grammar/punctuation)
- [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/)
- [How to Use English Punctuation Correctly - wikiHow](https://www.wikihow.com/Use-English-Punctuation-Correctly)
- [格式 - openSUSE](https://zh.opensuse.org/index.php?title=Help:%E6%A0%BC%E5%BC%8F)
- [全形和半形 - 維基百科](https://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)
- [引號 - 維基百科](https://zh.wikipedia.org/wiki/%E5%BC%95%E8%99%9F)
- [疑問驚嘆號 - 維基百科](https://zh.wikipedia.org/wiki/%E7%96%91%E5%95%8F%E9%A9%9A%E5%98%86%E8%99%9F)
## Forks
衍生專案的用法可能與本專案存在差異。
- [mzlogin/chinese-copywriting-guidelines](https://github.com/mzlogin/chinese-copywriting-guidelines)

View File

@@ -1,296 +0,0 @@
# 中文文案排版指北
统一中文文案、排版的相关用法,降低团队成员之间的沟通成本,增强网站气质。
Other languages:
- [英语](README.en.md)
- [繁体中文](README.md)
- [简体中文](README.zh-Hans.md)
* * *
## 空格
> 「有研究显示,打字的时候不喜欢在中文和英文之间加空格的人,感情路都走得很辛苦,有七成的比例会在 34 岁的时候跟自己不爱的人结婚,而其余三成的人最后只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时地留白。
>
> 与大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js)
### 中英文之间需要增加空格
正确:
> 在 LeanCloud 上,数据存储是围绕 `AVObject` 进行的。
错误:
> 在LeanCloud上数据存储是围绕`AVObject`进行的。
>
> 在 LeanCloud上数据存储是围绕`AVObject` 进行的。
完整的正确用法:
> 在 LeanCloud 上,数据存储是围绕 `AVObject` 进行的。每个 `AVObject` 都包含了与 JSON 兼容的 key-value 对应的数据。数据是 schema-free 的,你不需要在每个 `AVObject` 上提前指定存在哪些键,只要直接设定对应的 key-value 即可。
例外「豆瓣FM」等产品名词按照官方所定义的格式书写。
### 中文与数字之间需要增加空格
正确:
> 今天出去买菜花了 5000 元。
错误:
> 今天出去买菜花了 5000元。
>
> 今天出去买菜花了5000元。
### 数字与单位之间需要增加空格
正确:
> 我家的光纤入屋宽带有 10 GbpsSSD 一共有 20 TB
错误:
> 我家的光纤入屋宽带有 10GbpsSSD 一共有 20TB
例外:度数/百分比与数字之间不需要增加空格:
正确:
> 角度为 90° 的角,就是直角。
>
> 新 MacBook Pro 有 15% 的 CPU 性能提升。
错误:
> 角度为 90 ° 的角,就是直角。
>
> 新 MacBook Pro 有 15 % 的 CPU 性能提升。
### 全角标点与其他字符之间不加空格
正确:
> 刚刚买了一部 iPhone好开心
错误:
> 刚刚买了一部 iPhone ,好开心!
>
> 刚刚买了一部 iPhone 好开心!
### 用 `text-spacing` 来挽救?
CSS Text Module Level 4 的 [`text-spacing`](https://www.w3.org/TR/css-text-4/#text-spacing-property) 和 Microsoft 的 [`-ms-text-autospace`](https://msdn.microsoft.com/library/ms531164(v=vs.85).aspx) 可以实现自动为中英文之间增加空白。不过目前并未普及,另外在其他应用场景,例如 macOS、iOS、Windows 等用户界面目前并不存在这个特性,所以请继续保持随手加空格的习惯。
## 标点符号
### 不重复使用标点符号
虽然中国大陆的标点符号用法允许重复使用标点符号,但是这么做会破坏句子的美观性。
正确:
> 德国队竟然战胜了巴西队!
>
> 她竟然对你说「喵」?!
错误:
> 德国队竟然战胜了巴西队!!
>
> 德国队竟然战胜了巴西队!!!!!!!!
>
> 她竟然对你说「喵」??!!
>
> 她竟然对你说「喵」?!?!??!!
## 全角和半角
不明白什么是全角(全形)与半角(半形)符号?请查看维基百科条目『[全角和半角](https://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)』。
### 使用全角中文标点
正确:
> 嗨!你知道嘛?今天前台的小妹跟我说「喵」了哎!
>
> 核磁共振成像NMRI是什么原理都不知道JFGI
错误:
> 嗨! 你知道嘛? 今天前台的小妹跟我说 "喵" 了哎!
>
> 嗨!你知道嘛?今天前台的小妹跟我说"喵"了哎!
>
> 核磁共振成像 (NMRI) 是什么原理都不知道? JFGI!
>
> 核磁共振成像(NMRI)是什么原理都不知道?JFGI!
例外:中文句子内夹有英文书籍名、报刊名时,不应借用中文书名号,应以英文斜体表示。
### 数字使用半角字符
正确:
> 这个蛋糕只卖 1000 元。
错误:
> 这个蛋糕只卖 元。
例外:在设计稿、宣传海报中如出现极少量数字的情形时,为方便文字对齐,是可以使用全角数字的。
### 遇到完整的英文整句、特殊名词,其内容使用半角标点
正确:
> 乔布斯那句话是怎么说的「Stay hungry, stay foolish.」
>
> 推荐你阅读 *Hackers & Painters: Big Ideas from the Computer Age*,非常地有趣。
错误:
> 乔布斯那句话是怎么说的「Stay hungrystay foolish。」
>
> 推荐你阅读《HackersPaintersBig Ideas from the Computer Age》非常的有趣。
## 名词
### 专有名词使用正确的大小写
大小写相关用法原属于英文书写范畴,不属于本 wiki 讨论内容,在这里只对部分易错用法进行简述。
正确:
> 使用 GitHub 登录
>
> 我们的客户有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。
错误:
> 使用 github 登录
>
> 使用 GITHUB 登录
>
> 使用 Github 登录
>
> 使用 gitHub 登录
>
> 使用 gイんĤЦ8 登录
>
> 我们的客户有 github、foursquare、microsoft corporation、google、facebook, inc.。
>
> 我们的客户有 GITHUB、FOURSQUARE、MICROSOFT CORPORATION、GOOGLE、FACEBOOK, INC.。
>
> 我们的客户有 Github、FourSquare、MicroSoft Corporation、Google、FaceBook, Inc.。
>
> 我们的客户有 gitHub、fourSquare、microSoft Corporation、google、faceBook, Inc.。
>
> 我们的客户有 gイんĤЦ8、キouЯƧquムгє、๓เςг๏ร๏Ŧt ς๏гק๏гคtเ๏ภn、900913、ƒ4ᄃëв๏๏к, IПᄃ.。
注意当网页中需要配合整体视觉风格而出现全部大写小写的情形HTML 中请使用标淮的大小写规范进行书写;并通过 `text-transform: uppercase;``text-transform: lowercase;` 对表现形式进行定义。
### 不要使用不地道的缩写
正确:
> 我们需要一位熟悉 TypeScript、HTML5至少理解一种框架如 React、Next.js的前端开发者。
错误:
> 我们需要一位熟悉 Ts、h5至少理解一种框架如 RJS、nextjs的 FED。
## 争议
以下用法略带有个人色彩,即:无论是否遵循下述规则,从语法的角度来讲都是**正确**的。
### 链接之间增加空格
用法:
> 请 [提交一个 issue](#) 并分配给相关同事。
>
> 访问我们网站的最新动态,请 [点击这里](#) 进行订阅!
对比用法:
> 请[提交一个 issue](#)并分配给相关同事。
>
> 访问我们网站的最新动态,请[点击这里](#)进行订阅!
### 简体中文使用直角引号
用法:
> 「老师,『有条不紊』的『紊』是什么意思?」
对比用法:
> “老师,‘有条不紊’的‘紊’是什么意思?”
## 工具
仓库 | 系列 | 语言
--- | ---- | ---
[pangu.js](https://github.com/vinta/pangu.js) | pangu | JavaScript
[pangu-go](https://github.com/vinta/pangu) | pangu | Go
[pangu.java](https://github.com/vinta/pangu.java) | pangu | Java
[pangu.py](https://github.com/vinta/pangu.py) | pangu | Python
[pangu.rb](https://github.com/dlackty/pangu.rb) | pangu | Ruby
[pangu.php](https://github.com/cchlorine/pangu.php) | pangu | PHP
[pangu.vim](https://github.com/hotoo/pangu.vim) | pangu | Vim
[vue-pangu](https://github.com/serkodev/vue-pangu) | pangu | Vue.js (Web Converter)
[intellij-pangu](https://plugins.jetbrains.com/plugin/19665-pangu) | pangu | Intellij Platform Plugin
[autocorrect](https://github.com/huacnlee/autocorrect) | autocorrect | Rust, WASM, CLI tool
[autocorrect-node](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-node) | autocorrect | Node.js
[autocorrect-py](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-py) | autocorrect | Python
[autocorrect-rb](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-rb) | autocorrect | Ruby
[autocorrect-java](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-java) | autocorrect | Java
[autocorrect-go](https://github.com/longbridgeapp/autocorrect) | autocorrect | Go
[autocorrect-php](https://github.com/NauxLiu/auto-correct) | autocorrect | PHP
[autocorrect-vscode](https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect) | autocorrect | VS Code Extension
[autocorrect-idea-plugin](https://plugins.jetbrains.com/plugin/20244-autocorrect) | autocorrect | Intellij Platform Plugin
[jxlwqq/chinese-typesetting](https://github.com/jxlwqq/chinese-typesetting) | other | PHP
[sparanoid/space-lover](https://github.com/sparanoid/space-lover) | other | PHP (WordPress)
[sparanoid/grunt-auto-spacing](https://github.com/sparanoid/grunt-auto-spacing) | other | Node.js (Grunt)
[hjiang/scripts/add-space-between-latin-and-cjk](https://github.com/hjiang/scripts/blob/master/add-space-between-latin-and-cjk) | other | Python
[hustcc/hint](https://github.com/hustcc/hint) | other | Python
[n0vad3v/Tekorrect](https://github.com/n0vad3v/Tekorrect) | other | Python
## 谁在这样做?
网站 | 文案 | UGC
--- | --- | ---
[Apple 中国](https://www.apple.com/cn/) | 是 | N/A
[Apple 香港](https://www.apple.com/hk/) | 是 | N/A
[Apple 台湾](https://www.apple.com/tw/) | 是 | N/A
[Microsoft 中国](https://www.microsoft.com/zh-cn/) | 是 | N/A
[Microsoft 香港](https://www.microsoft.com/zh-hk/) | 是 | N/A
[Microsoft 台湾](https://www.microsoft.com/zh-tw/) | 是 | N/A
[LeanCloud](https://leancloud.cn/) | 是 | N/A
[V2EX](https://www.v2ex.com/) | 是 | 是
[Apple4us](https://apple4us.com/) | 是 | N/A
[Ruby China](https://ruby-china.org/) | 是 | 是
[少数派](https://sspai.com/) | 是 | N/A
## 参考文献
- [Guidelines for Using Capital Letters - ThoughtCo.](https://www.thoughtco.com/guidelines-for-using-capital-letters-1691724)
- [Letter case - Wikipedia](https://en.wikipedia.org/wiki/Letter_case)
- [Punctuation - Oxford Dictionaries](https://en.oxforddictionaries.com/grammar/punctuation)
- [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/)
- [How to Use English Punctuation Correctly - wikiHow](https://www.wikihow.com/Use-English-Punctuation-Correctly)
- [格式 - openSUSE](https://zh.opensuse.org/index.php?title=Help:%E6%A0%BC%E5%BC%8F)
- [全形和半形 - 维基百科](https://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)
- [引号 - 维基百科](https://zh.wikipedia.org/wiki/%E5%BC%95%E8%99%9F)
- [疑问惊叹号 - 维基百科](https://zh.wikipedia.org/wiki/%E7%96%91%E5%95%8F%E9%A9%9A%E5%98%86%E8%99%9F)
## Forks
衍生项目的用法可能与本项目存在差异。
- [mzlogin/chinese-copywriting-guidelines](https://github.com/mzlogin/chinese-copywriting-guidelines)

View File

@@ -1,3 +0,0 @@
files:
- source: /README.md
translation: /README.%locale%.md

View File

@@ -1,56 +0,0 @@
{
"name": "chinese-copywriting-guidelines",
"version": "1.0.1",
"description": "Chinese Copywriting Guidelines",
"author": "Tunghsiao Liu",
"homepage": "http://github.com/sparanoid/chinese-copywriting-guidelines",
"main": "README.md",
"scripts": {
"test": "remark .",
"release": "npx release-it"
},
"remarkConfig": {
"plugins": [
"remark-preset-lint-consistent",
"remark-preset-lint-recommended",
[
"remark-lint-list-item-indent",
"space"
]
]
},
"repository": {
"type": "git",
"url": "https://github.com/sparanoid/chinese-copywriting-guidelines.git"
},
"bugs": {
"url": "https://github.com/sparanoid/chinese-copywriting-guidelines/issues"
},
"license": "MIT",
"keywords": [
"chinese",
"copywriting",
"guideline"
],
"readmeFilename": "README.md",
"devDependencies": {
"remark-cli": "^11.0.0",
"remark-lint-list-item-indent": "^3.1.1",
"remark-preset-lint-consistent": "^5.1.1",
"remark-preset-lint-recommended": "^6.1.2"
},
"release-it": {
"git": {
"commitArgs": "-S",
"commitMessage": "chore: release v${version}",
"tagArgs": "-s",
"tagAnnotation": "chore: release v${version}"
},
"github": {
"release": true
},
"npm": {
"publish": false
}
}
}

1671
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +0,0 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base"
]
}