Skip to content

排版指南

Lingfeng_Ai edited this page Jul 1, 2018 · 3 revisions

目录

1. 格式

  1. 译文提交请保持一段英文,一段中文的形式。
  2. 使用 Markdown 进行排版。标题级别,有序或无序列表的格式,不必与原文完全保持一致,但是逻辑关系要一致。
  3. 如原文中使用的排版格式无法用 Markdown 表现,可以使用截图的方式
  4. 鼓励译者添加译注,但注意不要有太强但主观意志,译注需要用括号扩起来
  5. 行内代码,指令,语句,运算等请使用行内代码语法
  6. 关键字,强调等内容请使用加粗
  7. 英文专有名词,包括书名、品牌等,如无专有中文商标或译本,则无需翻译。
  8. 领域内常用的英文单词,视中英文使用频度情况选择翻译或不翻译。如果确定要翻译,在第一次翻译时,需要加括号保留原文(socket 不翻译、 API 不翻译、struct 翻译、hash 翻译)
  9. 中英标点符号不要混用,具体用法参见:标点符号用法

2. 图片处理

  1. 图片的内容无需翻译
  2. 直接使用原文图片链接,使用 markdwon 语法(![](http://xxxxx.jpg))插入到文章中。
  3. 额外的截图,需要在文章同级目录下创建img文件夹,图片的命名格式为pic_#<issue_number>_<图片序号>

3. 交互动画及视频

  1. 如果有链接,则保留链接。
  2. 如果无链接,可以截图示意关键内容,并加以说明

4. 文本排版规范

为方便阅读,以下内容节选自:中文文案排版指北

空格

「有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。與大家共勉之。」——vinta/paranoid-auto-spacing

中英文之間需要增加空格

正確:

在 LeanCloud 上,數據存儲是圍繞 AVObject 進行的。

錯誤:

在LeanCloud上,數據存儲是圍繞AVObject進行的。

在 LeanCloud上,數據存儲是圍繞AVObject 進行的。

完整的正確用法:

在 LeanCloud 上,数据存储是围绕 AVObject 进行的。每个 AVObject 都包含了与 JSON 兼容的 key-value 对应的数据。数据是 schema-free 的,你不需要在每个 AVObject 上提前指定存在哪些键,只要直接设定对应的 key-value 即可。

例外:「豆瓣FM」等產品名詞,按照官方所定義的格式書寫。

中文與數字之間需要增加空格

正確:

今天出去買菜花了 5000 元。

錯誤:

今天出去買菜花了 5000元。

今天出去買菜花了5000元。

數字與單位之間需要增加空格

正確:

我家的光纖入屋寬頻有 10 Gbps,SSD 一共有 20 TB。

錯誤:

我家的光纖入屋寬頻有 10Gbps,SSD 一共有 20TB。

例外:度/百分比與數字之間不需要增加空格:

正確:

今天是 233° 的高溫。

新 MacBook Pro 有 15% 的 CPU 性能提升。

錯誤:

今天是 233 ° 的高溫。

新 MacBook Pro 有 15 % 的 CPU 性能提升。

全形標點與其他字符之間不加空格

正確:

剛剛買了一部 iPhone,好開心!

錯誤:

剛剛買了一部 iPhone ,好開心!

標點符號

不重複使用標點符號

正確:

德國隊竟然戰勝了巴西隊!

她竟然對你說「喵」?!

錯誤:

德國隊竟然戰勝了巴西隊!!

德國隊竟然戰勝了巴西隊!!!!!!!!

她竟然對你說「喵」??!!

她竟然對你說「喵」?!?!??!!

全形和半形

不明白什麼是全形(全角)與半形(半角)符號?請查看維基百科詞條『全形和半形』。

使用全形中文標點

正確:

嗨!你知道嘛?今天前台的小妹跟我說「喵」了哎!

核磁共振成像(NMRI)是什麼原理都不知道?JFGI!

錯誤:

嗨! 你知道嘛? 今天前台的小妹跟我說 "喵" 了哎!

嗨!你知道嘛?今天前台的小妹跟我說"喵"了哎!

核磁共振成像 (NMRI) 是什麼原理都不知道? JFGI!

核磁共振成像(NMRI)是什麼原理都不知道?JFGI!

數字使用半形字符

正確:

這件蛋糕只賣 1000 元。

錯誤:

這件蛋糕只賣 1000 元。

例外:在設計稿、宣傳海報中如出現極少量數字的情形時,為方便文字對齊,是可以使用全形數字的。

遇到完整的英文整句、特殊名詞,其內容使用半形標點

正確:

賈伯斯那句話是怎麼說的?「Stay hungry, stay foolish.」

推薦你閱讀《Hackers & Painters: Big Ideas from the Computer Age》,非常的有趣。

錯誤:

賈伯斯那句話是怎麼說的?「Stay hungry,stay foolish。」

推薦你閱讀《Hackers&Painters:Big 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 并分配给相关同事。

訪問我們網站的最新動態,請點擊這裡進行訂閱!

簡體中文使用直角引號

用法:

「老师,『有条不紊』的『紊』是什么意思?」

對比用法:

“老师,‘有条不紊’的‘紊’是什么意思?”