J.4. 文檔寫作 · PostgreSQL 中文文檔 9.3

# J.4\. 文檔寫作 SGML和DocBook沒有受到過多的開放源碼寫作工具的影響。最常用的工具集是帶有合適編輯模式的Emacs/XEmacs 編輯器。在一些系統上這些工具在典型的完全安裝時是一并安裝的。 ## J.4.1\. Emacs/PSGML PSGML是最常用和最強大的編輯SGML文檔的工具。如果正確的做了配置，它將允許你使用Emacs插入標簽和檢查標記一致性。你也可以把它用于HTML。看看[PSGML 站點](http://www.lysator.liu.se/projects/about_psgml.html)獲取下載、安裝指導、詳細文檔。關于PSGML有一件比較重要的事情要注意：它的作者假設你的主 SGML DTD目錄是`/usr/local/lib/sgml`。如果你像本文的例子那樣放在`/usr/local/share/sgml`，就得補償這個問題，要么是設置`SGML_CATALOG_FILES`環境變量，要么是自定義你的PSGML 安裝(它的手冊告訴你怎么做)。把下面這幾行放到你的`~/.emacs`環境文件里(根據你的系統調整路徑名)： ``` ; ********** for SGML mode (psgml) (setq sgml-omittag t) (setq sgml-shorttag t) (setq sgml-minimize-attributes nil) (setq sgml-always-quote-attributes t) (setq sgml-indent-step 1) (setq sgml-indent-data t) (setq sgml-parent-document nil) (setq sgml-exposed-tags nil) (setq sgml-catalog-files '("/usr/local/share/sgml/catalog")) (autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t ) ``` 并且在同一個文件里增加一條記錄，把SGML 加入自動模式別名的定義中(`auto-mode-alist`)： ``` (setq auto-mode-alist '(("\\.sgml$" . sgml-mode) )) ``` 當使用PSGML時，有一個讓自己在這些分離的文件上干活方便些的辦法：就是你在編輯它們的時候插入合適的`DOCTYPE`定義。例如，如果你在這個源文件上干活，這是一個附錄章節，因此你將通過把第一行標記成像下面的樣子從而把這個文檔聲明為一個 DocBook 文檔的"附錄"： ``` <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.2//EN"> ``` 這意味著任何或所有讀取SGML的軟件將能正確讀取這份文件，并且我可以用`nsgmls -s docguide.sgml`校驗此文檔 (不過你在制作整個文檔集的時候要把這行拿走)。 ## J.4.2\. 其它 Emacs 模式 GNU Emacs帶有不同的SGML模式，不過并不像PSGML那么強大，但是它比較少讓人混淆的東西而且比較小巧。同樣，它也提供語法高亮(字體鎖)，也是很有幫助的。`src/tools/editors/emacs.samples` 包含這個模式的相同設置。 Norm Walsh 提供一個用于 DocBook 的 [major mode](http://nwalsh.com/emacs/docbookide/index.html)，也有字體鎖和一些可以減少擊鍵的特性。