2 Commits

Author SHA1 Message Date
greenkeeper[bot]
326becadc1 chore(package): update lockfile package-lock.json 2019-03-22 19:31:54 +00:00
greenkeeper[bot]
ced08d5e31 chore(package): update grunt to version 1.0.4 2019-03-22 19:31:50 +00:00
14 changed files with 4390 additions and 2276 deletions

View File

@@ -1,11 +0,0 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"

View File

@@ -1,47 +0,0 @@
name: Test
on:
push:
branches:
- 'master'
tags:
- 'v*'
pull_request:
branches:
- 'master'
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 20
- uses: pnpm/action-setup@v2
name: Install pnpm
id: pnpm-install
with:
version: latest
run_install: false
- name: Get pnpm store directory
id: pnpm-cache
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
- uses: actions/cache@v3
name: Setup pnpm cache
with:
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Install dependencies
run: pnpm install
- name: Run test
run: pnpm test

38
Gruntfile.coffee Normal file
View File

@@ -0,0 +1,38 @@
"use strict"
module.exports = (grunt) ->
# Load all grunt tasks
require("matchdep").filterDev("grunt-*").forEach grunt.loadNpmTasks
# Project configurations
grunt.initConfig
config:
pkg: grunt.file.readJSON("package.json")
"npm-contributors":
options:
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
grunt.registerTask "default", "Default task aka. build task", (type) ->
grunt.task.run [
"npm-contributors"
"bump-only:#{type or 'patch'}"
"conventionalChangelog"
"bump-commit"
]

View File

@@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2023 Sparanoid, Inc. Copyright (c) 2018 Sparanoid, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

282
README.en-US.md Normal file
View File

