感謝你有興趣對 Astro 文件翻譯做出貢獻!
提交改動前,別忘了閱讀 i18n 指南,裡面包含了貢獻過程中需要知道的內容。
也歡迎加入 Astro 的 Discord 社群與其他貢獻者們交流!
本指南旨在整理一份統一的格式及風格指南,使文件讀起來更流暢並易於理解。
編撰時參考了 Vue 中文文档指南。
部分參考:
原文 | 推薦翻譯 | 備註 |
---|---|---|
library | 程式庫/函式庫 | |
integration | 整合 | |
import | 引入/匯入 | |
package | 套件/軟體包 | |
routing | 路由 | |
architecture | 架構 | |
framework | 框架 | |
reference | 參考 | |
build | 建構/建置 | |
deploy | 部署 | |
component | 元件 | |
migration | 遷移 | |
asset | 資產 | |
docs | 文件 | |
documentation | 說明文件/技術文件 | |
project | 專案 | |
configuration | 組態/設定 | |
community | 社群 | |
hydration | 水合 | |
islands | 群島 | 特指 Astro Islands |
escape | 跳脫 | 特指 Escape Character |
reactive | 反應式 | |
responsive | 響應式 | |
repository | 儲存庫 | |
experimental | 實驗性 | |
middleware | 中介層 | |
adapter | 配接器 | |
CLI | 命令列 | |
terminal | 終端機 | |
codebase | 程式碼庫 | |
changelog | 變更日誌 | |
recipe | 操作指南 | |
server-side rendering | 伺服器端算繪 | |
call | 呼叫 |
部分參考《重編國語辭典修訂本》及《異體字字典》
中文 | 說明 |
---|---|
你 | 而不使用「您」 |
應用程式 | 而不使用「應用」 |
舉例來說 | 而不使用「舉個例子」等 |
其他 | 並無「其它」一詞 |
- 「JavaScript」或「ECMAScript」等詞語應保留風格化寫法,而非「Javascript」或「Ecmascript」
- 「npm」及「webpack」等產品 / 品牌名稱的應保留風格化寫法,而非「Npm」或「Webpack」
- 原則上,前端專業術語的翻譯優先參考 MDN 中文譯文,若無中文則保留原文。
- 原文中的 MDN 文件連結建議轉換為 MDN 的中文譯文連結,但是鑒於 MDN 的中文翻譯也並不完善,所以:
- 當條目有中文譯文時,將其手動變更為 MDN 中文連結,其餘則保留原文連結
- 除特殊情況外,所有中文標點符號應為全形字元
- 考慮到
/
在不同字體下算繪結果差異較大,分隔號應為前後包含空格的/
,如:你好 / 世界
請使用反單引號(`)標記,例:
呼叫 `window` 的 `alert()` 函式
部分參考《W3C 中文排版需求》
- 中文和英文之間應插入一個半形空格。如:
你好 Hello 世界
- 全形標點與英文之間不須插入空格。如:
你好世界(Hello World)
- 注意使用 Markdown 標記(如斜體、粗體或超連結等)時,應保證空格出現在欲分隔字詞的外部。如:
遵守 **JavaScript 程式碼規範**非常重要
遵守 [JavaScript 程式碼規範](#foo)非常重要
詳見*中文 MDN* 的參考頁面
詳見[中文 MDN](#bar) 的參考頁面
- 程式碼片段中的註解應翻譯為中文,其餘部分應保留原文
- 日誌及執行結果等也應保留原文,以便和程式碼邏輯保持一致
例如:
So far we've only been binding to simple property keys in our templates. But Vue.js actually supports the full power of JavaScript expressions inside all data bindings.
以上例句可譯為:「目前我們都只是在模板中綁定簡單的屬性鍵,但事實上 Vue.js 支援在任何資料綁定中使用 JavaScript 表達式」。
例如:
When Vue is updating a list of elements rendered with v-for, by default it uses an "in-place patch" strategy. If the order of the data items has changed, instead of moving the DOM elements to match the order of the items, Vue will patch each element in-place and make sure it reflects what should be rendered at that particular index.
像是「to match the order of the items」這樣的短語可以在保證語意不變的情況下簡化。
以上例句可譯為:「Vue 預設按照『就地更新』的策略來更新透過 v-for
算繪的元素列表。當資料的順序改變時,Vue 不會隨之移動 DOM 元素的順序,而是就地更新每個元素,確保它反映應在指定索引位置上算繪的內容」。
例如:
The mustache tag will be replaced with the value of the msg property from the corresponding component instance. It will also be updated whenever the msg property changes.
可在句中加入如「然而」、「並且」或「即使……也……」等連接詞來使句子更加連貫。
以上例句的後半句可譯為:「每當 msg
屬性發生改變時,綁定處的內容便會隨之更新」。
TODO
由於 Astro 文件以 Markdown 撰寫,每一行形成一個自然段落,因此原則上應保持譯文及原文行號應相對應,以保證後續更新時不造成混淆。
本指南並非硬性規定,而是代表中文文件翻譯團隊共識的建議。
如果你對本指南有任何想法或勘誤建議,歡迎發起 Issue 或是加入 Discord 社群中的 #i18n-crew-zh
頻道參與討論!