G.3. 制作文檔

一旦你把所有的東西都設置好了,進入目錄 doc/src/sgml 然後運行下面其中一條命令: (記得要用 GNU make.)

G.3.1. HTML

制作 HTML 版本的文檔:

doc/src/sgml$ gmake html

這也是缺省目標。

在制作 HTML 文檔的時候,這個過程同樣生成用于索引條目的連接信息。 因此,如果你希望你的文檔在最後有索引,那麼你需要制作一次 HTML 文檔,然後再次把文檔制作成你想要的格式。

為了便于最終版本的發布,包含 HTML 文檔的文件被存儲在一個 tar 包裡, 在安裝的時候解包。要創建 HTML 文檔包,使用下面 的命令

cd doc/src
gmake postgres.tar.gz

在發布版裡,這些文檔包放在 doc 目錄裡, 並且缺省時 gmake install 會安裝這些東西。

G.3.2. 手冊頁

我們用 docbook2man 工具把 DocBookREFENTRY 頁面轉換成適于做 man page 的 *roff 輸出. 這些手冊頁也是以 tar 歸檔的形式發布的,與 HTML 版本類似.要創建手冊頁包,用命令

cd doc/src
gmake man.tar.gz

這些命令最後會在 doc/src 目錄生成一個 tar 文件.

要生成高質量的手冊頁,我們可能必須使用一個黑過的版本的轉換工具,或者做 一些手工調整。所有手冊頁都應該在發布之前手工檢查。

G.3.3. 用 JadeTex 生成的打印輸出

如果你想用 JadeTex 生成一個可打印 的文檔,你可以用下面的命令:

G.3.4. 通過 RTF 生成打印輸出

你也可以通過把它轉換成 RTF 並且用一個辦公套件 進行格式微調的辦法把PostgreSQL文檔轉換 成 RTF 格式的辦法來創建一個可打印的版本。 根據你使用的不同的辦公套件,然後你就可以分別把文檔轉換成 Postscript 或者PDF。下面的步驟演示了使用 Applixware 實現的過程。

注意: 目前看來 PostgreSQL 的當前版本的文檔碰到 了OpenJade的大小限制的一些毛病。如果制作 RTF 版本 的時候停住了好長時間,而輸出文件還是 0,那麼你很有可能碰到了這個毛病。 (不過,記住,正常的制作要花 5 到 10 分鐘,因此不要太快退出。)

ApplixwareRTF 清理

OpenJade,忽略了聲明文本主體的缺省風格.以前,這個未經查明的問題 導致目錄(ToC)生成的長時間處理.不過,在Applixware 的工作人員的全力幫助下,這個病症被診斷出來並且找到了繞開的辦法.

  1. 鍵入下面命令生成 RTF 版本:

    doc/src/sgml$ gmake postgres.rtf

  2. 修復 RTF 文件,以正確聲明所有風格, 尤其是缺省風格.如果文檔包含 REFENTRY 段, 那麼我們還必須把和前面的段落與當前段落 綁定的格式化暗示替換為當前的段落和後面的段落綁定. 在 doc/src/sgml 裡有一個 fixrtf 用于完成這樣的修補︰

    doc/src/sgml$ ./fixrtf --refentry postgres.rtf

    該腳本把 {\s0 Normal;} 增加為文檔的零級風格.根據Applixware, RTF 標準會禁止增加一種隱含的零級風格, 盡管 M$Word 碰巧可以處理這種情況.為了修復 REFENTRY 段落,該腳本把 \keepn 標記替換為 \keep

  3. Applixware Words 裡打開新的文檔,然後輸入該 RTF 文件.

  4. Applixware生成一個新的 ToC.

    1. 選擇現有的 ToC 行,從第一行第一個字符到最後一行最後一個字符.

    2. Tools->Book Building->Create Table of Contents 制作一個新的 ToC.選擇頭三層頭用于包含在 ToC裡. 這將用本地的ApplixwareToC 代替從RTF 裡輸入進來的行.

    3. 使用 Format->Style, 調整 ToC 格式,選擇每三種 ToC 風格, 然後為 FirstLeft調整邊距.使用下面的值:

      風格第一邊距(英寸)左邊距(英寸)
      TOC-Heading 10.40.4
      TOC-Heading 20.80.8
      TOC-Heading 31.21.2

  5. 對文檔進行加工:

    • 調整分頁符.

    • 調整表列寬.

  6. 用正確的值替換 ToC 裡例子和圖片部分右對齊的頁數. 這些對每個文檔只需要花幾分鐘.

  7. 如果索引是空的,那麼從文檔中刪除它.

  8. 重新生成並調整目錄.

    1. 選擇 ToC 字段.

    2. 選擇 Tools->Book Building->Create Table of Contents

    3. 通過選擇 Tools->Field Editing->Unprotect 解除 ToC.

    4. 刪除 ToC 中的第一行,它是指向 ToC 本身的一條記錄.

  9. 把該文檔保存為Applixware Words本地文檔格式以便于最後的編輯.

  10. 把該文檔以 Postscript 格式"打印"到一個文件.

G.3.5. 純文本文件

有好幾個文件是以純文本的模式發布的,主要是為了在安裝過程中閱讀. INSTALL 文件對應 Chapter 14, 只有一點用于不同環境的修改.要創建這個文件,進入 目錄 doc/src/sgml 然後敲入 gmake INSTALL. 這樣就會創建一個叫 INSTALL.html 的文件, 你可以用 Netscape Navigator 把它 另存為一個文本文件,然後把它拷到現存文件的位置. 好象 Netscape 提供了最高的 HTML 到文本的轉換質量.(比 lynxw3m好).

文件 HISTORY 可以用類似方法創建,用的命令是 gmake HISTORY。對于 src/test/regress/README 文件,命令是 gmake regress_README

G.3.6. 語法檢查

制作文檔可能需要很長時間。但是有一個方法用于只檢查文檔文件的語法正確性, 只要花幾秒鐘:

doc/src/sgml$ gmake check