@@ -0,0 +1,282 @@
# Chinese Copywriting Guidelines
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/chinese-copywriting-guidelines/localized.svg)](https://crowdin.com/project/chinese-copywriting-guidelines) [![Greenkeeper 徽章](https://badges.greenkeeper.io/sparanoid/chinese-copywriting-guidelines.svg)](https://greenkeeper.io/) [![devDependency 状态](https://david-dm.org/sparanoid/chinese-copywriting-guidelines/dev-status.svg)](https://david-dm.org/sparanoid/chinese-copywriting-guidelines#info=devDependencies) [![使用 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-US.md)
- [Chinese Traditional](README.md)
- [Chinese Simplifed](README.zh-CN.md)
- [Chinese Simplifed](https://github.com/mzlogin/chinese-copywriting-guidelines)(外部連結)
* * *
## Table of Contents
{:.no_toc}
- TOC {:toc}
## 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
正確:
> 今天出去買菜花了 5000 元。
錯誤:
> 今天出去買菜花了 5000元。
>
> 今天出去買菜花了5000元。
### Place one space between numbers and units
正確:
> 我家的光纖入屋寬頻有 10 GbpsSSD 一共有 20 TB。
錯誤:
> 我家的光纖入屋寬頻有 10GbpsSSD 一共有 20TB。
Exceptions: There should not be any spacing between numbers and degrees/percentages.
正確:
> 今天是 233° 的高溫。
>
> 新 MacBook Pro 有 15% 的 CPU 性能提升。
錯誤:
> 今天是 233 ° 的高溫。
>
> 新 MacBook Pro 有 15 % 的 CPU 性能提升。
### No additional spaces before/after punctuation in fullwidth form
正確:
> 剛剛買了一部 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`](http://msdn.microsoft.com/en-us/library/ie/ms531164(v=vs.85).aspx) 可以實現自動為中英文之間增加空白。不過目前並未普及,另外在其他應用場景,例如 macOS、iOS、Windows 等用戶介面目前并不存在這個特性,所以請繼續保持隨手加空格的習慣。
## Punctuation
### Avoid duplicate punctuation
正確:
> 德國隊竟然戰勝了巴西隊!
>
> 她竟然對你說「喵」?!
錯誤:
> 德國隊竟然戰勝了巴西隊!!
>
> 德國隊竟然戰勝了巴西隊!!!!!!!!
>
> 她竟然對你說「喵」??!!
>
> 她竟然對你說「喵」?!?!??!!
## Fullwidth and halfwidth
If youre not familiar with fullwidth and halfwidth forms please refer to [Halfwidth and fullwidth](http://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2) forms on Wikipedia.
### Use punctuation in fullwidth form
正確:
> 嗨!你知道嘛?今天前台的小妹跟我說「喵」了哎!
>
> 核磁共振成像NMRI是什麼原理都不知道JFGI
錯誤:
> 嗨! 你知道嘛? 今天前台的小妹跟我說 "喵" 了哎!
>
> 嗨!你知道嘛?今天前台的小妹跟我說"喵"了哎!
>
> 核磁共振成像 (NMRI) 是什麼原理都不知道? JFGI!
>
> 核磁共振成像(NMRI)是什麼原理都不知道?JFGI!
### Use numbers in halfwidth form
正確:
> 這件蛋糕只賣 1000 元。
錯誤:
> 這件蛋糕只賣 元。
Exceptions: fullwidth numbers are acceptable for better visual alignment in graphic design.
### Use punctuation in halfwidth form for English sentences
正確:
> 賈伯斯那句話是怎麼說的「Stay hungry, stay foolish.」
>
> 推薦你閱讀《Hackers & Painters: Big Ideas from the Computer Age》非常的有趣。
錯誤:
> 賈伯斯那句話是怎麼說的「Stay hungrystay foolish。」
>
> 推薦你閱讀《HackersPaintersBig Ideas from the Computer Age》非常的有趣。
## Nouns
### 專有名詞使用正確的大小寫
大小寫相關用法原屬於英文書寫範疇,不屬於本 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;` 對表現形式進行定義。
### Avoid jargons
正確:
> 我們需要一位熟悉 JavaScript、HTML5至少理解一种框架如 Backbone.js、AngularJS、React 等)的前端開發者。
錯誤:
> 我們需要一位熟悉 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 |
| [jxlwqq/chinese-typesetting](https://github.com/jxlwqq/chinese-typesetting) | 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 |
| [hustcc/hint](https://github.com/hustcc/hint) | Python |
## Examples of “Who is doing this?”
| 網站 | 文案 | UGC |
| ----------------------------------------------- | --- | ---- |
| [Apple 中國](http://www.apple.com/cn/) | Yes | N/A |
| [Apple 香港](http://www.apple.com/hk/) | Yes | N/A |
| [Apple 台灣](http://www.apple.com/tw/) | Yes | N/A |
| [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](https://leancloud.cn/) | Yes | N/A |
| [V2EX](https://www.v2ex.com/) | Yes | Yes |
| [Apple4us](http://apple4us.com/) | Yes | N/A |
| [Ruby China](https://ruby-china.org/) | Yes | 標題達成 |
| [PHPHub](https://phphub.org/) | Yes | 標題達成 |
| [少數派](http://sspai.com/) | Yes | N/A |
## 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)
- [全形和半形 - 維基百科](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms)
- [引號 - 維基百科](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,4 +1,6 @@
# Chinese Copywriting Guidelines # 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. Chinese copywriting guidelines for better written communication.
@@ -6,31 +8,54 @@ Other languages:
- [English](README.en.md) - [English](README.en.md)
- [Chinese Traditional](README.md) - [Chinese Traditional](README.md)
- [Chinese Simplified](README.zh-Hans.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 ## 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. 「有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。
>
> 與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js) 與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js)
### Place one space before/after English words ### Place one space before/after English words
Good: Good:
> 在 LeanCloud 上,數據存是圍繞 `AVObject` 進行的。 > 在 LeanCloud 上,數據存是圍繞 `AVObject` 進行的。
Bad: Bad:
> 在LeanCloud上數據存是圍繞`AVObject`進行的。 > 在LeanCloud上數據存是圍繞`AVObject`進行的。
>
> 在 LeanCloud上數據存是圍繞`AVObject` 進行的。 > 在 LeanCloud上數據存是圍繞`AVObject` 進行的。
An example of complete and correct usage: An example of complete and correct usage:
> 在 LeanCloud 上,數據儲存是圍繞 `AVObject` 行的。每 `AVObject` 都包含了 JSON 兼容的 key-value 對應的數據。數據是 schema-free 的,你不需要在每 `AVObject` 上提前指定存在哪些键,只要直接設定對應的 key-value 即可。 > 在 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”. Exceptions: For product and brand names, please refer to the writing format of the official definition. For example, use “豆瓣FM” instead of “豆瓣 FM”.
@@ -43,7 +68,7 @@ Good:
Bad: Bad:
> 今天出去買菜花了 5000元。 > 今天出去買菜花了 5000元。
>
> 今天出去買菜花了5000元。 > 今天出去買菜花了5000元。
### Place one space between numbers and units ### Place one space between numbers and units
@@ -60,14 +85,14 @@ Exceptions: There should not be any spacing between numbers and degrees/percenta
Good: Good:
> 角度為 90° 的角,就是直角 > 今天是 233° 的高溫
>
> 新 MacBook Pro 有 15% 的 CPU 性能提升。 > 新 MacBook Pro 有 15% 的 CPU 性能提升。
Bad: Bad:
> 角度為 90 ° 的角,就是直角 > 今天是 233 ° 的高溫
>
> 新 MacBook Pro 有 15 % 的 CPU 性能提升。 > 新 MacBook Pro 有 15 % 的 CPU 性能提升。
### No additional spaces before/after punctuation in fullwidth form ### No additional spaces before/after punctuation in fullwidth form
@@ -79,58 +104,54 @@ Good:
Bad: Bad:
> 剛剛買了一部 iPhone ,好開心! > 剛剛買了一部 iPhone ,好開心!
>
> 剛剛買了一部 iPhone 好開心! > 剛剛買了一部 iPhone 好開心!
### `text-spacing` to the rescue? ### `-ms-text-autospace` 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. 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 ## Punctuation
### Avoid duplicate 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: Good:
> 德國隊竟然戰勝了巴西隊! > 德國隊竟然戰勝了巴西隊!
>
> 她竟然對你說「喵」?! > 她竟然對你說「喵」?!
Bad: Bad:
> 德國隊竟然戰勝了巴西隊!! > 德國隊竟然戰勝了巴西隊!!
>
> 德國隊竟然戰勝了巴西隊!!!!!!!! > 德國隊竟然戰勝了巴西隊!!!!!!!!
>
> 她竟然對你說「喵」??!! > 她竟然對你說「喵」??!!
>
> 她竟然對你說「喵」?!?!??!! > 她竟然對你說「喵」?!?!??!!
## Fullwidth and halfwidth ## 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. 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 ### Use punctuation in fullwidth form
Good: Good:
> 嗨!你知道嘛?今天前台的小妹跟我說「喵」了哎! > 嗨!你知道嘛?今天前台的小妹跟我說「喵」了哎!
>
> 核磁共振成像NMRI是什麼原理都不知道JFGI > 核磁共振成像NMRI是什麼原理都不知道JFGI
Bad: Bad:
> 嗨! 你知道嘛? 今天前台的小妹跟我說 "喵" 了哎! > 嗨! 你知道嘛? 今天前台的小妹跟我說 "喵" 了哎!
>
> 嗨!你知道嘛?今天前台的小妹跟我說"喵"了哎!
>
> 核磁共振成像 (NMRI) 是什麼原理都不知道? JFGI!
>
> 核磁共振成像(NMRI)是什麼原理都不知道?JFGI!
Exception: inline English titles of books and journals with italics, instead of fullwidth title marks. > 嗨!你知道嘛?今天前台的小妹跟我說"喵"了哎!
> 核磁共振成像 (NMRI) 是什麼原理都不知道? JFGI!
> 核磁共振成像(NMRI)是什麼原理都不知道?JFGI!
### Use numbers in halfwidth form ### Use numbers in halfwidth form
@@ -149,77 +170,43 @@ Exceptions: fullwidth numbers are acceptable for better visual alignment in grap
Good: Good:
> 賈伯斯那句話是怎麼說的「Stay hungry, stay foolish.」 > 賈伯斯那句話是怎麼說的「Stay hungry, stay foolish.」
>
> 推薦你閱讀 *Hackers & Painters: Big Ideas from the Computer Age*,非常有趣。 > 推薦你閱讀Hackers & Painters: Big Ideas from the Computer Age,非常有趣。
Bad: Bad:
> 賈伯斯那句話是怎麼說的「Stay hungrystay foolish。」 > 賈伯斯那句話是怎麼說的「Stay hungrystay foolish。」
>
> 推薦你閱讀《HackersPaintersBig Ideas from the Computer Age》非常的有趣。 > 推薦你閱讀《HackersPaintersBig Ideas from the Computer Age》非常的有趣。
## Nouns ## 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 ### Avoid jargons
Good: Good:
> 我們需要一位熟悉 TypeScript、HTML5至少理解一框架(如 React、Next.js)的前端開發者。 > 我們需要一位熟悉 JavaScript、HTML5至少理解一框架(如 Backbone.js、AngularJS、React 等)的前端開發者。
Bad: Bad:
> 我們需要一位熟悉 Ts、h5至少理解一框架(如 RJS、nextjs)的 FED。 > 我們需要一位熟悉 Js、h5至少理解一框架(如 backbone、angular、RJS 等)的 FED。
## Dispute ## 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. 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 ### Add extra spaces before/after links
Usage: Usage:
> [提交一个 issue](#) 分配给相同事。 > [提交一个 issue](#) 分配给相同事。
>
> 訪問我們網站的最新動態,請 [點擊這裡](#) 進行訂閱! > 訪問我們網站的最新動態,請 [點擊這裡](#) 進行訂閱!
compared with: compared with:
> [提交一个 issue](#) 分配给相同事。 > [提交一个 issue](#) 分配给相同事。
>
> 訪問我們網站的最新動態,請[點擊這裡](#)進行訂閱! > 訪問我們網站的最新動態,請[點擊這裡](#)進行訂閱!
### Use corner brackets for Chinese Simplified ### Use corner brackets for Chinese Simplified
@@ -234,63 +221,44 @@ compared with:
## Tools ## Tools
Repository | Category | Language Repository | Language
---------- | -------- | -------- --- | ---
[pangu.js](https://github.com/vinta/pangu.js) | pangu | JavaScript [vinta/paranoid-auto-spacing](https://github.com/vinta/paranoid-auto-spacing) | JavaScript
[pangu-go](https://github.com/vinta/pangu) | pangu | Go [huei90/pangu.node](https://github.com/huei90/pangu.node) | Node.js
[pangu.java](https://github.com/vinta/pangu.java) | pangu | Java [huacnlee/auto-correct](https://github.com/huacnlee/auto-correct) | Ruby
[pangu.py](https://github.com/vinta/pangu.py) | pangu | Python [sparanoid/space-lover](https://github.com/sparanoid/space-lover) | PHP (WordPress)
[pangu.rb](https://github.com/dlackty/pangu.rb) | pangu | Ruby [nauxliu/auto-correct](https://github.com/NauxLiu/auto-correct) | PHP
[pangu.php](https://github.com/cchlorine/pangu.php) | pangu | PHP [hotoo/pangu.vim](https://github.com/hotoo/pangu.vim) | Vim
[pangu.vim](https://github.com/hotoo/pangu.vim) | pangu | Vim [sparanoid/grunt-auto-spacing](https://github.com/sparanoid/grunt-auto-spacing) | Node.js (Grunt)
[vue-pangu](https://github.com/serkodev/vue-pangu) | pangu | Vue.js (Web Converter) [hjiang/scripts/add-space-between-latin-and-cjk](https://github.com/hjiang/scripts/blob/master/add-space-between-latin-and-cjk) | Python
[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?” ## Examples of “Who is doing this?”
Website | Copywriting | UGC Website | Copywriting | UGC
------- | ----------- | --- --- | --- | ---
[Apple China](https://www.apple.com/cn/) | Yes | N/A [Apple China](http://www.apple.com/cn/) | Yes | N/A
[Apple Hong Kong](https://www.apple.com/hk/) | Yes | N/A [Apple Hong Kong](http://www.apple.com/hk/) | Yes | N/A
[Apple Taiwan](https://www.apple.com/tw/) | Yes | N/A [Apple Taiwan](http://www.apple.com/tw/) | Yes | N/A
[Microsoft China](https://www.microsoft.com/zh-cn/) | Yes | N/A [Microsoft China](http://www.microsoft.com/zh-cn/) | Yes | N/A
[Microsoft Hong Kong](https://www.microsoft.com/zh-hk/) | Yes | N/A [Microsoft Hong Kong](http://www.microsoft.com/zh-hk/) | Yes | N/A
[Microsoft Taiwan](https://www.microsoft.com/zh-tw/) | Yes | N/A [Microsoft Taiwan](http://www.microsoft.com/zh-tw/) | Yes | N/A
[LeanCloud](https://leancloud.cn/) | Yes | N/A [LeanCloud](https://leancloud.cn/) | Yes | N/A
[Zhihu](https://www.zhihu.com/) | Yes | Partial
[V2EX](https://www.v2ex.com/) | Yes | Yes [V2EX](https://www.v2ex.com/) | Yes | Yes
[Apple4us](https://apple4us.com/) | Yes | N/A [SegmentFault](https://segmentfault.com/) | Yes | Partial
[Ruby China](https://ruby-china.org/) | Yes | Yes [Apple4us](http://apple4us.com/) | Yes | N/A
[少數派](https://sspai.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 ## References
- [Guidelines for Using Capital Letters - ThoughtCo.](https://www.thoughtco.com/guidelines-for-using-capital-letters-1691724) - [Guidelines for Using Capital Letters - About.com](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm)
- [Letter case - Wikipedia](https://en.wikipedia.org/wiki/Letter_case) - [Letter case - Wikipedia](http://en.wikipedia.org/wiki/Letter_case)
- [Punctuation - Oxford Dictionaries](https://en.oxforddictionaries.com/grammar/punctuation) - [Punctuation - Oxford Dictionaries](http://www.oxforddictionaries.com/words/punctuation)
- [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/) - [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) - [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) - [格式 - 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) - [全形和半形 - 維基百科](http://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) - [引號 - 維基百科](http://zh.wikipedia.org/wiki/%E5%BC%95%E8%99%9F)
- [Interrobang - Wikipedia](https://en.wikipedia.org/wiki/Interrobang) - [疑問驚嘆號 - 維基百科](http://zh.wikipedia.org/wiki/%E7%96%91%E5%95%8F%E9%A9%9A%E5%98%86%E8%99%9F)
## Forks
The usage of forked projects may differ from this project.
- [mzlogin/chinese-copywriting-guidelines](https://github.com/mzlogin/chinese-copywriting-guidelines)

134
README.md
View File

@@ -1,39 +1,48 @@
# 中文文案排版指北 # 中文文案排版指北
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/chinese-copywriting-guidelines/localized.svg)](https://crowdin.com/project/chinese-copywriting-guidelines) [![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/) [![Greenkeeper badge](https://badges.greenkeeper.io/sparanoid/chinese-copywriting-guidelines.svg)](https://greenkeeper.io/)
[![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: Other languages:
- [English](README.en.md) - [English](README.en-US.md)
- [Chinese Traditional](README.md) - [Chinese Traditional](README.md)
- [Chinese Simplified](README.zh-Hans.md) - [Chinese Simplifed](README.zh-CN.md)
- [Chinese Simplifed](https://github.com/mzlogin/chinese-copywriting-guidelines)(外部連結)
----- -----
## 目次
{:.no_toc}
* TOC
{:toc}
## 空格 ## 空格
> 「有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。 「有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。
>
> 與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js) 與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js)
### 中英文之間需要增加空格 ### 中英文之間需要增加空格
正確: 正確:
> 在 LeanCloud 上,數據存是圍繞 `AVObject` 進行的。 > 在 LeanCloud 上,數據存是圍繞 `AVObject` 進行的。
錯誤: 錯誤:
> 在LeanCloud上數據存是圍繞`AVObject`進行的。 > 在LeanCloud上數據存是圍繞`AVObject`進行的。
> 在 LeanCloud上數據存是圍繞`AVObject` 進行的。 > 在 LeanCloud上數據存是圍繞`AVObject` 進行的。
完整的正確用法: 完整的正確用法:
> 在 LeanCloud 上,數據儲存是圍繞 `AVObject` 行的。每 `AVObject` 都包含了 JSON 兼容的 key-value 對應的數據。數據是 schema-free 的,你不需要在每 `AVObject` 上提前指定存在哪些键,只要直接設定對應的 key-value 即可。 > 在 LeanCloud 上,数据存储是围绕 `AVObject` 行的。每 `AVObject` 都包含了 JSON 兼容的 key-value 对应的数据。数据是 schema-free 的,你不需要在每 `AVObject` 上提前指定存在哪些键,只要直接设定对应的 key-value 即可。
例外「豆瓣FM」等產品名詞按照官方所定義的格式書寫。 例外「豆瓣FM」等產品名詞按照官方所定義的格式書寫。
@@ -59,17 +68,17 @@ Other languages:
> 我家的光纖入屋寬頻有 10GbpsSSD 一共有 20TB。 > 我家的光纖入屋寬頻有 10GbpsSSD 一共有 20TB。
例外:度/百分比與數字之間不需要增加空格: 例外:度/百分比與數字之間不需要增加空格:
正確: 正確:
> 角度為 90° 的角,就是直角 > 今天是 233° 的高溫
> 新 MacBook Pro 有 15% 的 CPU 性能提升。 > 新 MacBook Pro 有 15% 的 CPU 性能提升。
錯誤: 錯誤:
> 角度為 90 ° 的角,就是直角 > 今天是 233 ° 的高溫
> 新 MacBook Pro 有 15 % 的 CPU 性能提升。 > 新 MacBook Pro 有 15 % 的 CPU 性能提升。
@@ -87,14 +96,12 @@ Other languages:
### `text-spacing` to the rescue? ### `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 等用戶介面目前不存在這個特性,所以請繼續保持隨手加空格的習慣。 CSS Text Module Level 4 的 [`text-spacing`](https://www.w3.org/TR/css-text-4/#text-spacing-property) 和 Microsoft 的 [`-ms-text-autospace`](http://msdn.microsoft.com/en-us/library/ie/ms531164(v=vs.85).aspx) 可以實現自動為中英文之間增加空白。不過目前並未普及,另外在其他應用場景,例如 macOS、iOS、Windows 等用戶介面目前不存在這個特性,所以請繼續保持隨手加空格的習慣。
## 標點符號 ## 標點符號
### 不重複使用標點符號 ### 不重複使用標點符號
雖然中國大陸的標點符號用法允許重複使用標點符號,但是這麼做會破壞句子的美觀性。
正確: 正確:
> 德國隊竟然戰勝了巴西隊! > 德國隊竟然戰勝了巴西隊!
@@ -113,7 +120,7 @@ CSS Text Module Level 4 的 [`text-spacing`](https://www.w3.org/TR/css-text-4/#t
## 全形和半形 ## 全形和半形
不明白什麼是全形(全角)與半形(半角)符號?請查看維基百科條『[全形和半形](https://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)』。
### 使用全形中文標點 ### 使用全形中文標點
@@ -133,8 +140,6 @@ CSS Text Module Level 4 的 [`text-spacing`](https://www.w3.org/TR/css-text-4/#t
> 核磁共振成像(NMRI)是什麼原理都不知道?JFGI! > 核磁共振成像(NMRI)是什麼原理都不知道?JFGI!
例外:中文句子內夾有英文書籍名、報刊名時,不應借用中文書名號,應以英文斜體表示。
### 數字使用半形字符 ### 數字使用半形字符
正確: 正確:
@@ -153,7 +158,7 @@ CSS Text Module Level 4 的 [`text-spacing`](https://www.w3.org/TR/css-text-4/#t
> 賈伯斯那句話是怎麼說的「Stay hungry, stay foolish.」 > 賈伯斯那句話是怎麼說的「Stay hungry, stay foolish.」
> 推薦你閱讀 *Hackers & Painters: Big Ideas from the Computer Age*,非常有趣。 > 推薦你閱讀Hackers & Painters: Big Ideas from the Computer Age,非常有趣。
錯誤: 錯誤:
@@ -197,31 +202,31 @@ CSS Text Module Level 4 的 [`text-spacing`](https://www.w3.org/TR/css-text-4/#t
注意當網頁中需要配合整體視覺風格而出現全部大寫小寫的情形HTML 中請使用標準的大小寫規範進行書寫;並通過 `text-transform: uppercase;``text-transform: lowercase;` 對表現形式進行定義。 注意當網頁中需要配合整體視覺風格而出現全部大寫小寫的情形HTML 中請使用標準的大小寫規範進行書寫;並通過 `text-transform: uppercase;``text-transform: lowercase;` 對表現形式進行定義。
### 不要使用不地的縮寫 ### 不要使用不地的縮寫
正確: 正確:
> 我們需要一位熟悉 TypeScript、HTML5至少理解一框架(如 React、Next.js)的前端開發者。 > 我們需要一位熟悉 JavaScript、HTML5至少理解一框架(如 Backbone.js、AngularJS、React 等)的前端開發者。
錯誤: 錯誤:
> 我們需要一位熟悉 Ts、h5至少理解一框架(如 RJS、nextjs)的 FED。 > 我們需要一位熟悉 Js、h5至少理解一框架(如 backbone、angular、RJS 等)的 FED。
## 爭議 ## 爭議
以下用法略帶有個人色彩,即:無論是否遵循下述規則,從語法的角度來講都是**正確**的。 以下用法略帶有個人色彩,即:無論是否遵循下述規則,從語法的角度來講都是**正確**的。
### 超連結之間增加空格 ### 鏈接之間增加空格
用法: 用法:
> [提交一 issue](#) 分配给相同事。 > [提交一 issue](#) 分配给相同事。
> 訪問我們網站的最新動態,請 [點擊這裡](#) 進行訂閱! > 訪問我們網站的最新動態,請 [點擊這裡](#) 進行訂閱!
對比用法: 對比用法:
> [提交一 issue](#) 分配给相同事。 > [提交一 issue](#) 分配给相同事。
> 訪問我們網站的最新動態,請[點擊這裡](#)進行訂閱! > 訪問我們網站的最新動態,請[點擊這裡](#)進行訂閱!
@@ -237,63 +242,44 @@ CSS Text Module Level 4 的 [`text-spacing`](https://www.w3.org/TR/css-text-4/#t
## 工具 ## 工具
倉庫 | 系列 | 語言 倉庫 | 語言
--- | -- | --- --- | ---
[pangu.js](https://github.com/vinta/pangu.js) | pangu | JavaScript [vinta/paranoid-auto-spacing](https://github.com/vinta/paranoid-auto-spacing) | JavaScript
[pangu-go](https://github.com/vinta/pangu) | pangu | Go [huei90/pangu.node](https://github.com/huei90/pangu.node) | Node.js
[pangu.java](https://github.com/vinta/pangu.java) | pangu | Java [huacnlee/auto-correct](https://github.com/huacnlee/auto-correct) | Ruby
[pangu.py](https://github.com/vinta/pangu.py) | pangu | Python [sparanoid/space-lover](https://github.com/sparanoid/space-lover) | PHP (WordPress)
[pangu.rb](https://github.com/dlackty/pangu.rb) | pangu | Ruby [nauxliu/auto-correct](https://github.com/NauxLiu/auto-correct) | PHP
[pangu.php](https://github.com/cchlorine/pangu.php) | pangu | PHP [jxlwqq/chinese-typesetting](https://github.com/jxlwqq/chinese-typesetting) | PHP
[pangu.vim](https://github.com/hotoo/pangu.vim) | pangu | Vim [hotoo/pangu.vim](https://github.com/hotoo/pangu.vim) | Vim
[vue-pangu](https://github.com/serkodev/vue-pangu) | pangu | Vue.js (Web Converter) [sparanoid/grunt-auto-spacing](https://github.com/sparanoid/grunt-auto-spacing) | Node.js (Grunt)
[intellij-pangu](https://plugins.jetbrains.com/plugin/19665-pangu) | pangu | Intellij Platform Plugin [hjiang/scripts/add-space-between-latin-and-cjk](https://github.com/hjiang/scripts/blob/master/add-space-between-latin-and-cjk) | Python
[autocorrect](https://github.com/huacnlee/autocorrect) | autocorrect | Rust, WASM, CLI tool [hustcc/hint](https://github.com/hustcc/hint) | Python
[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 網站 | 文案 | UGC
--- | --- | --- --- | --- | ---
[Apple 中國](https://www.apple.com/cn/) | Yes | N/A [Apple 中國](http://www.apple.com/cn/) | Yes | N/A
[Apple 香港](https://www.apple.com/hk/) | Yes | N/A [Apple 香港](http://www.apple.com/hk/) | Yes | N/A
[Apple 台灣](https://www.apple.com/tw/) | Yes | N/A [Apple 台灣](http://www.apple.com/tw/) | Yes | N/A
[Microsoft 中國](https://www.microsoft.com/zh-cn/) | Yes | N/A [Microsoft 中國](http://www.microsoft.com/zh-cn/) | Yes | N/A
[Microsoft 香港](https://www.microsoft.com/zh-hk/) | Yes | N/A [Microsoft 香港](http://www.microsoft.com/zh-hk/) | Yes | N/A
[Microsoft 台灣](https://www.microsoft.com/zh-tw/) | Yes | N/A [Microsoft 台灣](http://www.microsoft.com/zh-tw/) | Yes | N/A
[LeanCloud](https://leancloud.cn/) | Yes | N/A [LeanCloud](https://leancloud.cn/) | Yes | N/A
[V2EX](https://www.v2ex.com/) | Yes | Yes [V2EX](https://www.v2ex.com/) | Yes | Yes
[Apple4us](https://apple4us.com/) | Yes | N/A [Apple4us](http://apple4us.com/) | Yes | N/A
[Ruby China](https://ruby-china.org/) | Yes | Yes [Ruby China](https://ruby-china.org/) | Yes | 標題達成
[少數派](https://sspai.com/) | Yes | N/A [PHPHub](https://phphub.org/) | Yes | 標題達成
[少數派](http://sspai.com/) | Yes | N/A
## 參考文獻 ## 參考文獻
- [Guidelines for Using Capital Letters - ThoughtCo.](https://www.thoughtco.com/guidelines-for-using-capital-letters-1691724) - [Guidelines for Using Capital Letters - About.com](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm)
- [Letter case - Wikipedia](https://en.wikipedia.org/wiki/Letter_case) - [Letter case - Wikipedia](http://en.wikipedia.org/wiki/Letter_case)
- [Punctuation - Oxford Dictionaries](https://en.oxforddictionaries.com/grammar/punctuation) - [Punctuation - Oxford Dictionaries](http://www.oxforddictionaries.com/words/punctuation)
- [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/) - [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) - [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) - [格式 - 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) - [全形和半形 - 維基百科](http://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) - [引號 - 維基百科](http://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) - [疑問驚嘆號 - 維基百科](http://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)

282
README.zh-CN.md Normal file
View File

@@ -0,0 +1,282 @@
# 中文文案排版指北
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/chinese-copywriting-guidelines/localized.svg)](https://crowdin.com/project/chinese-copywriting-guidelines) [![Greenkeeper badge](https://badges.greenkeeper.io/sparanoid/chinese-copywriting-guidelines.svg)](https://greenkeeper.io/) [![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/)
统一中文文案、排版的相关用法,降低团队成员之间的沟通成本,增强网站气质。
其他语言:
- [英语](README.en-US.md)
- [繁体中文](README.md)
- [简体中文](README.zh-CN.md)
- [简体中文](https://github.com/mzlogin/chinese-copywriting-guidelines)(外部链接)
* * *
## 目录
{:.no_toc}
- TOC {:toc}
## 空格
「有研究显示,打字的时候不喜欢在中文和英文之间加空格的人,感情路都走得很辛苦,有七成的比例会在 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
例外:度 / 百分比与数字之间不需要增加空格:
正确:
> 今天是 233° 的高温。
>
> 新 MacBook Pro 有 15% 的 CPU 性能提升。
错误:
> 今天是 233 ° 的高温。
>
> 新 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`](http://msdn.microsoft.com/en-us/library/ie/ms531164(v=vs.85).aspx) 可以实现自动为中英文之间增加空白。不过目前并未普及,另外在其他应用场景,例如 macOS、iOS、Windows 等用户介面目前并不存在这个特性,所以请继续保持随手加空格的习惯。
## 标点符号
### 不重复使用标点符号
正确:
> 德国队竟然战胜了巴西队!
>
> 她竟然对你说「喵」?!
错误:
> 德国队竟然战胜了巴西队!!
>
> 德国队竟然战胜了巴西队!!!!!!!!
>
> 她竟然对你说「喵」??!!
>
> 她竟然对你说「喵」?!?!??!!
## 全角和半角
不明白什么是全角(全形)与半角(半形)符号?请查看维基百科词条『[全形和半形](http://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;` 对表现形式进行定义。
### 不要使用不地道的缩写
正确:
> 我们需要一位熟悉 JavaScript、HTML5至少理解一种框架如 Backbone.js、AngularJS、React 等)的前端开发者。
错误:
> 我们需要一位熟悉 Js、h5至少理解一种框架如 backbone、angular、RJS 等)的 FED。
## 争议
以下用法略带有个人色彩,即:无论是否遵循下述规则,从语法的角度来讲都是**正确**的。
### 链接之间增加空格
用法:
> 请 [提交一个 issue](#) 并分配给相关同事。
>
> 访问我们网站的最新动态,请 [点击这里](#) 进行订阅!
对比用法:
> 请[提交一个 issue](#)并分配给相关同事。
>
> 访问我们网站的最新动态,请[点击这里](#)进行订阅!
### 简体中文使用直角引号
用法:
> 「老师,『有条不紊』的『紊』是什么意思?」
对比用法:
> “老师,‘有条不紊’的‘紊’是什么意思?”
## 工具
| 仓库 | 语言 |
| ------------------------------------------------------------------------------------------------------------------------------- | --------------- |
| [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 |
| [jxlwqq/chinese-typesetting](https://github.com/jxlwqq/chinese-typesetting) | 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 |
| [hustcc/hint](https://github.com/hustcc/hint) | Python |
## 谁在这样做?
| 网站 | 文案 | UGC |
| ----------------------------------------------- | -- | ---- |
| [Apple 中国](http://www.apple.com/cn/) | 是 | N/A |
| [Apple 香港](http://www.apple.com/hk/) | 是 | N/A |
| [Apple 台湾](http://www.apple.com/tw/) | 是 | N/A |
| [Microsoft 中国](http://www.microsoft.com/zh-cn/) | 是 | N/A |
| [Microsoft 香港](http://www.microsoft.com/zh-hk/) | 是 | N/A |
| [Microsoft 台湾](http://www.microsoft.com/zh-tw/) | 是 | N/A |
| [LeanCloud](https://leancloud.cn/) | 是 | N/A |
| [V2EX](https://www.v2ex.com/) | 是 | 是 |
| [Apple4us](http://apple4us.com/) | 是 | N/A |
| [Ruby China](https://ruby-china.org/) | 是 | 标题达成 |
| [PHPHub](https://phphub.org/) | 是 | 标题达成 |
| [少数派](http://sspai.com/) | 是 | N/A |
## 参考文献
- [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)

282
README.zh-HK.md Normal file
View File

@@ -0,0 +1,282 @@
# 中文文案排版指北
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/chinese-copywriting-guidelines/localized.svg)](https://crowdin.com/project/chinese-copywriting-guidelines) [![Greenkeeper badge](https://badges.greenkeeper.io/sparanoid/chinese-copywriting-guidelines.svg)](https://greenkeeper.io/) [![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-US.md)
- [Chinese Traditional](README.md)
- [Chinese Simplifed](README.zh-CN.md)
- [Chinese Simplifed](https://github.com/mzlogin/chinese-copywriting-guidelines)(外部連結)
* * *
## 目次
{:.no_toc}
- TOC {:toc}
## 空格
「有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 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。
例外:度/百分比與數字之間不需要增加空格:
正確:
> 今天是 233° 的高溫。
>
> 新 MacBook Pro 有 15% 的 CPU 性能提升。
錯誤:
> 今天是 233 ° 的高溫。
>
> 新 MacBook Pro 有 15 % 的 CPU 性能提升。
### 全形標點與其他字符之間不加空格
正確:
> 剛剛買了一部 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`](http://msdn.microsoft.com/en-us/library/ie/ms531164(v=vs.85).aspx) 可以實現自動為中英文之間增加空白。不過目前並未普及,另外在其他應用場景,例如 macOS、iOS、Windows 等用戶介面目前并不存在這個特性,所以請繼續保持隨手加空格的習慣。
## 標點符號
### 不重複使用標點符號
正確:
> 德國隊竟然戰勝了巴西隊!
>
> 她竟然對你說「喵」?!
錯誤:
> 德國隊竟然戰勝了巴西隊!!
>
> 德國隊竟然戰勝了巴西隊!!!!!!!!
>
> 她竟然對你說「喵」??!!
>
> 她竟然對你說「喵」?!?!??!!
## 全形和半形
不明白什麼是全形(全角)與半形(半角)符號?請查看維基百科詞條『[全形和半形](http://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;` 對表現形式進行定義。
### 不要使用不地道的縮寫
正確:
> 我們需要一位熟悉 JavaScript、HTML5至少理解一种框架如 Backbone.js、AngularJS、React 等)的前端開發者。
錯誤:
> 我們需要一位熟悉 Js、h5至少理解一种框架如 backbone、angular、RJS 等)的 FED。
## 爭議
以下用法略帶有個人色彩,即:無論是否遵循下述規則,從語法的角度來講都是**正確**的。
### 鏈接之間增加空格
用法:
> 请 [提交一个 issue](#) 并分配给相关同事。
>
> 訪問我們網站的最新動態,請 [點擊這裡](#) 進行訂閱!
對比用法:
> 请[提交一个 issue](#) 并分配给相关同事。
>
> 訪問我們網站的最新動態,請[點擊這裡](#)進行訂閱!
### 簡體中文使用直角引號
用法:
> 「老师,『有条不紊』的『紊』是什么意思?」
對比用法:
> “老师,‘有条不紊’的‘紊’是什么意思?”
## 工具
| 倉庫 | 語言 |
| ------------------------------------------------------------------------------------------------------------------------------- | --------------- |
| [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 |
| [jxlwqq/chinese-typesetting](https://github.com/jxlwqq/chinese-typesetting) | 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 |
| [hustcc/hint](https://github.com/hustcc/hint) | Python |
## 誰在這樣做?
| 網站 | 文案 | UGC |
| ----------------------------------------------- | --- | ---- |
| [Apple 中國](http://www.apple.com/cn/) | Yes | N/A |
| [Apple 香港](http://www.apple.com/hk/) | Yes | N/A |
| [Apple 台灣](http://www.apple.com/tw/) | Yes | N/A |
| [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](https://leancloud.cn/) | Yes | N/A |
| [V2EX](https://www.v2ex.com/) | Yes | Yes |
| [Apple4us](http://apple4us.com/) | Yes | N/A |
| [Ruby China](https://ruby-china.org/) | Yes | 標題達成 |
| [PHPHub](https://phphub.org/) | Yes | 標題達成 |
| [少數派](http://sspai.com/) | Yes | N/A |
## 參考文獻
- [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,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)

3321
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -1,32 +1,21 @@
{ {
"name": "chinese-copywriting-guidelines", "name": "chinese-copywriting-guidelines",
"version": "1.0.1", "version": "0.1.0",
"description": "Chinese Copywriting Guidelines", "description": "Chinese Copywriting Guidelines",
"author": "Tunghsiao Liu", "author": "Tunghsiao Liu",
"homepage": "http://github.com/sparanoid/chinese-copywriting-guidelines", "homepage": "http://github.com/sparanoid/chinese-copywriting-guidelines",
"main": "README.md", "main": "README.md",
"scripts": { "scripts": {
"test": "remark .", "test": "grunt"
"release": "npx release-it"
},
"remarkConfig": {
"plugins": [
"remark-preset-lint-consistent",
"remark-preset-lint-recommended",
[
"remark-lint-list-item-indent",
"space"
]
]
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/sparanoid/chinese-copywriting-guidelines.git" "url": "git://github.com/sparanoid/chinese-copywriting-guidelines.git"
}, },
"bugs": { "bugs": {
"url": "https://github.com/sparanoid/chinese-copywriting-guidelines/issues" "url": "http://github.com/sparanoid/chinese-copywriting-guidelines/issues"
}, },
"license": "MIT", "license": "WTFPL",
"keywords": [ "keywords": [
"chinese", "chinese",
"copywriting", "copywriting",
@@ -34,23 +23,28 @@
], ],
"readmeFilename": "README.md", "readmeFilename": "README.md",
"devDependencies": { "devDependencies": {
"remark-cli": "^11.0.0", "grunt": "^1.0.4",
"remark-lint-list-item-indent": "^3.1.1", "grunt-bump": "^0.8.0",
"remark-preset-lint-consistent": "^5.1.1", "grunt-conventional-changelog": "^6.1.0",
"remark-preset-lint-recommended": "^6.1.2" "grunt-npm": "0.0.2",
"matchdep": "^2.0.0"
}, },
"release-it": { "contributors": [
"git": { "greenkeeperio-bot <support@greenkeeper.io>",
"commitArgs": "-S", "Zhuang Ma <chumpma@gmail.com>",
"commitMessage": "chore: release v${version}", "Jason Lee <huacnlee@gmail.com>",
"tagArgs": "-s", "Greenkeeper <support@greenkeeper.io>",
"tagAnnotation": "chore: release v${version}" "greenkeeper[bot] <greenkeeper[bot]@users.noreply.github.com>",
}, "huhuhang <huhuhang@users.noreply.github.com>",
"github": { "jxlwqq <jxlwqq@gmail.com>",
"release": true "pityonline <pityonline@gmail.com>",
}, "tzx <district10@users.noreply.github.com>",
"npm": { "NauxLiu@users.noreply.github.com>",
"publish": false "Charlie Jade <summer.alex07@gmail.com>",
} "hotoo@users.noreply.github.com>",
} "Elethom Hunter <elethomhunter@gmail.com>",
"Huei Tan <huei90@users.noreply.github.com>",
"Yang Li <idealhack@gmail.com>",
"ddanist <danx2ist@gmail.com>"
]
} }

1685
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

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