60 Commits

Author SHA1 Message Date
Tunghsiao Liu
a5f7bb4868 chore: release v0.0.9 2016-02-17 23:37:27 +08:00
Tunghsiao Liu
ec9ae8d516 feat(package): update contributors 2016-02-17 23:37:27 +08:00
Tunghsiao Liu
02bb41cc3a feat(docs): update link redirects, props @ReadmeCritic 2016-02-17 23:37:04 +08:00
Tunghsiao Liu
bc736c22ad feat(docs): update repo link 2016-02-17 23:35:19 +08:00
Tunghsiao Liu
ebadda1792 Merge pull request #31 from ddanist/master
feat(docs): wrong quote marks usage
2016-02-17 23:13:28 +08:00
Tunghsiao Liu
e5944c2bba Merge pull request #27 from sparanoid/greenkeeper-matchdep-1.0.1
matchdep@1.0.1 untested ⚠️
2016-02-17 23:06:56 +08:00
ddanist
8e63a4c88d 一些标点符号的更正。 2016-02-14 18:49:17 +08:00
Tunghsiao Liu
d4a330bf90 Merge pull request #30 from sparanoid/greenkeeper-grunt-conventional-changelog-6.1.0
grunt-conventional-changelog@6.1.0 untested ⚠️
2016-02-13 19:58:25 +08:00
greenkeeperio-bot
5ce9fff3ee chore(package): update grunt-conventional-changelog to version 6.1.0 2016-02-13 15:30:16 +08:00
Tunghsiao Liu
3669649c1c Merge pull request #29 from sparanoid/greenkeeper-grunt-conventional-changelog-6.0.1
grunt-conventional-changelog@6.0.1 untested ⚠️
2016-02-11 19:41:57 +08:00
greenkeeperio-bot
513a410ae5 chore(package): update grunt-conventional-changelog to version 6.0.1 2016-02-11 19:24:26 +08:00
Tunghsiao Liu
e1d0ff3a2c Merge pull request #28 from sparanoid/greenkeeper-grunt-conventional-changelog-6.0.0
Update grunt-conventional-changelog to version 6.0.0 🚀
2016-02-11 19:20:26 +08:00
greenkeeperio-bot
e219ab2e83 chore(package): update grunt-conventional-changelog to version 6.0.0 2016-02-11 19:11:15 +08:00
greenkeeperio-bot
95e3fedd34 chore(package): update matchdep to version 1.0.1 2016-02-10 02:16:54 +08:00
Tunghsiao Liu
28c5ec8b95 refactor(docs): update TOC 2015-12-14 10:57:30 +08:00
Tunghsiao Liu
d1cd9e36a2 Merge pull request #26 from mzlogin/master
fix(docs): wrong TOC anchors
2015-12-14 10:43:29 +08:00
Zhuang Ma
d0468e7487 fix(docs): wrong TOC anchors 2015-12-13 20:38:24 +08:00
Tunghsiao Liu
d879493928 chore: release v0.0.8 2015-12-11 10:58:10 +08:00
Tunghsiao Liu
c8e29afe1c feat(package): update contributors 2015-12-11 10:58:10 +08:00
Tunghsiao Liu
3e89ab395c chore(docs): add language list 2015-12-11 10:11:04 +08:00
Tunghsiao Liu
61a43f4496 feat(docs): add language list 2015-12-11 10:10:11 +08:00
Tunghsiao Liu
585e71e282 fix(docs): wrong TOC anchors 2015-12-11 10:05:53 +08:00
Tunghsiao Liu
a7321991f3 feat(docs): initial English version 2015-12-11 09:59:01 +08:00
Tunghsiao Liu
db596b189f feat(docs): use original titles for references 2015-12-11 09:59:01 +08:00
Tunghsiao Liu
039ed42f40 Merge pull request #25 from sparanoid/greenkeeper-grunt-bump-0.7.0
Update grunt-bump to version 0.7.0 🚀
2015-12-11 09:05:00 +08:00
greenkeeperio-bot
d49302bfd1 chore(package): update grunt-bump to version 0.7.0 2015-12-11 05:00:37 +08:00
Tunghsiao Liu
a2569b3310 feat(docs): update spacing rule for links 2015-12-09 14:09:45 +08:00
Tunghsiao Liu
200eb493a5 feat(docs): re-evaluate V2EX 2015-12-09 13:48:15 +08:00
Tunghsiao Liu
1104e24cdc feat(docs): add Python library from hjiang/scripts 2015-12-09 13:47:17 +08:00
Tunghsiao Liu
d42d646874 fix(docs): avoid slangs 2015-12-08 10:51:53 +08:00
Tunghsiao Liu
591b50828c chore: release v0.0.7 2015-10-25 18:40:04 +08:00
Tunghsiao Liu
855514dbad feat(package): update contributors 2015-10-25 18:40:04 +08:00
Tunghsiao Liu
1b94ea311e Merge pull request #24 from sparanoid/greenkeeper-update-all
Update all dependencies 🌴
2015-10-25 18:29:55 +08:00
Tunghsiao Liu
ee62ad5115 feat(docs): add badge for HTML version 2015-10-25 18:13:57 +08:00
Tunghsiao Liu
1ce86f46e8 feat(docs): simplify examples 2015-10-25 17:11:02 +08:00
Tunghsiao Liu
b5c5733886 feat(docs): remove custom emojis 2015-10-25 17:03:24 +08:00
Tunghsiao Liu
be7f513328 feat(docs): simplify TOC 2015-10-25 16:44:17 +08:00
greenkeeperio-bot
8d60d29d0c chore(package): update dependencies
http://greenkeeper.io/
2015-10-15 14:46:24 +08:00
Tunghsiao Liu
b495cc5526 feat(docs): add languages section 2015-09-07 19:39:19 +08:00
Tunghsiao Liu
be68d79305 chore(docs): update TOC 2015-09-07 19:38:06 +08:00
Tunghsiao Liu
d2cf2d7cc1 Merge pull request #22 from NauxLiu/patch-1
添加 nauxliu/auto-correct
2015-09-07 19:35:04 +08:00
Tunghsiao Liu
2afe771558 feat(docs): add new tool 2015-09-02 20:22:21 +08:00
刘相轩
4449f36d71 Update README.md 2015-08-28 16:05:17 +08:00
Tunghsiao Liu
0b19a3274b chore: release v0.0.6 2015-08-12 18:53:15 +08:00
Tunghsiao Liu
48f7cb8601 feat(package): update contributors 2015-08-12 18:53:15 +08:00
Tunghsiao Liu
666279696d feat(grunt): better version handling 2015-08-12 18:51:09 +08:00
Tunghsiao Liu
bea8e172b1 feat(package): update contributors 2015-08-12 18:51:09 +08:00
Tunghsiao Liu
1fb7e8d08b wip(grunt): try grunt-bump 2015-08-12 18:51:09 +08:00
Tunghsiao Liu
1bd7b8f874 Merge pull request #20 from district10/master
chore: added an empty line before quotation
2015-08-10 09:54:44 +08:00
tzx
c808cb13c7 add an empty line before quotation 2015-08-10 09:33:19 +08:00
Tunghsiao Liu
dfd2b9d268 chore: fix changelog 2015-07-08 18:29:40 +08:00
Tunghsiao Liu
b5ab14fa0c chore: release 0.0.5 2015-07-08 18:28:15 +08:00
Tunghsiao Liu
ac6b463c69 fix(package): license not defined 2015-07-08 18:26:47 +08:00
Tunghsiao Liu
a7c0ce50c3 chore: bump deps version 2015-07-08 18:25:42 +08:00
Tunghsiao Liu
6f8f4fd237 chore: kill a weird character 2015-07-08 18:22:47 +08:00
Tunghsiao Liu
9a009b3d5d fix(docs): typo HTML5, fixes https://github.com/sparanoid/chinese-copywriting-guidelines/issues/19 2015-07-08 18:18:01 +08:00
Tunghsiao Liu
c0e573f2df chore: change description position 2015-06-19 09:35:45 +08:00
Tunghsiao Liu
c2ec2d82cb fix(docs): wrong heading 2015-06-19 09:34:57 +08:00
Tunghsiao Liu
423cfa9c96 chore: upgrade hardwares 2015-06-18 11:04:12 +08:00
Tunghsiao Liu
f2d982d73f feat(docs): avoid unidiomatic jargons 2015-06-18 11:00:21 +08:00
5 changed files with 462 additions and 96 deletions

