在編輯 FreeBSD 文件之前,有一些準備工作要做。 首先,請訂閱 FreeBSD 文件計劃郵件論壇。 有些團隊成員也會出現在EFnet的#bsddocs
IRC 頻道。這些人可以幫忙解決文件相關的問題。
安裝 textproc/docproj 套件或 port。這個meta-port 會安裝所有編輯和建構 FreeBSD 文件需要的軟體。
在~/doc
安裝 FreeBSD 文件庫的本地端工作副本 ( 請見 章 3, 工作副本 )。
%
svn checkout https://svn.FreeBSD.org/doc/head
~/doc
設定文字編輯器:
Word wrap 設為70個字元。
Tab stops 設成 。
將句首每八個空白以一個 tab 替換。
特定編輯器的設定方式列於 章 14, Editor Configuration。
更新本地端工作副本
%
svn up
~/doc
編輯需要修改的文件檔案。如果檔案需要大幅度的編修,請先諮詢郵件論壇。
標籤 ( tag ) 和 entity 的使用方式可以參考 章 8, XHTML Markup 和 章 9, DocBook Markup. 。
編輯完後,執行以下指令來檢查是否有問題:
%
igor -R filename.xml | less -RS
檢查輸出並重新編輯檔案來修正顯示的錯誤,然後重新執行指令來找出剩下的問題。重複執行直到所有錯誤都解決完。
修正送出前請先建構測試 (build-test ) 。在編輯的文件目錄最頂層執行 make
,將會產生 split HTML 格式的文件。例如要建構 HTML 格式的英文版使用手冊,請在 en_US.ISO8859-1/books/handbook/
目錄執行 make
。
修改並測試完後,產生“diff 檔”:
%
cd ~/doc
%
svn diff >
bsdinstall
.diff.txt
設一個可辨識的檔名。如上例中,是使用手冊的bsdinstall
部份的修改。
使用網頁版 Problem Report 系統提交 diff 檔。 如果使用網頁版,請輸入[修正檔] 問題簡短描述
的概要 。選擇 docs
分類和 doc-bug
類別。在訊息的主體中,輸入修正的簡短描述和其他相關的重要的細節。使用 按鈕來附加 diff 檔。
本文及其他文件,可由此下載: ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/。
若有 FreeBSD 方面疑問,請先閱讀
FreeBSD 相關文件,如不能解決的話,再洽詢
<questions@FreeBSD.org>。
關於本文件的問題,請洽詢
<doc@FreeBSD.org>。