# 翻譯模板 ## 一、標題 下面先說明一些標題 --- ### **示例：每章標題** # 第六章 復制 ### **代碼：** # 第六章 復制 ### **說明：** > **注釋：** > > 每章標題使用一級標題。并且標題和`#`號之間有一個空格。 --- --- ### **示例：每章第二級標題（每章標題算是一級標題）** ## 6.1 復制配置 ### **代碼：** ## 6.1 復制配置 ### **說明：** > **注釋：** > > 每章的二級標題使用二級標題，即兩個`#`。`#`后依然有一個空格。 --- --- ### **示例：每章第三級標題（每章標題算是一級標題）** ### 6.1.1 如何啟動復制？ ### **代碼：** ### 6.1.1 如何啟動復制？ ### **說明：** > **注釋：** > > 每章的三級標題使用三級標題，即三個`#`。`#`后有一個空格。 --- --- ### **示例：每章第四級標題（每章標題算是一級標題）** #### 6.1.1.1 復制的主節點的配置 ### **代碼：** #### 6.1.1.1 復制的主節點的配置 ### **說明：** > **注釋：** > > 每章的四級標題使用四級標題，即四個`#`。`#`后有一個空格。 --- --- ## 二、表格 目前Markdown對表格的支持不是很好。雖然Github上有擴展，但是對復雜表格還是有點無能為力。 Markdown也支持原生的HTML標簽。所以，表格使用原生的HTML標簽來表示表格。 > **友情提醒** > 可以去官網，把原來HTML表格的標簽直接復制下來。 --- --- ## 三、鏈接 如果是本文檔內的鏈接，統一使用“參考式鏈接”。如果外部鏈接，則使用普通鏈接。示例如下： ### **示例：參考式鏈接** 比如第一章第一頁有如下內容： For a discussion of MySQL Database Server capabilities, see [Section 1.3.2, “The Main Features of MySQL”](#) 轉換后的鏈接如下： For a discussion of MySQL Database Server capabilities, see [Section 1.3.2, “The Main Features of MySQL”][1.3.2] [1.3.2]: ./docs/Chapter_01/1.3.2_The_Main_Features_of_MySQL.md ### **代碼：** For a discussion of MySQL Database Server capabilities, see [Section 1.3.2, “The Main Features of MySQL”][1.3.2] [1.3.2]: ./docs/Chapter_01/1.3.2_The_Main_Features_of_MySQL.md //注釋：如果是在翻譯文檔中，不需要引用`docs`這級目錄。 ### **說明：** > **注釋：** > > 1. 詳細說明，請看：[Markdown語法說明](http://wowubuntu.com/markdown/index.html#link) > 2. “鏈接ID”（不明白請看上面的“語法說明”）以章節號來命名； > 3. 鏈接全部放到文件末尾，上面以“鏈接ID”來引用，方便檢查和后續修改； > 4. 根據下面的“文件命名”和“章節命名”方法，先自己確定鏈接，等相應章節完成后，檢查鏈接是否正確； --- --- ### **示例：行內式鏈接** 再如第一章第一頁出現如下內容： > The MySQL software is Dual Licensed. Users can choose to use the MySQL software as an Open Source product under the terms of the GNU General Public License (http://www.fsf.org/licenses/) or can purchase a standard commercial license from Oracle 則這里的鏈接統一使用行內式鏈接。如下： > The MySQL software is Dual Licensed. Users can choose to use the MySQL software as an Open Source product under the terms of [the GNU General Public License](http://www.fsf.org/licenses/) or can purchase a standard commercial license from Oracle ### **代碼：** The MySQL software is Dual Licensed. Users can choose to use the MySQL software as an Open Source product under the terms of [the GNU General Public License](http://www.fsf.org/licenses/) or can purchase a standard commercial license from Oracle ### **說明：** > **注釋：** > > 1. 外部鏈接統一使用這種行內式鏈接； --- --- ## 四、文件命名 目前考慮每第三級標題命名為一個文件。這里以`16.2.1. Replication Implementation Details`舉例。 ### **示例：文件命名** 16.2.1\_Replication\_Implementation_Details.md // 因為下劃線包括的字符在Markdown中表示斜體。所以，Markdown源文件中使用了`\`來轉義。顯示時不會看到`\`。 ### **代碼：** 16.2.1_Replication_Implementation_Details.md ### **說明：** > **注釋：** > > 1. 標題號數字之間使用`.`號連接，其他中間以下劃線連接的；如果遇到是兩個單詞+連接線組成，則保持原來的連接線不變，例如`Third-Party`，保持不變； > 2. 如果部分章節二三級標題超過了十個，可以在第1到第9節前面加0，方便排序。例如，`20.1. The INFORMATION_SCHEMA CHARACTER_SETS Table`，可以命名為`20.01_The_INFORMATION_SCHEMA CHARACTER_SETS_Table.md`。但是，文檔里面書寫的時候沒有必要加0。 > 3. 每個第二級標題也獨立命名為一個文件，為了方便查看，后面再加`.0`。例如，`16.2. Replication Implementation`，命名為`16.2.0_Replication_Implementation.md`，這樣就可以排到`16.2.1_Replication_Implementation_Details.md`之前； > 4. 文件命名使用原英文標題，并且保持原大小寫不變； > 5. 有特殊符號，不能用于文件命名時，只需將特殊符號刪除即可； --- --- ## 五、目錄命名 目錄目前計劃使用`Chapter_16`形式命名，即單詞`Chapter`加兩位數表示的章節號，中間使用下劃線鏈接。例如，第十六章，即命名為`Chapter_16`。不再加目錄標題。 --- --- ## 六、圖片命名及鏈接 我們說明一下圖片的命名，以及如何在文檔中應用圖片。下面以第十六章，16.3.3節中的圖片`Figure 16.1. Using Replication to Improve Performance During Scale-Out`舉例。 ### 圖片命名 圖片的命名規則如下： ### **示例：圖片命名** Figure\_16.01\_Using\_Replication\_to\_Improve\_Performance\_During\_Scale-Out.png // 因為下劃線包括的字符在Markdown中表示斜體。所以，Markdown源文件中使用了`\`來轉義。顯示時不會看到`\`。 ### **代碼：** 格式： Figure_兩位章節數.兩位圖片序號_圖片名稱.圖片后綴名 示例： Figure_16.01_Using_Replication_to_Improve_Performance_During_Scale-Out.png ### **說明：** > **注釋：** > > 1. 標題號數字之間使用`.`號連接，其他中間以下劃線連接的；如果遇到是兩個單詞+連接線組成，則保持原來的連接線不變，例如`Third-Party`，保持不變； > 2. 在第1章到第9章的章節號前面加0，每章圖片的前九張圖片，圖片序號前夜加0，這樣就統一成兩位，方便排序。例如，`Figure 2.1. Initial screen after loading Kleopatra`，可以命名為`Figure_02.01_Initial_screen_after_loading_Kleopatra.png`。但是，文檔里面書寫圖片標題時，沒必要加0，保持原來的樣式即可。 > 3. 圖片命名使用原英文標題，并且保持原大小寫不變； > 4. 有特殊符號，不能用于文件命名時，只需將特殊符號刪除即可； > 5. 某些圖片沒有序號及標題，例如`14.2.9.2. Architecture of InnoDB and memcached Integration`中引用的圖片。可以根據HTML格式的文檔中引用的圖片名稱來命名。從HTML文檔中很容易查出圖片名稱：`innodb_memcached2.jpg`，命名后為：`Figure_14_innodb_memcached2.jpg`，在原文件名的基礎之上，前面加上`Figure_兩位章節號_`即可；另外，建議將原圖片文件名的中劃線，換成下劃線； > 6. **所有圖片放到`images`目錄中**； > 7. **所有引用的圖片，直接從HTML格式的文檔中拷貝過來即可，不要自己切圖。** --- --- ### 圖片鏈接 有了上面的圖片命名規則。則很容易就可以寫出來 ### **示例：圖片鏈接** 我們還以第十六章，16.3.3節中的圖片`Figure 16.1. Using Replication to Improve Performance During Scale-Out`舉例。  ### **代碼：** 格式：  示例：  //全部使用相對路徑。在文檔中不會引用到`docs`這級目錄。 ### **說明：** > **注釋：** > > 1. 詳細說明，請看：[Markdown語法說明](http://wowubuntu.com/markdown/index.html#img) > 2. 強調一點：所有的圖片，全部使用本地圖片（就是放到本文檔中），不能使用網絡鏈接表示的圖片； > 3. 圖片統一使用相對路徑； > 4. 由于個人疏忽，把這部分內容忘記了，感謝朱培文和章志銳等童鞋的提醒； > 5. 文檔中，還有`Important`、`Note`等圖標，這個在HTML文檔中沒有找到，我繼續想辦法看看如何處理； --- --- ## 七、列表 下面是列表的示例。列表分為無序列表和有序列表，我們分別給出示例。 ### **示例：無序列表** * 第一個 * 第二個 * 第三個 ### **代碼：** * 第一個 * 第二個 * 第三個 ### **說明：** > **注釋：** > > 1. 統一以`*`開頭，`*`后加一個空格； > 2. 如無特別情況，每行中間不再添加空格，行高可以通過后期處理時再調整樣式； > 3. 某些列表項下面還會跟一段說明。這時，可以在這段說明的上一行結尾加兩個空格；那么這行在輸出時，和其他列表對齊；為了統一，建議在這行說明前面也加兩個空格；（感謝陳興隆的嘗試，給出了這個很好的解決方案。） --- --- ### **示例：有序列表** 1. 第一個 2. 第二個 3. 第三個 ### **代碼：** 1. 第一個 2. 第二個 3. 第三個 ### **說明：** > **注釋：** > > 1. 統一以`數字.`開頭，`數字.`后加一個空格； > 2. 如無特別情況，每行中間不再添加空格，行高可以通過后期處理時再調整樣式； > 3. 盡量保持數字和輸出顯示的數字一致； --- --- ## 八、代碼 代碼考慮使用Github的擴展形式，這種形式帶代碼高亮。 ### **示例：代碼** ```sql select NAME, AGE from USERS; ``` ### **代碼：** ```sql select NAME, AGE from USERS; ``` ### **說明：** > **注釋：** > > 1. 第一行后面是語言名稱，用于代碼高亮顯示，請務必添加； > 2. 如果是行內的代碼，則使用行內代碼，詳細說明，請看：[Markdown語法說明](http://wowubuntu.com/markdown/index.html#code) --- --- ## 九、補充 1. 每章開頭目錄，只需要翻譯標題，再加上鏈接即可，不需要加頁碼；