給新貢獻人員的 FreeBSD 說明文件計畫入門書

FreeBSD 說明文件計劃

Revision: 50507
版權
Last modified on 2017-07-17 06:35:59 by rcyu.
摘要

感謝您參與 FreeBSD 說明文件計劃,您的點滴貢獻,都相當寶貴。

本入手書內容包括:如何開始著手貢獻 FreeBSD 說明文件計劃 (FreeBSD Documentation Project, FDP) 的各項細節,以及會用到的一些工具、軟體,以及文件計畫的宗旨。

本入門書仍在持續撰寫中。任何修正或新增內容的建議都非常歡迎。

[ 章節模式 / 完整模式 ]

內容目錄
1. Shell 提示符號
2. 書中所用的編排風格
3. 注意、提示、重要、警告與範例
4. 感謝
1. 概論
1.1. 快速上手
1.2. FreeBSD 說明文件集
2. 工具
2.1. 必備工具
2.2. 選用工具
3. 工作副本
3.1. 說明文件與操作手冊
3.2. 選擇一個目錄
3.3. 取出一份副本
3.4. 更新工作副本
3.5. 還原變更
3.6. 比對差異
3.7. Subversion 參考文獻
4. 說明文件目錄結構
4.1. 最上層,doc/
4.2. lang.encoding/ 目錄
4.3. 文件特定資訊
5. 說明文件建置流程
5.1. 繪製 Docbook 為其他格式
5.2. FreeBSD 說明文件建置工具集
5.3. 了解在說明文件樹中的 Makefile
5.4. FreeBSD 說明文件計劃 Make 引用檔
6. 網站
6.1. 環境變數
6.2. 建置並安裝網頁
7. XML 入門
7.1. 概論
7.2. 元素、標籤與屬性
7.3. DOCTYPE 宣告
7.4. 跳脫回 XML
7.5. 註解
7.6. Entities
7.7. 在引用檔使用 Entities
7.8. 已標記小節
7.9. 結論
8. XHTML 標籤
8.1. 簡介
8.2. 正式公用識別碼 (FPI)
8.3. 分節元素
8.4. 區塊元素
8.5. 行內元素
9. DocBook 標籤
9.1. 簡介
9.2. FreeBSD 擴充項目
9.3. 正式公用識別碼 (FPI)
9.4. 文件結構
9.5. 區塊元素
9.6. 行內元素
9.7. 圖片
9.8. 連結
10. 樣式表
10.1. CSS
11. 翻譯
12. PO 翻譯
12.1. 簡介
12.2. 快速上手
12.3. 建立新翻譯
12.4. 翻譯
12.5. 給翻譯者的提示
12.6. 編譯翻譯的文件
12.7. 提交新翻譯
13. 寫作風格
13.1. 叮嚀
13.2. 準則
13.3. 風格指南
13.4. 詞彙表
14. 編輯器設定
14.1. Vim
14.2. Emacs
14.3. nano
15. 他山之石
15.1. FreeBSD 說明文件計劃
15.2. XML
15.3. HTML
15.4. DocBook
A. 範例
A.1. DocBook book
A.2. DocBook article
索引
附表目錄
5.1. 常見輸出格式
12.1. 語系名稱
範例目錄
1. 範例的範本
5.1. 建置單頁 HTML 輸出檔
5.2. 建置分頁 HTML 及 PDF 輸出檔
6.1. 建置完整網站與所有說明文件
6.2. 只建置英文版網站
6.3. 建置並安裝網站
7.1. 使用元素 (開始與結束標籤)
7.2. 使用沒有內容的元素
7.3. 在元素中的元素; em
7.4. 使用元素的屬性
7.5. 屬性的單引號
7.6. XML 通用註解
7.7. 錯誤的XML 註解
7.8. 定義一般 Entities
7.9. 定義參數 Entities
7.10. 在引用檔使用一般 Entities
7.11. 在引用檔使用參數 Entities
7.12. 已標記的結構
7.13. 使用 CDATA 已標記小節
7.14. 在已標記小節中使用 INCLUDEIGNORE
7.15. 使用參數 Entities 來控制已標記小節
8.1. 一般的 XHTML 文件結構
8.2. h1, h2, 以及其他標題標籤
8.3. p 範例
8.4. blockquote 範例
8.5. ulol 範例
8.6. 使用 dl 列定義清單
8.7. pre 範例
8.8. table 的簡單用法
8.9. 使用 rowspan
8.10. 使用 colspan
8.11. rowspancolspan 一起使用
8.12. emstrong 範例
8.13. tt 範例
8.14. 使用 <a href="...">
8.15. 建立錨點
8.16. 連結到另一份文件中已命名的段落
8.17. 連結到同一份文件已命名的段茖
9.1. 使用 infobook 樣板
9.2. 使用 infoarticle 樣板
9.3. 簡單的章節
9.4. 空白章節
9.5. 章中的小節
9.6. para 範例
9.7. blockquote 範例
9.8. tipimportant 範例
9.9. example 原始碼
9.10. example 的結果
9.11. itemizedlistorderedlist 範例
9.12. variablelist 範例
9.13. procedure 範例
9.14. programlisting 範例
9.15. cocalloutlist 範例
9.16. informaltable 範例
9.17. 表格使用 frame="none" 範例
9.18. screen, promptuserinput 範例
9.19. emphasis 範例
9.20. acronym 範例
9.21. quote 範例
9.22. 鍵盤按鍵、滑鼠案件及組合鍵範例
9.23. 應用程式、指令、選項範例
9.24. filename 範例
9.25. package 範例
9.26. systemitem 與類別 (Class) 範例
9.27. uri 範例
9.28. 有超連結的 email 範例
9.29. 沒有超連結的 email 範例
9.30. buildtargetvarname 範例
9.31. literal 範例
9.32. replaceable 範例
9.33. guibutton 範例
9.34. errorname 範例
9.35. 在章與節上加 xml:id 的範例
9.36. xref 範例
9.37. link 到 FreeBSD 說明文件網頁範例
9.38. link 到 FreeBSD 網頁範例
9.39. link 到外部網頁範例
12.1. 建立 Porter 手冊的西班牙語翻譯
12.2. 建立 PGP 金鑰文章的法語翻譯。
12.3. 翻譯 Porter 手冊到西班牙文
12.4. 保留 XML 標籤
12.5. 編譯西班牙文 Porter 手冊
12.6. NanoBSD 文章的西班牙文翻譯
12.7. Explaining-BSD 文章的韓文 UTF-8 翻譯
A.1. DocBook book
A.2. DocBook article

本文及其他文件,可由此下載: ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/

若有 FreeBSD 方面疑問,請先閱讀 FreeBSD 相關文件,如不能解決的話,再洽詢 <questions@FreeBSD.org>。

關於本文件的問題,請洽詢 <doc@FreeBSD.org>。