View File

@@ -1,3 +1,85 @@
<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)

View File

@@ -9,23 +9,34 @@ module.exports = (grunt) ->
config:
pkg: grunt.file.readJSON("package.json")
release:
"npm-contributors":
options:
changelog: false,
file: "package.json"
npm: false
commitMessage: "chore: release <%= version %>"
tagName: "v<%= version %>"
tagMessage: "chore: tagging version <%= version %>"
afterBump: [
"changelog"
]
# Dev options
commit: false
tag: false
commitMessage: "feat(package): update contributors"
conventionalChangelog:
options:
changelogOpts:
preset: "angular"
dist:
src: "CHANGELOG.md"
bump:
options:
files: ["package.json"]
commitMessage: 'chore: release v%VERSION%'
commitFiles: ["-a"]
tagMessage: 'chore: create tag %VERSION%'
push: false
pushTags: false
grunt.registerTask "default", "Default task aka. build task", [
"changelog"
]
grunt.registerTask "default", "Default task aka. build task", (type) ->
grunt.task.run [
"npm-contributors"
"bump-only:#{type or 'patch'}"
"conventionalChangelog"
"bump-commit"
]

262
README.en.md Normal file
View File

@@ -0,0 +1,262 @@
# Chinese Copywriting Guidelines
[![devDependency Status](https://david-dm.org/sparanoid/chinese-copywriting-guidelines/dev-status.svg)](https://david-dm.org/sparanoid/chinese-copywriting-guidelines#info=devDependencies)
[![Built with Almace Scaffolding](https://d349cztnlupsuf.cloudfront.net/amsf-badge.svg)](http://sparanoid.com/note/chinese-copywriting-guidelines/)
Chinese copywriting guidelines for better written communication.
Other languages:
- [English](README.en.md)
- [Chinese Traditional](README.md)
- [Chinese Simplifed](https://github.com/mzlogin/chinese-copywriting-guidelines)
-----
## Table of Contents
- [Spacing](#spacing)
- [Place one space before/after English words](#place-one-space-beforeafter-english-words)
- [Place one space before/after numbers](#place-one-space-beforeafter-numbers)
- [Place one space between numbers and units](#place-one-space-between-numbers-and-units)
- [No additional spaces before/after punctuation in fullwidth form](#no-additional-spaces-beforeafter-punctuation-in-fullwidth-form)
- [`-ms-text-autospace` to the rescue?](#-ms-text-autospace-to-the-rescue)
- [Punctuation](#punctuation)
- [Avoid duplicate punctuation](#avoid-duplicate-punctuation)
- [Fullwidth and halfwidth](#fullwidth-and-halfwidth)
- [Use punctuation in fullwidth form](#use-punctuation-in-fullwidth-form)
- [Use numbers in halfwidth form](#use-numbers-in-halfwidth-form)
- [Use punctuation in halfwidth form for English sentences](#use-punctuation-in-halfwidth-form-for-english-sentences)
- [Nouns](#nouns)
- [Avoid jargons](#avoid-jargons)
- [Dispute](#dispute)
- [Add extra spaces before/after links](#add-extra-spaces-beforeafter-links)
- [Use corner brackets for Chinese Simplified](#use-corner-brackets-for-chinese-simplified)
- [Tools](#tools)
- [Examples of “Who is doing this?”](#examples-of-who-is-doing-this)
- [References](#references)
## Spacing
「有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。
與大家共勉之。」——[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:
> 今天是 233° 的高溫。
> 新 MacBook Pro 有 15% 的 CPU 性能提升。
Bad:
> 今天是 233 ° 的高溫。
> 新 MacBook Pro 有 15 % 的 CPU 性能提升。
### No additional spaces before/after punctuation in fullwidth form
Good:
> 剛剛買了一部 iPhone好開心
Bad:
> 剛剛買了一部 iPhone ,好開心!
### `-ms-text-autospace` to the rescue?
Microsoft provides a CSS property [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/ie/ms531164(v=vs.85).aspx) that 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
Good:
> 德國隊竟然戰勝了巴西隊!
> 她竟然對你說「喵」?!
Bad:
> 德國隊竟然戰勝了巴西隊!!
> 德國隊竟然戰勝了巴西隊!!!!!!!!
> 她竟然對你說「喵」??!!
> 她竟然對你說「喵」?!?!??!!
## Fullwidth and halfwidth
If youre not familiar with fullwidth and halfwidth forms please refer to [Halfwidth and fullwidth forms](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) on Wikipedia.
### Use punctuation in fullwidth form
Good:
> 嗨!你知道嘛?今天前台的小妹跟我說「喵」了哎!
> 核磁共振成像NMRI是什麼原理都不知道JFGI
Bad:
> 嗨! 你知道嘛? 今天前台的小妹跟我說 "喵" 了哎!
> 嗨!你知道嘛?今天前台的小妹跟我說"喵"了哎!
> 核磁共振成像 (NMRI) 是什麼原理都不知道? JFGI!
> 核磁共振成像(NMRI)是什麼原理都不知道?JFGI!
### 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
### Avoid jargons
Good:
> 我們需要一位熟悉 JavaScript、HTML5至少理解一种框架如 Backbone.js、AngularJS、React 等)的前端開發者。
Bad:
> 我們需要一位熟悉 Js、h5至少理解一种框架如 backbone、angular、RJS 等)的 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 | Language
--- | ---
[vinta/paranoid-auto-spacing](https://github.com/vinta/paranoid-auto-spacing) | JavaScript
[huei90/pangu.node](https://github.com/huei90/pangu.node) | Node.js
[huacnlee/auto-correct](https://github.com/huacnlee/auto-correct) | Ruby
[sparanoid/space-lover](https://github.com/sparanoid/space-lover) | PHP (WordPress)
[nauxliu/auto-correct](https://github.com/NauxLiu/auto-correct) | PHP
[hotoo/pangu.vim](https://github.com/hotoo/pangu.vim) | Vim
[sparanoid/grunt-auto-spacing](https://github.com/sparanoid/grunt-auto-spacing) | Node.js (Grunt)
[hjiang/scripts/add-space-between-latin-and-cjk](https://github.com/hjiang/scripts/blob/master/add-space-between-latin-and-cjk) | Python
## Examples of “Who is doing this?”
Website | Copywriting | UGC
--- | --- | ---
[Apple China](http://www.apple.com/cn/) | Yes | N/A
[Apple Hong Kong](http://www.apple.com/hk/) | Yes | N/A
[Apple Taiwan](http://www.apple.com/tw/) | Yes | N/A
[Microsoft China](http://www.microsoft.com/zh-cn/) | Yes | N/A
[Microsoft Hong Kong](http://www.microsoft.com/zh-hk/) | Yes | N/A
[Microsoft Taiwan](http://www.microsoft.com/zh-tw/) | Yes | N/A
[LeanCloud](https://leancloud.cn/) | Yes | N/A
[Zhihu](https://www.zhihu.com/) | Yes | Partial
[V2EX](https://www.v2ex.com/) | Yes | Yes
[SegmentFault](https://segmentfault.com/) | Yes | Partial
[Apple4us](http://apple4us.com/) | Yes | N/A
[Wandoujia](https://www.wandoujia.com/) | Yes | N/A
[Ruby China](https://ruby-china.org/) | Yes | Partial
[PHPHub](https://phphub.org/) | Yes | Partial
## References
- [Guidelines for Using Capital Letters - About.com](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm)
- [Letter case - Wikipedia](http://en.wikipedia.org/wiki/Letter_case)
- [Punctuation - Oxford Dictionaries](http://www.oxforddictionaries.com/words/punctuation)
- [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/)
- [How to Use English Punctuation Correctly - wikiHow](http://www.wikihow.com/Use-English-Punctuation-Correctly)
- [格式 - openSUSE](https://zh.opensuse.org/index.php?title=Help:%E6%A0%BC%E5%BC%8F)
- [全形和半形 - 維基百科](http://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)
- [引號 - 維基百科](http://zh.wikipedia.org/wiki/%E5%BC%95%E8%99%9F)
- [疑問驚嘆號 - 維基百科](http://zh.wikipedia.org/wiki/%E7%96%91%E5%95%8F%E9%A9%9A%E5%98%86%E8%99%9F)

144
README.md
View File

@@ -1,41 +1,47 @@
# 中文文案排版指北
[![devDependency Status](https://david-dm.org/sparanoid/chinese-copywriting-guidelines/dev-status.svg)](https://david-dm.org/sparanoid/chinese-copywriting-guidelines#info=devDependencies)
[![Built with Almace Scaffolding](https://d349cztnlupsuf.cloudfront.net/amsf-badge.svg)](http://sparanoid.com/note/chinese-copywriting-guidelines/)
統一中文文案、排版的相關用法,降低團隊成員之間的溝通成本,增強網站氣質。
Other languages:
- [English](README.en.md)
- [Chinese Traditional](README.md)
- [Chinese Simplifed](https://github.com/mzlogin/chinese-copywriting-guidelines)
-----
## Table of Contents
## 目次
- [空格](#spacing)
- [中英文之間需要增加空格](#spacing-c1)
- [中文與數字之間需要增加空格](#spacing-c2)
- [數字與單位之間需要增加空格](#spacing-c3)
- [全形標點與其他字符之間不加空格](#spacing-c4)
- [`-ms-text-autospace` to the rescue?](#spacing-c5)
- [標點符號](#punctuation-marks)
- [不重複使用標點符號](#punctuation-marks-c1)
- [全形和半形](#fullwidth-halfwidth)
- [使用全形中文標點](#fullwidth-halfwidth-c1)
- [數字使用半形字符](#fullwidth-halfwidth-c2)
- [遇到完整的英文整句、特殊名詞,其內容使用半形標點](#fullwidth-halfwidth-c3)
- [大小寫](#letter-case)
- [專有名詞使用正確的大小寫](#letter-case-c1)
- [爭議](#dispute)
- [中文鏈接之間增加空格](#dispute-c1)
- [簡體中文使用直角引號](#dispute-c2)
- [工具](#tools)
- [誰在這樣做?](#who-is-using)
- [參考文獻](#references)
- [空格](#空格)
- [中英文之間需要增加空格](#中英文之間需要增加空格)
- [中文與數字之間需要增加空格](#中文與數字之間需要增加空格)
- [數字與單位之間需要增加空格](#數字與單位之間需要增加空格)
- [全形標點與其他字符之間不加空格](#全形標點與其他字符之間不加空格)
- [`-ms-text-autospace` to the rescue?](#-ms-text-autospace-to-the-rescue)
- [標點符號](#標點符號)
- [不重複使用標點符號](#不重複使用標點符號)
- [全形和半形](#全形和半形)
- [使用全形中文標點](#使用全形中文標點)
- [數字使用半形字符](#數字使用半形字符)
- [遇到完整的英文整句、特殊名詞,其內容使用半形標點](#遇到完整的英文整句特殊名詞其內容使用半形標點)
- [名詞](#名詞)
- [專有名詞使用正確的大小寫](#專有名詞使用正確的大小寫)
- [不要使用不地道的縮寫](#不要使用不地道的縮寫)
- [爭議](#爭議)
- [鏈接之間增加空格](#鏈接之間增加空格)
- [簡體中文使用直角引號](#簡體中文使用直角引號)
- [工具](#工具)
- [誰在這樣做?](#誰在這樣做)
- [參考文獻](#參考文獻)
<a name="spacing"></a>
## 空格
「有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。
與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/paranoid-auto-spacing)
與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js)
<a name="spacing-c1"></a>
### 中英文之間需要增加空格
正確:
@@ -49,11 +55,11 @@
> 在 LeanCloud上數據存儲是圍繞`AVObject` 進行的。
完整的正確用法:
> 在 LeanCloud 上,数据存储是围绕 `AVObject` 进行的。每个 `AVObject` 都包含了与 JSON 兼容的 key-value 对应的数据。数据是 schema-free 的,你不需要在每个 `AVObject` 上提前指定存在哪些键,只要直接设定对应的 key-value 即可。
:exclamation: 例外「豆瓣FM」等產品名詞按照官方所定義的格式書寫。
例外「豆瓣FM」等產品名詞按照官方所定義的格式書寫。
<a name="spacing-c2"></a>
### 中文與數字之間需要增加空格
正確:
@@ -66,18 +72,17 @@
> 今天出去買菜花了5000元。
<a name="spacing-c3"></a>
### 數字與單位之間需要增加空格
正確:
> 我家的寬帶有 1 Gbps硬盤一共有 10 TB。
> 我家的光纖入屋寬頻有 10 GbpsSSD 一共有 20 TB。
錯誤:
> 我家的寬帶有 1Gbps硬盤一共有 10TB。
> 我家的光纖入屋寬頻有 10GbpsSSD 一共有 20TB。
:exclamation: 例外:度/百分比與數字之間不需要增加空格:
例外:度/百分比與數字之間不需要增加空格:
正確:
@@ -91,7 +96,6 @@
> 新 MacBook Pro 有 15 % 的 CPU 性能提升。
<a name="spacing-c4"></a>
### 全形標點與其他字符之間不加空格
正確:
@@ -102,15 +106,12 @@
> 剛剛買了一部 iPhone ,好開心!
<a name="spacing-c5"></a>
### `-ms-text-autospace` to the rescue?
Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/ie/ms531164(v=vs.85).aspx) 的 CSS 屬性可以實現自動為中英文之間增加空白。不過目前並未普及,另外在其他應用場景,例如 OS X、iOS 的用戶介面目前并不存在這個特性,所以請繼續保持隨手加空格的習慣。
<a name="punctuation-marks"></a>
## 標點符號
<a name="punctuation-marks-c1"></a>
### 不重複使用標點符號
正確:
@@ -123,20 +124,16 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
> 德國隊竟然戰勝了巴西隊!!
> 德國隊竟然戰勝了巴西隊!!!!
> 德國隊竟然戰勝了巴西隊!!!!!!!!
> 她竟然對你說「喵」??!!
> 她竟然對你說「喵」?!?!??!!
<a name="fullwidth-halfwidth"></a>
## 全形和半形
:exclamation: 不明白什麼是全形(全角)與半形(半角)符號?請查看維基百科詞條『[全形和半形](http://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)』。
不明白什麼是全形(全角)與半形(半角)符號?請查看維基百科詞條『[全形和半形](http://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)』。
<a name="fullwidth-halfwidth-c1"></a>
### 使用全形中文標點
正確:
@@ -155,7 +152,6 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
> 核磁共振成像(NMRI)是什麼原理都不知道?JFGI!
<a name="fullwidth-halfwidth-c2"></a>
### 數字使用半形字符
正確:
@@ -166,31 +162,28 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
> 這件蛋糕只賣 元。
:exclamation: 例外:在設計稿、宣傳海報中如出現極少量數字的情形時,為方便文字對齊,是可以使用全形數字的。
例外:在設計稿、宣傳海報中如出現極少量數字的情形時,為方便文字對齊,是可以使用全形數字的。
<a name="fullwidth-halfwidth-c3"></a>
### 遇到完整的英文整句、特殊名詞,其內容使用半形標點
正確:
> 喬幫主那句話是怎麼說的「Stay hungry, stay foolish.」
> 賈伯斯那句話是怎麼說的「Stay hungry, stay foolish.」
> 推薦你閱讀Hackers & Painters: Big Ideas from the Computer Age,非常的有趣。
> 推薦你閱讀Hackers & Painters: Big Ideas from the Computer Age,非常的有趣。
錯誤:
> 喬幫主那句話是怎麼說的「Stay hungrystay foolish。」
> 賈伯斯那句話是怎麼說的「Stay hungrystay foolish。」
> 推薦你閱讀HackersPaintersBig Ideas from the Computer Age,非常的有趣。
> 推薦你閱讀HackersPaintersBig Ideas from the Computer Age,非常的有趣。
<a name="letter-case"></a>
## 大小寫
## 名詞
### 專有名詞使用正確的大小寫
大小寫相關用法原屬於英文書寫範疇,不屬於本 wiki 討論內容,在這裡只對部分易錯用法進行簡述。
<a name="letter-case-c1"></a>
### 專有名詞使用正確的大小寫
正確:
> 使用 GitHub 登錄
@@ -221,13 +214,21 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
注意當網頁中需要配合整體視覺風格而出現全部大寫小寫的情形HTML 中請使用標準的大小寫規範進行書寫;並通過 `text-transform: uppercase;``text-transform: lowercase;` 對表現形式進行定義。
<a name="dispute"></a>
### 不要使用不地道的縮寫
正確:
> 我們需要一位熟悉 JavaScript、HTML5至少理解一种框架如 Backbone.js、AngularJS、React 等)的前端開發者。
錯誤:
> 我們需要一位熟悉 Js、h5至少理解一种框架如 backbone、angular、RJS 等)的 FED。
## 爭議
:exclamation: 以下用法略帶有個人色彩,既:無論是否遵循下述規則,從語法的角度來講都是**正確**的。
以下用法略帶有個人色彩,既:無論是否遵循下述規則,從語法的角度來講都是**正確**的。
<a name="dispute-c1"></a>
### 中文鏈接之間增加空格
### 鏈接之間增加空格
用法:
@@ -241,7 +242,6 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
> 訪問我們網站的最新動態,請[點擊這裡](#)進行訂閱!
<a name="dispute-c2"></a>
### 簡體中文使用直角引號
用法:
@@ -252,7 +252,6 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
> “老师,‘有条不紊’的‘紊’是什么意思?”
<a name="tools"></a>
## 工具
倉庫 | 語言
@@ -261,9 +260,11 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
[huei90/pangu.node](https://github.com/huei90/pangu.node) | Node.js
[huacnlee/auto-correct](https://github.com/huacnlee/auto-correct) | Ruby
[sparanoid/space-lover](https://github.com/sparanoid/space-lover) | PHP (WordPress)
[nauxliu/auto-correct](https://github.com/NauxLiu/auto-correct) | PHP
[hotoo/pangu.vim](https://github.com/hotoo/pangu.vim) | Vim
[sparanoid/grunt-auto-spacing](https://github.com/sparanoid/grunt-auto-spacing) | Node.js (Grunt)
[hjiang/scripts/add-space-between-latin-and-cjk](https://github.com/hjiang/scripts/blob/master/add-space-between-latin-and-cjk) | Python
<a name="who-is-using"></a>
## 誰在這樣做?
網站 | 文案 | UGC
@@ -274,24 +275,23 @@ Microsoft 有個 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/
[Microsoft 中國](http://www.microsoft.com/zh-cn/) | Yes | N/A
[Microsoft 香港](http://www.microsoft.com/zh-hk/) | Yes | N/A
[Microsoft 台灣](http://www.microsoft.com/zh-tw/) | Yes | N/A
[LeanCloud](http://leancloud.cn/) | Yes | N/A
[知乎](http://www.zhihu.com/) | Yes | 部分用戶達成
[V2EX](http://www.v2ex.com/) | Yes | 標題達成
[SegmentFault](http://segmentfault.com/) | Yes | 部分用戶達成
[LeanCloud](https://leancloud.cn/) | Yes | N/A
[知乎](https://www.zhihu.com/) | Yes | 部分用戶達成
[V2EX](https://www.v2ex.com/) | Yes | Yes
[SegmentFault](https://segmentfault.com/) | Yes | 部分用戶達成
[Apple4us](http://apple4us.com/) | Yes | N/A
[豌豆荚](http://www.wandoujia.com/) | Yes | N/A
[Ruby China](http://ruby-china.org/) | Yes | 標題達成
[PHPHub](http://phphub.org/) | Yes | 標題達成
[豌豆荚](https://www.wandoujia.com/) | Yes | N/A
[Ruby China](https://ruby-china.org/) | Yes | 標題達成
[PHPHub](https://phphub.org/) | Yes | 標題達成
<a name="references"></a>
## 參考文獻
- [來自 About.com 的大小寫用法(英文)](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm)
- [來自維基百科的關於大小寫字符的相關條目(英文)](http://en.wikipedia.org/wiki/Letter_case)
- [來自 Oxford Dictionaries 的標點相關用法(英文)](http://www.oxforddictionaries.com/us/words/punctuation)
- [來自普渡大學的標點符號用法(英文)](https://owl.english.purdue.edu/owl/section/1/6/)
- [來自 wikiHow 的英文標點符號用法 wiki(英文)](http://www.wikihow.com/Use-English-Punctuation-Correctly)
- [格式openSUSE](https://zh.opensuse.org/index.php?title=Help:%E6%A0%BC%E5%BC%8F)
- [Guidelines for Using Capital Letters - About.com](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm)
- [Letter case - Wikipedia](http://en.wikipedia.org/wiki/Letter_case)
- [Punctuation - Oxford Dictionaries](http://www.oxforddictionaries.com/words/punctuation)
- [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/)
- [How to Use English Punctuation Correctly - wikiHow](http://www.wikihow.com/Use-English-Punctuation-Correctly)
- [格式 - openSUSE](https://zh.opensuse.org/index.php?title=Help:%E6%A0%BC%E5%BC%8F)
- [全形和半形 - 維基百科](http://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)
- [引號 - 維基百科](http://zh.wikipedia.org/wiki/%E5%BC%95%E8%99%9F)
- [疑問驚嘆號 - 維基百科](http://zh.wikipedia.org/wiki/%E7%96%91%E5%95%8F%E9%A9%9A%E5%98%86%E8%99%9F)

View File

@@ -1,9 +1,9 @@
{
"name": "chinese-copywriting-guidelines",
"version": "0.0.4",
"version": "0.0.9",
"description": "Chinese Copywriting Guidelines",
"author": "Tunghsiao Liu",
"homepage": "http://sparanoid.com/",
"homepage": "http://github.com/sparanoid/chinese-copywriting-guidelines",
"main": "README.md",
"scripts": {
"test": "grunt"
@@ -15,10 +15,7 @@
"bugs": {
"url": "http://github.com/sparanoid/chinese-copywriting-guidelines/issues"
},
"licenses": {
"type": "WTFPL",
"url": "http://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/LICENSE"
},
"license": "WTFPL",
"keywords": [
"chinese",
"copywriting",
@@ -27,8 +24,22 @@
"readmeFilename": "README.md",
"devDependencies": {
"grunt": "^0.4.5",
"grunt-conventional-changelog": "^1.2.1",
"grunt-release": "^0.12.0",
"matchdep": "^0.3.0"
}
"grunt-bump": "^0.7.0",
"grunt-conventional-changelog": "^6.1.0",
"grunt-npm": "0.0.2",
"matchdep": "^1.0.1"
},
"contributors": [
"greenkeeperio-bot <support@greenkeeper.io>",
"Jason Lee <huacnlee@gmail.com>",
"Yang Li <idealhack@gmail.com>",
"Zhuang Ma <chumpma@gmail.com>",
"ddanist <danx2ist@gmail.com>",
"tzx <district10@users.noreply.github.com>",
"NauxLiu@users.noreply.github.com>",
"Charlie Jade <summer.alex07@gmail.com>",
"hotoo@users.noreply.github.com>",
"Elethom Hunter <elethomhunter@gmail.com>",
"Huei Tan <huei90@users.noreply.github.com>"
]
}