章 4. 說明文件目錄結構

內容目錄
4.1. 最上層,doc/
4.2. lang.encoding/ 目錄
4.3. 文件特定資訊

doc/ 樹中的檔案與目錄需要遵守特定結構是因為:

  1. 讓自動轉換說明文件到各種格式更簡單。

  2. 促進不同說明文件組織之間的一致性,以便更輕鬆的在不同說明文件之間切換。

  3. 可以很容易的決定新的說明文件應該放在文件樹中的哪個位置。

除此之外,說明文件樹必須能容納各種不同語言與編碼的說明文件。很重要的一點是,說明文件樹結構不應強制任何特定默認或文化的偏好。

4.1. 最上層,doc/

doc/ 底下有兩種類型的目錄,兩種都有非常明確的目錄名稱與意義。

目錄用途
share含有未特定用於各說明文件翻譯與編碼的檔案。其子目錄更進一步將不同資訊的分類,例如,構成 make(1) 基礎設施的檔案放置於 share/mk,而額外的 XML 支援檔 (如 FreeBSD 延伸的 DocBook DTD) 則放在 share/xml
lang.encoding每一個目錄代表可用的說明文件翻譯與編碼,例如 en_US.ISO8859-1/zh_TW.UTF-8/。名稱雖然長,但完整表達語言與編碼可以避免未來當一個翻譯團隊要以不同編碼提供同一個語言的說明文件造成的問題,這也同時避免往後要切換成萬國碼 (Unicode) 可能造成的問題。

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

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

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