DocBook 文件寫作入門

DocBook 文件寫作入門

作者. 老貢生

Edited by

總編. 老貢生

台灣企鵝寶寶工作隊

Revision History
Revision 1.22004/01/01 15:10:15 
第一次正式公開發佈
Revision 1.1.1.1.2.12004/01/01 09:25:51 
第一次草稿

 

這是一本幫助以前沒接觸過 DocBook 格式文件的新手,一個基礎導覽的技術小手冊。本手冊並未包含所有 DocBook 標籤,及其詳細解說。本手冊只挑選 DocBook DTD 定義中最常為使用者利用的標籤做最基礎的解說,尤其會和 HTML 的相類似格式資料做比對。所以不應該希望本手冊為你解答所有 DocBook 的疑惑,這只是一個墊腳石和敲門磚,幫助你更快的向 DocBook 的殿堂邁進。

 

 

本文採用 GNU 組織的 GPL公開版權宣告,歡迎複製,改寫,散佈,並要求你應該以同樣的權利條款,授予文件的使用人。對 GPL 的進一步的解釋,請參考GNU 通用公共許可證

 



我的感謝

首先我要感謝 James Clark 先生,沒有他,我們就缺少了一個執行 DocBook 文件解析轉譯的自動執行工具。他的 OpenJade 工具組,是一切 SGML 文件處理的心臟和引擎。由於他的慷慨,使得我們不必花一毛錢,就能擁有商業軟體同樣的服務和效能。

我們也要感謝 Norman Walsh 先生,要不是他耗費心力製作 docbook-dsssl 轉換輸出樣式表,DocBook 將只是又一個意義分類結構標記語言的實驗,一種理論性的教材而已。有了配套的 DSSSL 樣式表,DocBook 才能轉換成 text,rtf,ps,html 各種文件,真正達成一次輸入,多種輸出,各種格式文件交換中介的有力工具。

Norman Walsh 先生不只提供 DocBook-DSSSL ,他本身也是 OASIS DocBook 委員會的主要成員。藉由早期的 Davenport 討論組,到現在 DocBook Committees 參與成員的不斷努力,所謂分類意義的結構化文件格式的使用,已經不再只是個目標而已,它已經開始在我們的電子文件處理中日漸擔負起重要的使命。

最後,照慣例,要感謝我已七六高齡的老母親,要不是他打理我生活的一切,我一定連三餐都成問題,還提什麼奉獻呢?我知道這世間就算沒了我們母子,一樣陽光燦爛,生氣蓬勃,但至少這篇文章是不會問世了。所以如果你覺得從這篇文章多少得到益處,請和我一樣,多少感謝我娘及自己的娘一些。

List of Figures 1-1. DocBook DTD 文件組成結構圖

導論

本手冊希望協助一些還不熟悉 DocBook 文件格式的新手,學習基本的語法,並能快速而容易的開始觸類旁通,把 DocBook 這種格式的組織方法,用到自己文件的開發上。當然,在你學習一項新事務前,總希望知道一些新東西特性,大概的用途,以及最重要的,學會了有何好處?所以我們一開始先來談談 DocBook 是什麼?


1. DocBook 是什麼

談到 DocBook ,有人喜歡以標記語言出發,先解說一大堆 SGML 和 XML 的概念。另些人則著重在表形文件格式與表意文件格式的分別,強調所謂邏輯結構和意義分類在文件組織的重要性。這些都對,也都是組成 DocBook 的重要概念,但是這些概念本身比 DocBook 更難理解,結果是用一個不明白解釋了另一個不明白。為了避免花了大半篇幅,還是讓你一頭霧水,我不企圖讓你明白什麼叫標記語言的結構邏輯,也不一再舉例表形和表意格式文件的差別,我只向大家說明一個重點,那就是 DocBook 文件能做怎樣的利用,你能從 DocBook 的格式安排上得到什麼樣的好處。


1.1. 寫一份學術著作

從望文生義來做最直接的了解,DocBook 的 Book 就是書,DocBook 的種種格式就是幫助你很方便的去寫作一本書。而且這本書是指具有理論性,嚴謹性的學術著作,所以舉凡目錄,索引,參考書目,詞彙解釋,備註解釋.....,乃至作者,出版商,書籍國際編碼等等,舉凡一本我們在書店買到很正式像樣的書中所能找到的各種資料分類,DocBook 都做了相對應的格式規劃。只要你按照 DocBook 規定填入各部份資料,透過翻譯轉換器及樣式表的自動處理,還可以為你自動編輯版面和補充資料,而且你的書寫得愈大愈多,你就會發覺 DocBook 幫你省下的編排功夫也愈多。

 

Note

DocBook 並不是只適用大部頭的書籍寫作,單一主題的討論文章,或是問題解答集也很合適。但基本上 DocBook 是為學術或技術性等論理文章設計的,而不是為詩詞歌賦這種文藝文章設計的。


1.2. 一次輸入多種輸出

DocBook 格式文件的最大特色就是沒有可閱讀的版面樣式,這並不是說 DocBook 文件無法閱覽,剛好相反,任何一個能處理純文字的編輯器和瀏覽器都能開啟 DocBook 格式文件。問題是那只是字元一個挨著一個,你完全看不出來那個字串該使用什麼字體字型,要多大多小,要置左置右置中,那個要縮排,那個要凸排,那個要單獨另成一段,那個要折行,又那個要緊跟前面,不分段落。凡此種種,你常在各種排版軟體上使用的版面設定和功能,在 DocBook 裡一樣也找不到。

DocBook 做為一個標記文件,一樣有標記設定,以及將文章加以分類的方法。不過他是將文章分為章,節,段,落,作者,出版商...等等,至於作者,出版商,章,節,標題等該用什麼字型字體,成個什麼段落,在 DocBook 格式定義裡完全沒有這些訊息。DocBook 把這些設定留給樣式表去規定[1]。所以只要樣式表一變,DocBook 最終轉換輸出的結果就會改變,而完全不需改動到原有的 DocBook 文件內容。利用標記語言中資料文件本體與輸出樣式表分開的概念,我們只要按 DocBook 格式規定,輸入一次資料,就可以利用樣式表的設定及改換,可以轉換輸出成 HTML,RTF,PS,MAN...等等其他閱覽格式的文件,並且可以設定個人或組織專屬的特殊風格,這就是所謂的一次輸入,多種輸出。


1.3. 建立可搜尋的文字庫

DocBook 另一個被稱頌的功能就是他的分類細膩而週延,結構完整,並且有搜尋次序上的意義。由於這些特性,凡遵照 DocBook 格式規定製作出來的文件,有如一個資料庫一般,有完整的紀錄次序,欄位分隔,可供條件查詢及檢索。所以不只把 DocBook 文件轉換成其他格式文件,是有效的利用,就是把 DocBook 原始文件放在網路上供查詢檢索,也比任何其他的排版格式文件更為適合。


1.4. 共同文件寫作

DocBook 是非常靠近 SGML 原始型態及功能的格式文件,透過對 SGML 中模組化的文件型態定義,條件編譯選項,外部插入檔案等等功能的繼承,使得 DocBook 非常適合擔任團體共同寫作文件的重任。經由根文件的適當設定,每個寫作團隊成員都可以分頭獨立寫作部份文件,最後再透過 DocBook 的自動編排功能,把獨立的部份文件串成一個整體文件,宛如一個人寫作一般。

由於這個共同寫作的強大功能,在 Unix 系統下許多軟體開發專案團隊,都漸漸採用 DocBook 作為他們共同寫作的解決方法,最有名的例證就是 Linux 的 HOWTO 文件的組織整理,已經將 DocBook 做為推薦的標準寫作格式。[2]


2. DocBook 的源流

尋找一個共通的,可以在不同的工作平台及作業系統中,在不同的排版軟體中,交換彼此資料的文件格式,一直是許多機關組織,工作團隊,在製作流通文件上的基本需求。尤其在 Unix 的 Open source 軟體開發團隊運作上,更是不停的在尋求更理想的運作模式。這其中尤以 The Linux Document Project[3] 這個專案計畫最具指標意義,因為 TLDP 匯集了 Linux 作業系統下各個層面的軟體使用者及發展者,所以 TLDP 網站採用的文件格式,幾乎就可以說是 Linux 社區的標準資料格式了。所以,現在我們就來看看 TLDP 文件格式的演化過程。


2.1. HTML

作為 Wild World Web 的一分子,大概主要的顯示文件都是 HTML 文件吧。在所謂意義分類的結構文件概念尚不發達,來源資料與版面顯示分開處理的技術尚未開展時,HTML 格式,既是資料來源的組成,也是最終的顯示樣式,一肩挑起所有的大梁。


2.2. LinuxDoc

HTML 雖然在網路資料的交換顯示上,有其不可忽視的貢獻,但卻有他另一面不足的地方。第一:HTML 只適合在網頁瀏覽器中顯示,如果要把他列印,或用別的排版軟體開啟,顯示的結果都會格格不入,無法配合。這時同樣的內容,換種利用方式,就要對文件做重新編排,導致編輯時間浪費及版本混亂。

其次 HTML 並不會對文件內容加以歸類,他的標記只是表明那個字串或區段該如何排列顯示而已,並不會有任何指示,告訴你那一段文字,他代表了什麼意義。這對網路資料的搜尋與統整毫無任何幫助,他無法達成一份文件,既能顯示,又方便檢索查詢的資料庫功能。

為了尋求更符合需求的文件格式,大家不約而同的都尋求 SGML 這個標記語言的幫忙[4]。首先是 Tom Gordon 利用 SGML 語法制定了一個 QWERTZ DTD ,目的是為了方便輸入資料,然後自動化產生 LaTex 排版格式文件。

接著是 Matt Welsh,他覺得 QWERTZ DTD 既可以將一般文字轉換成 Latex 格式文件,那同樣的原理,應該也可以產生其他種格式文件。正巧他的工作,需要大量產生各種不同格式的文件,例如像plain text, html, and PS 等等,因此他修正了一下 QWERTZ DTD,作為他 Linuxdoc-SGML document processing system(Linux SGML 格式文件處理系統) 的核心部份。由於 Linuxdoc 格式的產生,確實能解決一次輸入,多種輸出的功能,以及將文件做良好有意義的分類,以方便檢索的功能,因此被 TLDP 採用為交換文件標準。從此所謂的 Linux SGML 文件變成 Linux 系統中,非列印顯示,而是以意義分類為標記的格式文件統稱[5],而 Linuxdoc 格式就是第一代的 Linux SGML 文件。


2.3. DocBook

TLDP 所屬的不少人曾用 Linuxdoc 格式寫作 HOWTO 文件,但 Linuxdoc 本身的發展演進卻不令人滿意。在 Matt Welsh 繼續發展了幾年沒有很好的成效後,Cees de Groot 用 perl 這套程式重新改寫了 Linuxdoc 系統,改名為 SGML-tools ,但 DTD 仍用的是 Linuxdoc 的標準。最後 SGML-tools 又被用 python 程式語言全新改寫了一次,但這次,Linuxdoc 卻讓出了龍頭寶座,而把文件製作的格式標準,讓給了另一個由 SGML 語言定義出來的 DocBook 格式文件。

DocBook 並非由 Linuxdoc 衍生出來的,它有它自己的故事。早在 1991 年 HaL Computer Systems 和 O'Reilly & Associates 這兩個組織為了達成 Unix 作業系統下 groff 文件系統轉換問題,特別用 SGML 設計了 DocBook V1.1 這個格式文件。

在 DocBook V1.1 推出的同時,O'Reilly 開闢了一個討論園地,稱為 Davenport 討論組。參與 Davenport 討論的成員非常投入,貢獻良多,因此到了 1994 年他們得到正式的授權,成為 DocBook 格式標準的正式維護組織,並同時推出 DocBook V1.2.2。

DocBook 交到 Davenport 手上後,快速的成長蓬勃,不只包含的企圖與收納更多,並且擺脫 groff 工具的限制,直接使用 sgml 解譯器程式來處理文件轉換,並嘗試直接做列印格式輸出。這時期 Novell 和 Sun 兩大資訊公司對 DocBook 風格的形成,有很大的影響。

到了 1997 年 1 月,Davenport 推出 V3.0 後的不久,一些 Davenport 的主要發展者開始討論怎樣把 DocBook 格式文件從原來的 SGML 標記語言推展到 XML 標記語言,從而能在 DocBook 中使用 XML 發展蓬勃的應用工具軟體。它們取得了一些進展,但在 Davenport 時期,並未完成這件工作。

1998 年 7 月,在 Davenport 原有的贊助者結束贊助的情況下,由綠洲組織(OASIS)接手 DocBook 發展計畫,成立了 The DocBook Technical Committee 組織負責推展及研發 DocBook 。目前 DocBook 已推出 V4.2 ,並且完成了 XML 的格式定義檔案,變成可選擇由 SGML 或 XML 兩種轉譯方式的處理。DocBook Technical Committee 的發展人員正著手規畫推出 DocBook 5.0 ,正逐步健全發展,也成為 KDE,Gnome 以及 TLDP 等數十個公私組織的標準文件交換格式,勢必在將來日增其影響力,成為普遍的文件標準。


3. 開始寫作前的準備工作

如果 DocBook 格式文件已經挑起你的興趣,而你以前又從未製作過 DocBook 格式文件,那麼可以考慮跟隨著本手冊的章節,從最基本的開始。雖然 DocBook 文件唯一需要的工具只是一個簡單的文字編輯器即可,Unix OS 下的 vi ,MS Windows 下的 notepad 都可勝任愉快。但能夠邊編寫邊解析轉換,校正標籤使用的合法性及觀視閱覽格式輸出的結果,都是你在學習製作 DocBook 文件時不可或缺的。所以一些解析轉換 DocBook ,及檢視輸出結果的工具,也是我們在製作 DocBook 文件前要先準備好的。先了解一下 DocBook 文件運作流程,有助於我們了解要做那些準備工作。

Table 1. DocBook 文件運作流程表

流程名稱使用工具準備方法

依 DTD 定義編寫文件

任何的文字編輯器皆可

使用系統中的原有編輯工具

將寫好的文件加以解析,並檢查是否符合文法。

DocBook 的 DTD 文件模組

在系統中安裝 DTD 文件模組

OpenSP 文件解析程式工具

在系統中安裝 OpenSP 程式工具

將解析過的文件,依照樣式表文件模組轉換成別種格式文件。

DocBook 的 DSSSL 文件模組

在系統中安裝 DSSSL 文件模組

OpenJade 文件轉換程式工具

在系統中安裝 OpenJade 程式工具

將轉換過的文件,用適合的瀏覽器觀視檢查。

依轉換格式選擇瀏覽工具

使用系統中適合的瀏覽器

由上表可知,學習 DocBook 文件編寫的必要工具是:

 

  1. 純文字編輯器

  2. DocBook 的 DTD 文件模組

  3. DocBook 的 DSSSL 文件模組

  4. SGML 的 解析器 OpenSp

  5. SGML 的 轉譯器 OpenJade

  6. 輸出格式文件的瀏覽器

如本手冊前面所言,文字編輯器任何一個都可以,系統中現有的,習慣使用的即可。DTD,DSSSL,OpenSp,OpenJade 等工具的安裝及設定,在 Linux 系統下,可以使用 docbook-utils or sgml-tools 套件,或者你也可以參考本人的另一篇譯文 DocBook XML/SGML Processing Using OpenJade 從原碼來自己編譯建立 DocBook 的轉譯輸出系統。至於輸出格式的瀏覽器,本手冊的輸出是採用 HTML 格式,所以不管你使用 IE,Netscape or Mozilla ,都是很適合的瀏覽器。


4. DocBook 編寫的注意事項

4.1. 標記語法的規則

DocBook 使用的標記語法和 SGML 預設值相同,如果你會使用 HTML or XML 的標記語法,那麼可以說也就會了 DocBook 標記語法。但如果你不曾接觸過 SGML 的標記語法,不妨看看下面標記語法的簡短介紹。

要在文件中加入分類標籤,一定要有些字符負責當作分隔字符,把標籤資料和文件原始內容分開。SGML 是以 '<' 字符當作標籤開始字符,把 '>' 當標籤的結束字符,所以一個資料內容的開始標籤,它的語法是 <標籤名稱 屬性名稱A="屬性值" 屬性名稱B="屬性值" ...> ,< 和 > 字符之間是標記資料。

至於一個資料內容的結束標籤就比較簡單,他的語法是 </標籤名稱>,分隔字符和開始標籤完全相同,標籤名稱前要有 '/' 前置字符,至於屬性值字串,結束標籤是不需要屬性設定的。

最後開始標籤字串和結束標籤字串間包夾的就是文件的分類資料內容了,譬如:

<email id="mymail">abc@def.idv.tw</email>

 

<email id="mymail"> : 開始標籤
email : 標籤名稱
id="mymail" : 標籤屬性設定
ibc@def.idv.tw : 資料內容
</email> : 結束標籤

 

 

Note

標記語言對標籤的格式有嚴格的要求,除了分隔字符,標籤名稱,屬性名稱不能有絲毫錯誤外,尤其是 XML 語法定義的 DocBook 格式,不可任意簡省結束標籤,或採取像

<email id="mymail"/abc@def.idv.tw/

這樣的簡省敘述。請一定照規矩打足開始標籤與結束標籤,空標籤沒有結束標籤,所以他的開始標籤結尾要加 '/' 字符,如 <xref linkend="address" />。

 


4.2. 特殊字符的表示法

如同前一小節敘述,'<' 和 '>' 字符被 DocBook 拿來當作標籤分隔字符用,那萬一我們要顯示 '<' 和 '>' 字符符號,而不是要他發揮分隔字串功能的時候該怎麼辦呢?這時就要有個 '<' 和 '>' 字符的代名來表示要顯示他們原來字元的意思。'<' 的代名是 lt(little) ,'>' 的代名是 gt(great) 。使用代名時要在代名前加個 '&' 字符當前置字,';' 當收尾字。&lt; 表示 lt 這裡不是代表 "lt" 字串,而是表示 '<' 字元顯示的意思。

這裡為了特殊字元表示把 '&' 字符借去當前置字,那麼 '&' 字元本身也成了特殊字元,所以也有個 '&' 的代名是 amp ,表示式是 &amp; 。

 

Note

DocBook 特殊字元列表請參考後面章節的 DocBook 特殊字元表> 。


4.3. 放棄版面編排的習慣

百分之九十以上的人在製作文件時,都會考慮到版面編排的問題,因為重視文件閱覽的感受和效果,被認為是一個文件撰寫人應當負起的責任。但這在 DocBook 文件撰寫時,卻是你應該極力屏除的心理障礙,理由如下:

不管是 XML 或 SGML 標記語言定義的格式文件,都是忽略格式字元處理的,所以不管你在一行文字前塞入多少空白,在行與行間按下多少個分段按鍵,DocBook 一概忽略不理,所以就算你費盡心力去排,也是枉然,對 DocBook 來說,只有標籤的改變才是有意義的。

DocBook 的功能就是要將資料塞到各種顯示格式文件裡,唯有他毫無任何固定格式,才能隨時被捏塑成各種格式。任何單一的版面考慮,不管是對 HTML,RTF or Tex/Latex ,當他換成另一種顯示時,原來的版面設定肯定會成為搗蛋鬼和麻煩的來源。所以 DocBook 文件本身不該包含版面設定資料,決定輸出成什麼樣子,應該留給樣式表來決定。在 XML 中是 XSL 和 XSLT ,在 SGML 中是 DSSSL 。

在 DocBook 中重視的是大量文件的自動編排轉換,和統一風格的建立,單一文件版面細部的修整設定,不是 DocBook 所擅長的。

 

Note

我們常在 DocBook 文件中,把子標籤前多塞幾個空格,好表示他是父標籤的下一個層級。這純粹是方便文件撰寫者檢視文件語法用的,與輸出格式完全無關,一個標籤是否是另一個標籤的子標籤,端看他是否處在別人的開始標籤與結束標籤中,與他是否縮排或凸排完全無關。


4.4. 其他注意事項

本手冊以 SGML-DTD-V4.2 為標準,所以你至少需下載 DocBook sgml-dtd-4.2 DTD 模組文件。

本手冊只觸及 DocBook 所有標籤的一小部份而已,如果有任何疑問或懷疑,請以 DocBook: The Definitive Guide 記載為準。

本手冊的各範例希望你都能試作一遍,並把他們轉換成 HTML 文件,在網頁瀏覽器上觀視。這樣做有兩個好處;一:校正自己的語法錯誤(我使用 DocBook 到如今,沒有一次不用錯語法的。)二:知道 DocBook 這樣安排的意義所在。

留心轉譯器所顯示的錯誤訊息,像:

jade:preface.sgml:134:112:E: end tag for element "LISTITEM" which is not open
jade:docwrite.sgml:33:12:E: end tag for "APPENDIX" which is not finished

它會告訴你原因及詳細的錯誤所在,別偷懶,一一去改正你文件中的錯誤。

 


Chapter 1. 基礎標籤的運用

本章將介紹 DocBook 格式文件寫作時,最基本而且常用的標記名稱及使用方法 。尤其是把重點放在與 HTML 相對應功能的標記上,希望你學會這些標記後,至少能做到把 DocBook 文件資料,轉換成 HTML 網頁,供人網路閱覽無礙。至於其他比 HTML 更進一步的功能,我們在製做其他文件常用的,將會分別以專章討論。至於一些十分細碎的,特殊用途的標記,則不是本手冊能包含的內容,請到 DocBook 官方網站 查詢官方版的線上手冊。


1.1. 無用之用

在介紹任何其他有分類意義的標籤前,先要介紹這個不代表任何分類意義,也對文件內容或輸出格式無任何影響的標籤,就是備註標籤。不管 HTML,DocBook or XML ,他們的備註標籤格式都一樣,以 "<!--" 字串開頭,以 "-->" 字串結尾的一個空標籤,凡在 "<!--" 和 "-->" 間包夾的所有字元字串都被忽略,一律不予處理,這是 SGML 標記語言的預設備註表示法。

Example 1-1. SGML 的備註表示法

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<book> <!-- 這是根標籤的開始標記 -->

......  <!-- 這是文件資料的資料內容 -->

</book> <!-- 這是根標籤的結束標記 -->

<!-- 所有的文件內容敘述,都必須被包夾在根標籤的開始
     標記與結束標記之間。 -->

上例可知,"<!--" 和 "-->" 間的所有文字敘述,都只是對本文的附加說明而已,使用與不使用都對該文件沒有影響[6],本手冊一開始就介紹這標籤的目的是,後面很多的解釋段落要用到他,你及早知道這樣表示法的含意,才不會不知所云。


1.2. 文件型態宣告

不管是 SGML 或 XML ,除了註解之外,開頭的第一或第二個標記,一定是用一個文件型態宣告的標記,來標明整份 SGML 文件,是遵守那種 DTD 格式規範所製作的。他的目的是通知負責處理此份文件的軟體程式,使用適合的 DTD 規定,來解譯和處理。這是一切 SGML 文件製作法則的依據,也是 DocBook 在完成以後,能夠順利轉換成別種顯示格式文件的根本,雖然他不是文件要顯示的內容,卻是決定並掌管了整份文件的規則,所以必須清楚明確而不可少。

Example 1-2. SGML 的文件型態宣告

 

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
註1註2註3註4

 

 

註1, 文件型態表示詞

'!' 字符加上大寫 "DOCTYPE" 字串,表示這個標籤作為宣告文件型態之用。

註2, 根標籤名稱

指定本文件要用那個 DocBook DTD 定義的標籤當根標籤。原則上 DocBook 並未嚴格指定限用那些標籤做根標籤,所以不只 book ,像 article,chapter,grossary.appendix 都可以當根標籤。但很重要的一點就是,根標籤是一份文件最上層的標籤,不可以有比他更高層的標籤出現在文件中,所以一旦你選定了根標籤,也同時決定了這份文件能使用那些類別的子標籤和階層結構。這點是和 HTML 大不相同的,HTML 的根標籤永遠是 <html>,能使用的標籤名稱和結構也永遠不變,但 DocBook 的文件的風格,會跟著根標籤的不同而改變。

註3, 公共識別表示詞

大寫 "PUBLIC" 字串是表示它後面跟了個公共識別字串,又稱作 PUBLIC IDENTIFIER 。DocBook 有個龐大的 DTD 定義,通常都不會直接和本文寫在一起,而採外部文件形式,把 DTD 敘述儲存成單獨的檔案,在解譯轉譯 DocBook 文件時,再由解譯器載入外部 DTD 檔案,以分析 DocBook 文件。那為何不直接寫 DTD 的檔案路徑名稱就好,而要拐彎抹角,搞個又臭又長的 public ID 字串呢?這是因為 DocBook 是一個供不同平台交換資料訊息用的文件。當一份文件由作者的主機傳到閱覽者主機上時,怎能保證彼此的 DTD 定義檔路徑會一樣呢?所以為了避免因閱覽者與文件作者主機系統配置不同而指定錯誤,就用 public ID 的辦法。經由 DocBook 使用者在自己機器上放置一份對照表,紀錄各 public ID 的 DTD 相對應檔案路徑,就不必耽心因為彼此 DTD 檔案放置路徑的不同,而無法成功轉譯。

註4, 公共識別字串

任何一個格式標準的發佈者,都應該設定其與眾不同,獨一無二的識別字串,來公佈周知。如果在文件開頭看到這個識別字串,就表示此文件使用該發佈者制定的格式,應該依據發佈者規定的方式處理。這個識別字串的組成可翻閱參考字典的 Public Identifier,查看標準的組成方式。但縱使不依據此規則,仍無損其效力,因為識別字串的關鍵是獨特與唯一。而 DocBook 的每一版本都有其唯一的公共識別字串,你必須完全照抄,不能任意增減,所以寫作前請先參考相關 DTD 下載群組的 catlog or docbook.cat ,看看他要求的識別字串是怎麼下的,然後複製貼上,成為你 DocBook 文件的第一行。

Example 1-3. XML 的文件型態宣告

<?xml version='1.0'?>                                                     (1)
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"               (2)
                         "http://docbook.org/xml/4.1.2/docbookx.dtd">      (3)

(1)
XML 文件表示標籤:W3 組織制定 XML 標準時的規定,凡使用 XML 標記語法的文件,開頭第一行要做這樣的表示。如果你是採用 SGML ,當然就不能加這個。
(2)
除了public ID 加上 XML 字樣外,其他完全和 SGML 的 DOCTYPE 標籤用法一樣。
(3)
SYSTEM ID 路徑字串:這也是只有 XML 才有的要求,通常是指向外部 DTD 規格檔的所在路徑。由於 XML 標榜的是網路運作交換,所以通常這裡都是 DTD 檔的 URL 位址。不管是 SGML 還是 XML ,當設定產生競合衝突時,文件設定高於系統設定,所以解譯器在處理時,是會跨過系統指定的 DTD ,而到網路上去找指定的 DTD 檔。但這也同時容易在網路位址錯誤或更動時,引起找不到 DTD 檔的錯誤而導致解譯轉換失敗,所以 SGML 和 XML 文件宣告方式的差異,可說各有利弊。

1.3. 根標籤

根標籤表示一個文件的定義宣告區段結束,文件分類編輯區正式開始。除此之外,根標籤有下列規則必須遵守:

 

根標籤的法則

  1. 任何一份 DocBook 文件都不能缺少根標籤。

  2. 根標籤的起始標籤必須緊接著定義宣告區段,作為本文的第一個標籤,而他的結束標籤必須在結尾的最後一個,包含著整個本文的其他標籤及文字區段。

  3. 根標籤必須與 DOCTYPE 宣告的根標籤名稱一致。

  4. 根標籤不得包含在 DTD 定義中的上層結構標籤,也就是一份文件只可以出現及使用根標籤的子標籤。

  5. 根標籤在同一份文件上只可以出現一次,不得出現兩次以上。這包括根標籤內含根標籤的階層結構,或兩者前後排列的平行結構。

  6. 空標籤不得作為根標籤。


1.4. 常用的根標籤介紹

就如前面章節所言,DocBook 並不限制根標籤要用那個。但依據一般我們日常的使用習慣,也考慮到最後輸出格式的樣式表是否支援,還是有些比較標準化的根標籤可供依循。一般比較常用的根標籤有:

 

book, 書籍, 手冊

這並無一定大小的區別,與一般我們對書籍觀念類似,集合幾個章節,談些相關但分門別類的主題。

chapter, 章

雖然 chapter 本身在 DocBook DTD 定義中是 book 的子標籤,但一般也常拿他當討論某個單一主題文件的根標籤。導致和下面要講的 article 標籤,反而有異曲同工的感覺。

article, 主題文章

這是一個和 chapter 平行的標籤,在使用習慣上,article 比 chapter 更常被用來當根標籤,他代表單一主題的單一文章,與動用數個 chapter 去描述一個主題的使用習慣不同,所以在 Linux Document Project 上的 HOWTO 文章,用得最多的根標籤就是 article。

 

Note

這純粹是種使用習慣,而非 DocBook 的 DTD 限制,沒人規定你不可以用數個 article 來談單一主題,以及只用一個 chapter 談一個主題。

 

當然 DocBook 不只這幾個上層標籤而已,如 set 標籤,相當於叢書,是 book 的上層標籤,而介於 book 和 chapter 之間還有個 part ,就好像我們說書的上篇下篇一樣。此外像 preface (序言,導論) , appendix (附錄),其實把他們看成第一個 chapter 及最後一個 chapter ,並沒什麼分別。所以熟悉 book,chapter,article 結構,就同理可推了。

此外 DocBook 也提供了一些非一般章節的,特殊格式的標籤組可以當根標籤,也可以內涵於 book 當子標籤,譬如:

index: 目錄索引

bibliography: 參考書目

glossary: 詞彙解釋

qandaset: 問答集(Q & A)

這些都是比較複雜的書籍會有的文件結構,由於他們不同於一般章節的內容,所以我們將另闢一章來講解如何製作這些特殊格式標籤組。至於本章,我們將著重在 DocBook 最基本的結構 book,chapter,article ,以及如何使用 DocBook 標籤,做出類似 HTML 表現方式的結構出來。


1.5. DocBook 最基本的文件結構 -- Sect

在進入 book,chapter,article 這三種最常用根標籤附屬結構的討論前,我們先來談談這三個根標籤共同擁有,也是 DocBook 格式文件最常被使用的子結構,sect

sect 是 section 的縮寫,通常我們中譯成段落。在 DocBook 中他的基本結構是:

Example 1-4. sect 的基本結構

<sect[n]>
  <title>段落標題</title>
  <para>第一段文字......</para>
  <para>第二段文字......</para>
  ......
  [子標籤結構]
  ......
</sect[n]>

從 HTML 表現格式的觀念來類比,就如同一個 <Hn> 的橫幅,配上一個 <div>,<div> 裡可能是文字區段 <p>,也可能是其他的標記。所以一個標題,加上一個資料區塊,就是 sect 基本上的樣貌。

 

Important

HTML 的 title 標籤和 DocBook 的 title 標籤,在意義和最後顯示格式上不大一樣,HTML 的 title 一個 page 只能有一個,而且通常顯示在瀏覽器的標題列,但 DocBook 的 title 則大部分的區段標籤都有,表現形式比較像分隔區段與區段的醒目橫列文字(like HTML <Hn>)。

至於 sect 的區塊部份,一個 DocBook 各種標籤都少不了他的就是 parapara 是 paragraph 的縮寫,中譯也是區域段落,老實說光從字義看,好像和 sect 沒啥區別,但依據 DocBook DTD 的定義,真正文字敘述是放在 para 裡面,也就是 sect[n] 是要靠 para 來收納他的文字串列的。一個 sect[n] 最少要有一個 para,但可依需要增加 para 使用數量。[7]

最後是包含子標籤,這是選項,可要,可不要。sect[n] 表示是有層級分別的,目前 DocBook DTD 的定義是 sect1sect5五個層級,而且必須按層級逐階隸屬,也就是你不可以不透過 sect2 就直接把 sect3 塞到 sect1 裡。 [8] 同理,如果你堅持要使用 sect5 ,那就必須:

Example 1-5. sect 的層級結構

<sect1><title>sect1 標題</title>
  <para>sect1 文字段落...</para>
  <sect2><title>sect2 標題</title>
    <para>sect2 文字段落...</para>
    <sect3><title>sect3 標題</title>
      <para>sect3 文字段落...</para>
      <sect4><title>sect4 標題</title>
        <para>sect4 文字段落...</para>
        <sect5><title>sect5 標題</title>
          <para>sect5 文字段落...</para>
        </sect5>
      </sect4>
    </sect3>
  </sect2>
</sect1>

上面的結構範例請你再多看兩眼,因為把它記熟了,你就已經會了百分之六十的 DocBook 基本結構[9]。而且不要懷疑,光靠這幾個標記,已經夠寫出個陽春型的 DocBook 文件來了。


1.6. 基本的根標籤結構

首先我們談 chapter 和 article ,這兩種根標籤結構大同小異。以 chapter 為例,套用上節的 sect 結構理念,一個標題配一個資料區塊,那 chapter 的基本結構就是:

Example 1-6. chapter 基本的層級結構

<chapter><title>章</title>
  <para>章引言... </para>
  <sect1><title>sect1 標題</title>
    <para>sect1 文字段落...</para>
    <sect2><title>sect2 標題</title>
      <para>sect2 文字段落...</para>
      <sect3><title>sect3 標題</title>
        <para>sect3 文字段落...</para>
        <sect4><title>sect4 標題</title>
          <para>sect4 文字段落...</para>
          <sect5><title>sect5 標題</title>
            <para>sect5 文字段落...</para>
          </sect5>
        </sect4>
      </sect3>
    </sect2>
  </sect1>
</chapter>

article 的根標籤基本結構,就是把那根標籤名稱從 chapter 換成 article 就成了。

至於 book 這個很有份量的根標籤是由數個 chapter 或 article 組成,所以book 根標籤的結構應該是類似這樣:

Example 1-7. book 基本的層級結構

<book><title>書籍名稱</title>
  <chapter><title>章標題</title>
    <para>章引言... </para>
    <sect1><title>節標題</title>
      <para>節內容... </para>
      <para>節內容... </para>
    </sect1>
    ......
  </chapter>
  <chapter><title>章標題</title>
    <para>章引言... </para>
    ......
  </chapter>
  ......
</book>

有了基本根標籤結構還不能稱為完整的 DocBook 文件,我們還要為它們加上 SGML 標記語言規則所要求的文件型態定義宣告。依 DocBook 是採用 SGML or XML 宣告方式,一個完整 DocBook 文件模型應該是:

Example 1-8. book 的 SGML 文件模型

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<book><title>書籍名稱</title>
  <chapter><title>章標題</title>
    <para>章引言... </para>
    ......
  </chapter>
  ......
</book>

Example 1-9. book 的 XML 文件模型

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN">
<book><title>書籍名稱</title>
  <chapter><title>章標題</title>
    <para>章引言... </para>
    ......
  </chapter>
  ......
</book>

如果你想要把根標籤換掉,比方是 article ,那你的 DocBook 表示方法應該是:

<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN">
            (1)
<article><title>研究主題</title>
  <sect1><title>標題</title>
    <para>引言... </para>
    ......
  </sect1>
  ......
</article>

(1)
文件的根標籤要與 SGML 定義宣告區 DOCTYPE 裡的根標籤宣告相同。

掌握這些範例的文件基本模型,就可以掌握基本的 DocBook 寫作技巧,也就可以開始製作你自己的 DocBook 文件了。就算你用這些陽春結構,一樣可以通過 SGML 編譯轉換器的轉換,產生方便閱讀的其他格式文件,或者建立了 Text Base 的樹狀資料庫,它沒有任何結構的缺陷或不完整。所以剩下的其他,都只是使你文件形式更豐富,功能更多樣而已,供你行有餘力而為。所以,下面我們要介紹一些能增加你文件的表現形式或特殊功能的標籤用法,首先,我們介紹一些類似於 HTML 格式的資料,然後再談一些 DocBook 自己所有的特殊用法。


1.7. 條列資料表示法

縱使文字敘述區塊 para 的使用率,佔了 DocBook 顯示資料的七八成,但有些資料顯示,用別的格式卻遠比 para 更恰當及有表現力。譬如同質的數筆資料,使用條列式就比區塊式敘述要好。


1.7.1. 單行條列式

以 HTML 標記語言為例,如果我們將電腦的所有設備分類加以陳述,大概呈現方法是:

Example 1-10. HTML 的編號列示資料表示法

<ol>
  <li>處理設備</li>
  <li>儲存設備</li>
  <li>輸入設備</li>
  <li>輸出設備</li>
</ol>

Example 1-11. DocBook 的編號列示資料表示法

<orderedlist>
  <title>電腦設備分類列表</title>
  <listitem><para>處理設備</para></listitem>
  <listitem><para>儲存設備</para></listitem>
  <listitem><para>輸入設備</para></listitem>
  <listitem><para>輸出設備</para></listitem>
</orderedlist>

DocBook 的列示資料表示法比 HTML 多的是 title ,不過這是選項的,也就是如果你希望為你的列示區塊下個標題,你就可以用 title 標籤,不只列示資料區塊是如此,幾乎所有的區塊皆是如此。此外除了有編號列示區塊表示法之外,還有種無編號列示資料表示法:HTML 是用 ul 取代 ol , SGML 則是用 itemizedlist 取代 orderedlist ,其他子結構則完全相同。

所以一個完整的文件範例應該是:

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>電腦設備簡介</title>
  <sect1><title>電腦設備分類</title>
    <para>我們可將電腦所有使用設備粗分為下列類別:</para>
    <orderedlist><title>電腦設備分類列表</title>
      <listitem><para>處理設備</para></listitem>
      <listitem><para>儲存設備</para></listitem>
      <listitem><para>輸入設備</para></listitem>
      <listitem><para>輸出設備</para></listitem>
    </orderedlist>
  </sect1>
</chapter>


1.7.2. 兩段條列式

兩段條列式的結構和一般詞彙解釋的結構安排相同,就是前面一個簡短名詞當作一個段落,後面的解釋敘述當作另一個段落。形成一個既有所分別,又互相隸屬的關係。如果你熟悉 HTML ,那麼 dl 標籤是一個很好的詮釋:

Example 1-12. HTML 的兩段條列式資料表示法

<dl>
  <dt>SGML</dt>
  <dd>Standard Generalized Markup Language(一般標準標記語言)</dd>
  <dt>XML</dt>
  <dd>Extensible Markup Language(可延伸標記語言)</dd>
  <dt>HTML</dt>
  <dd>HyperText Markup Language(超文字標記語言)</dd>
</dl>

Example 1-13. DocBook 的兩段條列式資料表示法

<variablelist>
  <varlistentry>
    <term>SGML</term>
    <listitem><para>Standard Generalized Markup Language
      (一般標準標記語言)</para></listitem>
  </varlistentry>
  <varlistentry>
    <term>XML</term>
    <listitem><para>Extensible Markup Language
      (可延伸標記語言)</para></listitem>
  </varlistentry>
  <varlistentry>
    <term>HTML</term>
    <term>XHTML</term>
    <listitem><para>HyperText Markup Language
      (超文字標記語言)</para></listitem>
  </varlistentry>
</variablelist>

如果你夠細心,你會看出我在 DocBook 兩段條列式範例中,在第三條用了兩個 term 標籤,這不是錯誤。而是 DocBook 的兩段條列式允許用數個簡短名詞排列在一個區段,但只允許用一個解釋敘述區段。這和 HTML 的一個簡短名詞配一個解釋敘述的方法,有小小的差異。

現在讓我們做個完整的 article 文件吧:

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<article><title>格式文件概論</title>
  <sect1><title>常見的格式文件形式</title>
    <para>我們常接觸到的標記語言文件有下列幾種:</para>
    <variablelist>
      <varlistentry>
        <term>SGML</term>
        <listitem><para>Standard Generalized Markup Language
          (一般標準標記語言)</para></listitem>
      </varlistentry>
      <varlistentry>
        <term>XML</term>
        <listitem><para>Extensible Markup Language
          (可延伸標記語言)</para></listitem>
      </varlistentry>
      <varlistentry>
        <term>HTML</term>
        <term>XHTML</term>
        <listitem><para>HyperText Markup Language
          (超文字標記語言)</para></listitem>
      </varlistentry>
    </variablelist>
  </sect1>
</article>


1.7.3. 簡單條列資料

如果你的條列資料既不需編號,也不需要前面加個小圖示,只要分行顯示就好,那麼 DocBook 提供一個 simplelist 標籤來達成目的。HTML 並沒有這樣相對應的標籤,範例表示法如下:

Example 1-14. DocBook 的簡單列示資料表示法

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>唐詩選粹</title>
  <simplelist>
    <member>渭城朝雨浥輕塵</member>
    <member>客舍青青柳色新</member>
    <member>勸君更進一杯酒</member>
    <member>西出陽關無故人</member>
  </simplelist>
</chapter>


1.8. 表格資料表示法

表格資料最常見的就是我們資訊處理時的資料報表輸出格式,由數個欄位集合成一筆紀錄,由數筆記錄形成一張資料表。輸出時,依紀錄分行,依欄位分列,排列整齊成一個頁面。


1.8.1. 表格結構分析

不管是 DocBook 還是 HTML ,表格資料的區塊標籤都叫 table ,但 DocBook 的表格資料則有些複雜,第一次嘗試的人常常容易搞混了。所以,本文將 table 的結構,由下而上做一個分析解釋,當你弄懂了彼此關係後,就不會再被那些標籤名詞搞得眼花撩亂。

 

表格資料組成分析列示表

entry

表格資料最小的組成單位,相當於資料表中的欄位或 cell,輸出樣式是一行字串中的一小段。

row

集合數 entry 而成一個 row,相當於資料表中的紀錄或 line,輸出樣式是一整行字串。

thead, tfoot, tbody

表頭,表尾,表身,這三者都是由數個 row 組合而成。三者中以表身為主體,也是一個 table 不可缺少的部份,其他表頭,表尾是選項,可依需求決定要或不要。這裡還有個要注意,如果表格中要用到表尾,他必須排列在表身主體之前,這裡我們把 tbody 放 tfoot 之後,不是疏忽,而是 DocBook DTD 定義要求如此。

colspec

colspec 本身並不容納任何資料,它是一個空標籤。它的目的在指明一個表格群組的每個欄位,應該有那些屬性,並賦予某些欄位名稱,以作為同表格中其他 entry 呼叫時的參考。

tgroup

由 colspec,thead,tfoot,tbody 四者組成的,就叫一個 tgroup,這也是表格資料顯示的主體。

table

將表格資料主體 tgroup 加上一些標題和附屬說明敘述,就構成了一個 table 的標籤結構。


1.8.2. 單一形式表格表示法

上一節我們清楚了表格的基本結構後,要寫個單一形式的表格就十分容易了,譬如說我們來設計個人電腦的市場價格報告單:

Example 1-15. DocBook 單一形式表格

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>表格資料範例</title>
  <table><title>PC 系統估價表</title>
    <tgroup cols="5">        <!-- 註1 -->
      <thead>
        <row>
          <entry>品名</entry>
          <entry>鴻騎</entry>
          <entry>華梭</entry>
          <entry>紅海</entry>
          <entry>備註</entry>
        </row>
      </thead>
      <tbody>
        <row>
          <entry>主機</entry>
          <entry>6500</entry>
          <entry>7000</entry>
          <entry>4500</entry>
        </row>
        <row>
          <entry>硬碟</entry>
          <entry>4330</entry>
          <entry>5200</entry>
          <entry>3700</entry>
        </row>
        <row>
          <entry>監視器</entry>
          <entry>7235</entry>
          <entry>11000</entry>
          <entry>8000</entry>
        </row>
      </tbody>
    </tgroup>
  </table>
</chapter>

 

註1

每個 tgroup 標籤裡都要設定 cols 數目,表示這個表格組一共有幾個欄位。


1.8.3. 跨行列表格資料表示法

上一節的範例就是個中規中矩的表格資料,大多數的資料表也都是這個樣。但如果更考究些,上面的表格表示法似乎仍有改進的空間,因為鴻騎,華梭,紅海這三個欄位,到底是什麼意思,有時令人無法確定。如果我們加個表頭欄位 [販售商],那麼一眼就讓人看明白他們被做了那種歸類。問題是要把鴻騎,華梭,紅海這三個欄位跟販售商建立關係,我們習慣用一個跨欄格子來表示,要顯示跨欄,就必須使用到 tgroup 標籤裡的 colspec 標籤。下面是 colspec 使用範例:

Example 1-16. DocBook 跨行列表格

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>表格資料範例</title>
  <table><title>PC 系統估價單</title>
    <tgroup cols="5">
      <colspec colnum="1" colname="c1" align="center">  <!-- 註1 -->
      <colspec colnum="2" colname="c2" align="right">   <!-- 註2 -->
      <colspec colnum="3" colname="c3" align="right">
      <colspec colnum="4" colname="c4" align="right">
      <colspec colnum="5" colname="c5" align="left">    <!-- 註3 -->
      <thead>
        <row>
          <entry morerows="1" valign="middle">品名</entry>  <!-- 註4 -->
          <entry namest="c2" nameend="c4" align="center">販售商</entry>  <!-- 註5 -->
          <entry morerows="1" valign="middle" align="center">備註</entry>  <!-- 註6 -->
        </row>
        <row>    <!-- 註7 -->
          <entry align="center">鴻騎</entry>
          <entry align="center">華梭</entry>
          <entry align="center">紅海</entry>
        </row>
      </thead>
      <tbody>
        <row>
          <entry>主機</entry>
          <entry>6500</entry>
          <entry>7000</entry>
          <entry>4500</entry>
        </row>
        <!-- 以下資料同上一表格範例,省略 ...... -->
      </tbody>
    </tgroup>
  </table>
</chapter>

 

註1

colnum 標示第幾個欄位,colname 表示你要為此欄位取什麼樣的參考名稱,align 設定 center 是希望品項名稱擺中間。

註2

align 設定 right 是希望金額數字靠右顯示。

註3

align 設定 left 是希望備註字串從左開始顯示。

註4

morerows 屬性設定垂直跨行數目,0 是不跨,1 是跨一行,依此類推。之所以要讓[品名]這個 entry 垂直跨行,是因為表頭已被設為兩行。valign 設定 middle 表示垂直置中顯示。

註5

namest 是設定水平跨欄顯示的開始欄位名稱,也就是 tgroup 一開始用 colspec 為欄位取的參考名稱,nameend 是設定終止欄位名稱。namest 和 nameend 的成對使用,就標示出跨欄的開始和終止,這裡是從第二欄位到第四欄位。align 設定 middle 是希望不要像 colspec 的要求靠右,而是置中顯示。

註6

[備註] 這個 entry 必須設定 morerows 屬性的理由同註4。

註7

鴻騎,華梭,紅海這三個 entry 被改分到下個 row 去,由於第二個 row 的第一個 entry 已經被[品名]這個 entry 跨行佔掉,所以他們就被擠到第二個 entry 開始,也就剛好是[販售商]的下方。


1.8.4. 為表格增加說明訊息

表格是格式非常嚴謹的資料,必須由同質資料項排列整齊才有意義。但一份資料總有些例外的狀況,不適合加入表格的行列中,但遺棄更不妥當。此時,我們就可以用 textobject 標籤來收納一些不適合放在列表中,但卻很重要的附加訊息。範例如下:

Example 1-17. DocBook 附加說明訊息表格

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>表格資料範例</title>
    <textobject>
      <blockquote><attribution>調查員老貢生於 xxxx 年 xx 月 xx 日</attribution>
      <simplelist>
          <member>貨幣單位:新台幣</member>
          <member>調查範圍:台灣北部</member>
          <member>其他事項:資料全憑杜撰,有與事實相符不符者,皆屬巧合,恕不負責。</member>
        </simplelist>
      </blockquote>
    </textobject>
  <table><title>PC 系統估價單</title>
    <tgroup cols="5">
      <!-- 以上資料同上一表格範例,省略 ...... -->
      <tbody>
        <row>
          <entry>主機</entry>
          <entry>6500</entry>
          <entry>7000</entry>
          <entry>4500</entry>
        </row>
        <!-- 以下資料同上上一表格範例,省略 ...... -->
      </tbody>
    </tgroup>
  </table>
</chapter>

 

Note

table 標籤區塊的結構,一定要有個 title 的子標籤(DocBook DTD 定義的)。如果你不要你的表格有標題,請改用 informaltable 標籤。它除了沒有 title 之外,其他結構與 table 相同。


1.9. 外部其他媒體格式檔案表示法

就如同 HTML 所宣稱的,超文字標記語言,不只是純文字資料可以被傳送處理,非純文字型態的其他媒體格式資料,也可以透過 HTML 來傳送。其中最普遍利用的當然就是圖形資料了,HTML 插入其他媒體資料的標籤是 img, DocBook 最簡單的方式是使用 graphic 標籤。

你可以在你想要插入圖形的敘述中,插入 graphic 標籤來顯示一個圖片:

Example 1-18. DocBook 的圖形資料顯示

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>Linux 系統的吉祥動物</title>
  <blockquote><attribution>吉祥動物的顯示樣式</attribution>
  <para>可不要以為企鵝是因為動物園裡的小國王企鵝烏麻薯
        才名聲大噪的喔。早在 Linux 創始人 Torvalds 先生
        選定企鵝作為 Linux 的吉祥物後,
        <graphic fileref="penguin.gif" format="GIF">
        企鵝就活躍在每一台使用 Linux 為作業系統的電腦中
        。</para></blockquote>
</chapter>

 

可不要以為企鵝是因為動物園裡的小國王企鵝烏麻薯才名聲大噪的喔。早在 Linux 創始人 Torvalds 先生選定企鵝作為 Linux 的吉祥物後:

企鵝就活躍在每一台使用 Linux 為作業系統的電腦中。

 

 
--吉祥動物的顯示樣式 

至於其他形式的外部檔案, DocBook 是使用 mediaobject 這個標籤來處理。它的主要結構並不複雜,表列如下:

Table 1-1. mediaobject 主要組成列表

第一層標籤第二層標籤第三層標籤備註
mediaobjectvideoobjectobjectinfo

如同 imageobject 標籤備註

videodata
audioobjectobjectinfo

如同 imageobject 標籤備註

audiodata
imageobjectobjectinfo

本物件的附加訊息或詮釋資料

imagedata

imagedata 是用來指明外部媒體檔案位址的空標籤,它用 fileref 屬性指向的,可能是本機位址,也可以是網路位址。

textobjectobjectinfo

如同 imageobject 標籤備註

textdata

所以同樣的資料內容,如果要改用 mediaobject 標籤的話,應該採用下列範例的表示法。這個標籤比 graphic 標籤更多的利用是,不只圖形,其他影音格式檔案也有適當的標籤加以表示,方法和 imageobject 差不多。

Example 1-19. DocBook 的外部多媒體資料顯示

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>Linux 系統的吉祥動物</title>
  <mediaobject>
    <imageobject>
      <imagedata fileref="penguin.gif" format="GIF">
    </imageobject>
    <caption><para>可不要以為企鵝是因為動物園裡的小國王企鵝烏麻薯
        才名聲大噪的喔。早在 Linux 創始人 Torvalds 先生選定企鵝作
        為 Linux 的吉祥物後,企鵝就活躍在每一台使用 Linux 為作業
        系統的電腦中。</para></caption>
  </mediaobject>
</chapter>

此外不管是 graphic or mediaobject ,DocBook 都提供了一個相對應的標籤 inlinegraphicinlinemediaobject 。這是因為不管是 graphic or mediaobject ,都是區塊標籤。DocBook 對區塊標籤顯示的處理方式都是不管他的前面是否有結束標籤出現,一律截斷原來的那行文字,另起一個新段落,我們看上面的 Linux 系統的吉祥動物 範例顯示即可知。

那如果我們希望圖片和文字不要切做兩行,而是合在一行裡顯示該怎麼辦呢?那就是 inlinegraphicinlinemediaobject 這兩個標籤派上用場的時候了。譬如我們的範例是:

Example 1-20. DocBook inline 標籤的使用

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>3ybaby 命名的由來</title>
  <blockquote><attribution>台灣企鵝寶寶工作隊文告</attribution>
    <para>台灣企鵝寶寶工作隊希望為台灣的學齡兒童創造一個</para>
      <simplelist>
        <member><inlinegraphic fileref="lpen.png" format="PNG">more easy</member>
        <member><inlinegraphic fileref="lpen.png" format="PNG">more funny</member>
        <member><inlinegraphic fileref="lpen.png" format="PNG">more steady</member>
      </simplelist>
    <para>的資訊操作環境。</para>
  </blockquote>
</chapter>

而呈現出來的輸出樣式如下:

 

台灣企鵝寶寶工作隊希望為台灣的學齡兒童創造一個

 

more easy
more funny
more steady

 

的資訊操作環境。

 
--台灣企鵝寶寶工作隊文告 

 

NoteDocBook 能使用的多媒體格式
 

一般來說多媒體標籤會透過 format 屬性來描述外部檔案的格式,而 DocBook DTD 裡也規定了大部分網路上各種通用多媒體格式的簡稱。但很重要的一個觀念是,DocBook 本身不負責任何資料的顯示,所以最終這些格式檔案能否被正確處理,是要由各種格式檔案的瀏覽器功能來決定,DocBook 只負責告訴處理程式,檔案位置在那裡,是那種通用的型態格式而已。


1.10. 書籤與聯結的表示法

整個 HTML 標籤裡面最令人欣喜的功能,莫過於 Anchor 了。Anchor 在 HTML 中主要的功能是賦予閱覽者改變預設的閱讀順序,而能像跳躍一般的離開現在的文字敘述,進入另一個敘述區段中,它賦予讀者主動控制的權力,讓 HTML 文件產生其他形式文件無可比擬的魅力。DocBook 一樣也提供了這樣的表示方法,不過和 HTML 不同的是,不管是文件內部的跳躍(一般我們稱為書籤功能),或是文件到另一個文件的跳躍(一般我們稱為聯結),HTML 一概是使用 a(anchor 的縮寫)來表示,但 DocBook 在這方面卻有更詳細的劃分和使用方式,下面就為大家一一介紹。


1.10.1. link(書籤)的表示法

我們這裡所說的書籤,是指不管閱讀動線跳躍的啟動點和目標點,都在同一份文件中。把目標點稱為書籤,而在啟動點,我們會給些訊息文字,讓閱覽者決定是否執行跳躍動作。

在 HTML 中,不管是書籤(跳躍的目的端)的插入,或是跳躍啟動點的表示,都是同樣的用 a 標籤,只是動用的標籤屬性不同來區別而已。範例如下:

Example 1-21. HTML 的書籤表示法

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head></head>
<body>
  <h2>文件中的跳躍</h2>
  <div><p>
    <a name="para-a"></a>  <!-- 註1 -->
    這是第一個段落。</p>
  </div>
  <div><p>
    這是第二個段落。<a href="#para-a">回到第一個段落</a>  <!-- 註2 -->
  </p></div>
</body></html>

 

註1

跳躍的目標點(書籤位置),使用屬性 name 來賦予該標籤一個特定名稱,以便跳躍啟動點參考。

註2

跳躍的啟動點,屬性 href 標明要跳到那個目標去,開始標籤和結束標籤中間,是給讀者的提示訊息。

但對 DocBook 來說,閱讀動線跳躍的啟動點和目標點是兩個不同的標籤,目標點是 anchor ,啟動點是 link ,不能互相混用的。範例如下:

Example 1-22. DocBook 的書籤表示法(1)

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>文件中的跳躍</title>
  <para>
    <anchor id="para-a">
    這是第一個段落。
  </para>
  <para>
    這是第二個段落。<link linkend="para-a">回到第一個段落</link>
  </para>
</chapter>

 

Warning

DocBook link 標籤的 linkend 屬性字串前,不可以加 '#' 字符,這和 HTML a 標籤的 href 字串要加 '#' 前置字符是不一樣的。

其實在 DocBook 文件中任何一個附帶有 title 的區塊標籤,只要你設定了它的 id 屬性,他就可以變成一個跳躍的目標點。譬如:

Example 1-23. DocBook 的書籤表示法(2)

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>文件中的跳躍</title>
  <para>章引言...</para>
  <sect1 id="se1"><title>第一節</title>
    <para>
      這是第一節段落。
    </para>
  </sect1>
  <sect1><title>第二節</title>
    <para>
      這是第二節段落。<link linkend="se1">回到第一節</link>
    </para>
  </title>
</chapter>


1.10.2. ulink(聯結)的表示法

在這裡我們把聯結定義為,閱讀動線跳躍目標在本份 DocBook 文件以外的其他文件上,而在本文所作的跳躍啟動點表示,DocBook 用 ulink 標籤來表示這種關係狀態。ulink 是 URL link 的簡寫,意思是指凡是能以 url 格式表示檔案位址的資料聯結皆可使用,這包括你本機某個標明路徑的檔案,或某份在網路上流通的文件。下面是它的範例:

Example 1-24. DocBook 的聯結表示法

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>跳到別的文件</title>
  <para>
    我可以找個自己機器中的
    <ulink url="file:///etc/passwd">/etc/passwd</ulink>看看。
  </para>
  <para>
    也可以到網路上參觀參觀
    <ulink url="http://www.gnu.org">GNU 組織</ulink>。
  </para>
</chapter>


1.10.3. 電子郵件信箱的表示法

在 DocBook 中你可以像 HTML 一樣,使用 a 標籤的 href 屬性設定電子郵件信箱位址來啟動瀏覽者的發信功能,不過你把標籤改作 ulink 而已。像下面的敘述可以達到如 HTML E-Mail 啟動的效果。

<ulink url="mailto:使用者帳號@信箱位址">提示訊息</ulink>

雖然在轉換成 HTML 後效果一樣,但一律使用 ulink 標籤卻讓我們無法正確分類那些是啟動外部瀏覽網頁的聯結,而那些又是啟動發送電子郵件的聯結。為了實現 DocBook 清楚分類文件內容的設計理念,我認為在發送電子郵件的表示上,該用另一個標籤 email 。這標籤啥學問都沒有,表示法就如下列簡單一行而已,但卻讓我們清楚的定義,這是一個 E-Mail ,不是其他網頁文件的 URL 。

<email>使用者帳號@信箱位址</email>


1.10.4. xref(你的標題我顯示)

除了提供類似 HTML 聯結表示法的 anchor,link,ulink,email 外,一個 DocBook 文件如果被轉譯器轉換成 HTML 格式文件,轉譯器會自動幫它換算插入大量的聯結目的及啟動提示訊息的表示敘述,譬如自動產生文件章節目錄,都是透過連結敘述達成的。除了自動產生的連結敘述外,DocBook 另外提供了比 HTML 連結敘述表示法更多功能的連結敘述表示法,後面的小節,我們將介紹一些非常好用的,DocBook 特有的連結敘述表示法。

首先我們要談的是 xref 這個標籤,這個標籤粗看起來,和 link 標籤的用法沒啥分別,例如:

link 與 xref 的表示法

<link linkend="目的標籤的 ID 字串">連結啟動提示訊息</link>
<xref linkend="目的標籤的 ID 字串" />

除了 xref 是個空標籤,不需像 link 標籤容納連結啟動的提示訊息外,其他的表示敘述幾乎完全一樣。但這只是在 DocBook 陳述上相同,但它代表的意義和轉換成輸出格式後的表現卻截然不同。我們可以試著編譯下例看看:

Example 1-25. xref 與 link 輸出結果比較

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>目錄示範</title>
  <formalpara><title>簡單目錄表</title>
    <para><orderedlist>
      <listitem><para><link linkend="exa">詩選一</link></para></listitem>
      <listitem><para><xref linkend="exa"></para></listitem>
      <listitem><para><xref linkend="exa" endterm="exatitle"/></para></listitem>
                          <!-- 註1           註2 -->
    </orderedlist></para>
  </formalpara>
  <example id="exa">
    <title id="exatitle">鄭愁予詩選</title>
    <simplelist>
      <member>我答答的馬蹄</member>
      <member>是個美麗的錯誤</member>
      <member>我不是歸人</member>
      <member>是個過客</member>
    </simplelist>
  </example>
</chapter>

 

註1, linkend

標明連結目標點何在的屬性,瀏覽器依其字串值前往指定的敘述區塊。

註2, endterm

表明這個連結的啟動提示訊息,要根據那個 title 的內涵值來顯示。

簡單目錄表.

 

  1. 詩選一

  2. Example 1-26

  3. 鄭愁予詩選>

 

Example 1-26. 鄭愁予詩選

 

我答答的馬蹄
是個美麗的錯誤
我不是歸人
是個過客

 

由以上的範例訊息可知,不管是 link or xref 都需要在連結的啟動點處顯示啟動提示訊息,但 link 的提示訊息是由標籤自身內容字串決定的,一旦寫定就不會更改。但 xref 的啟動點的提示訊息,卻是由連結目標點的 title 內容字串決定的,這也就是本節標題附註,你的標題我顯示的含意。如果只是單純使用 linkend 屬性,xref 通常是由 DSSSL 樣式表設定來推算啟動提示訊息,如果加設 endterm 屬性,那麼會把指定 ID 的 title 內容字串,當作啟動提示訊息。

這個不以標籤本身的內容,而是以被連結端的標題為啟動提示訊息的特性,在製作文件索引上有很大的功用。因為當你要改文件內容時,你不需要內容和索引各改一次,你只要更改內容,再跑一次轉換編譯,索引就會跟著一併更正。此外在多人撰寫共同文件上這也是一大重要功能,因為撰寫共同文件時,文件內容常由組織成員分別擔任,但文件總目錄則由負責人控管,使用 xref 在總目錄上,可以讓組織成員在想要更改自己那部份的文件標題時,不需事先協調總目錄負責人,他只要更改他自己這部份,最後改變的結果就會反應到總目錄上。


1.10.5. footnote and footnoteref

相信你在正式一點的書籍手冊或文件上,都會看到這樣的一種格式,如下列:

文件註腳的顯示

HTML 是一種由 SGML [1] 所定義出來的標記語言,又稱為超文字標記語言。他制定的目的是希望將文章的內容就顯示方式的不同加以分類,並制定成為一種通行於網路的共同標準。

DocBook 也是一種由 SGML [1] 定義出來的標記語言,它設計的目的不是為了敘明應該如何被呈現和顯示。而是在說明一個嚴謹的有組織的書籍,手冊或論文,應該包括那些內容組成,以及這些內容成份,該如何組織起來成一個有體系的架構。

 

[1]

SGML 是 Standard Genralized Markup Language 的縮寫,中譯為通用標準標記語言。這是一種描述文件分類及組織架構的表示語法,透過在文件中插入標記資料,來做文件內容分類和組織。及共同利用的目的。

它的表示法範例如下:

Example 1-27. DocBook 註腳連結表示法

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>註腳示範</title>
  <blockquote>
    <para>HTML 是一種由 SGML
      <footnote id="sgmlref"><para>SGML 是 Standard Genralized Markup
       Language 的縮寫,中譯為通用標準標記語言。這是一種描述文件分類及
       組織架構的表示語法,透過在文件中插入標記資料,來做文件內容分類
       和組織。及共同利用的目的。</para></footnote>
       所定義出來的標記語言,又稱為超文字標記語言。他制定的目的是希望
       將文章的內容就顯示方式的不同加以分類,並制定成為一種通行於網路
       的共同標準。</para>
  </blockquote>
  <blockquote>
    <para>DocBook 也是一種由 SGML
     <footnoteref linkend="sgmlref">
     定義出來的標記語言,它設計的目的不是為了敘明應該如何被呈現和顯示
     。而是在說明一個嚴謹的有組織的書籍,手冊或論文,應該包括那些內容
     組成,以及這些內容成份,該如何組織起來成一個有體系的架構。</para>
  </blockquote>
</chapter>

由上面範例可知,在 DocBook 文件中,你需要對某個特殊名詞另做深入解釋時,只需要在該名詞後加一個 footnote 區塊即可。在做輸出格式轉換時,轉譯器自動會為你抽離 footnote 敘述,移到頁尾當註釋區塊,並在原註解處留下一個自動編號的索引連結。按一下索引連結到註釋,在註釋前按一下索引編號又回到原文閱讀處,一切由系統自動幫你設定,這麼好用又專業的標籤,不用真是糟蹋了。

 

Note

曾經做過的 footnote 區塊可藉由設定 ID 屬性,供其他 footnoteref 標籤做註釋參考,範例第二段即為此例用。

 

Note

footnote轉換輸出格式後的註釋區塊都集中放置於頁尾,所以如果你在執行轉換格式時,命令參數有加 -V nochunks(不分頁的全文件顯示),那麼很可能好幾個章節的註釋都會集中一起,放文件尾端,而不是一章一節的分別放置,這多少會造成參考上的困擾,所以當你在使用 -V nochunks 參數時,要有這個認識才好。


1.11. 其他區塊資料的表示法

前面敘述已經提過 para 是 DocBook 眾標籤中,最基本的區塊敘述,也幾乎可以說是文件內容組成的本體。但如果你想做一段敘述,型態和 para 差不了多少,但代表的意義和一般敘述不同,DocBook 提供你一些其他區塊標籤使用。這些區塊標籤結構最基本的組成是一個 para 加一個可選用的 title,他們可以插在任何 para 能插入的地方,做你在 para 中能做的事,但代表和 para 一般敘述不一樣的意義。下面就為你介紹一些 DocBook 中常用的,和 para 很像的其他區塊標籤表示法。


1.11.1. blockquote--引用表示法

這個標籤在 HTML 裡也常被使用,多半作為縮排的版面控制之用。但 DocBook 文件基本上是反對任何版面樣式設定資料參雜在文件中,所以 blockquote 在 DocBook 中的意義不是縮排,而是引用,也就是把存在別的文獻中的資料,或與目前本文非一類的資料,插入本文敘述中。例如下面的例子:

 

滕王閣序

落霞與孤鶩齊飛,秋水共長天一色。

 
--唐朝 王勃 

表示法的範例是:

Example 1-28. 引用資料表示法

  <blockquote>
    <title>滕王閣序</title>
    <attribution>唐朝 王勃</attribution>
    <para>落霞與孤鶩齊飛,秋水共長天一色。</para>
  </blockquote>

由範例可知上面的 blockquote 基本上由 title,attribution,para 構成,title 是這引用區塊的標題,attribution 是引用區塊的資料出處,至於 para 還是原來用法,負責展示資料內容。


1.11.2. figure--圖解表示法

圖表對於某些繁雜的文字敘述,常有以簡馭繁,畫龍點睛之效,所以在很多技術書籍文件上,圖表也是資料的一個重要類別。譬如 DocBook 的 DTD 文件是由許多附屬子文件組織起來的,要說明他的各部份及彼此關係,實是耗費言詞的一大挑戰,所以這時我們用個 figure 來圖表說明一番,反而有更好的效果。

Figure 1-1. DocBook DTD 文件組成結構圖

上面這個圖解的 DocBook 表示法如下一個範例:

Example 1-29. 圖解說明的表示法

  <figure><title>DocBook DTD 文件組成結構圖</title>
    <graphic fileref="pictureURL">
  </figure>


1.11.3. example--範例表示法

在許多使用者導讀或技術手冊裡,幾乎不可免的,你必須模擬出一個可行步驟來提供閱覽者模仿操作,一般我們稱這為範例資料,亦如本手冊,你可以看見大量的範例區塊資料被使用。你可以把範例(example) 看作是一個 title 加一個 para 的基本型態,但也可以用其他與 para 同層級的資料區塊來取代 para ,範例如下:

Example 1-30. 範例說明的表示法

  <example><title>安裝 OpenJade 的步驟</title>
    <orderedlist>
      <listitem><para># tar -zxvf openjade-1.3.x.tar.gz</para></listitem>
      <listitem><para># cd openjade-1.3.x</para></listitem>
      <listitem><para># ./configure --prefix=/usr/local/lib/openjade</para></listitem>
      <listitem><para># make</para></listitem>
      <listitem><para># make install</para></listitem>
    </orderedlist>
  </example>


1.11.4. 其他的一些類似 para 標籤

DocBook 還有些資料區塊標籤的設立,並不是因為資料格式的特別,而是要賦予該資料強調或特殊意義。例如下面的表列,可以是前面討論的資料區塊任一種,但特別蘊含了某種意義,這蘊含的意義相信你看標籤的功能敘述即可一目了然。

Table 1-2. 特殊意義的區塊標籤

標籤名稱cautionimportantnotetipwarning
訊息分類注意重要備註訣竅警告

這些類 para 區段標籤除了多加個選項性質的 title(可用可不用)外,其他表示方法一如前面的各種區塊資料,例如:

Example 1-31. tip 區塊表示法

<tip>
  <para>
  為章節的區塊標籤加設 ID 屬性的話,到執行翻譯轉換成 HTML 分頁輸出
  格式時,會以該章節的 ID 字串作為網頁的檔案名稱。
  </para>
</tip>

輸出樣式為:

 

Tip

為章節的區塊標籤加設 ID 屬性的話,到執行翻譯轉換成 HTML 分頁輸出格式時,會以該章節的 ID 字串作為網頁的檔案名稱。


1.12. 字串強調表示法

與前面特殊區塊不同的是,字串強調標籤僅在標示一個字串,而非一整個段落,常用的特殊字串標籤有下列各項。


1.12.1. emphasis--強調

Example 1-32. 字串強調表示法

  <para>
  本文主要在介紹由 SGML 標記語言所定義出來的
  <emphasis>DocBook</emphasis>
  格式文件寫作方法。
  </para>

顯示樣式:

本文主要在介紹由 SGML 標記語言所定義出來的 DocBook 格式文件寫作方法。


1.12.2. subscript--字串下標

Example 1-33. 字串下標表示法

  <para>水的化學分子結構是 H<subscript>2</subscript>O</para>

顯示樣式:

水的化學分子結構是 H2O


1.12.3. suiperscript--字串上標

Example 1-34. 字串上標表示法

  <para>
  2<superscript> 2 </superscript> +
  3<superscript> 2 </superscript> =13
  </para>

顯示樣式:

2 2 + 3 2 =13


1.13. 其他標籤使用方法

1.13.1. 保留原來的版面樣式

SGML 系列的格式文件有一個共通的特性就是忽略排版字元,不管連續的空白字元,跳位字元,斷行字元,一律以一個空白字元代替。所以一般特定字元的位置設定在 DocBook 中是無效的。

如果我們要空白跳位斷行這些字元發揮其原有的功能,在 HTML 裡我們一律以 pre 這個標籤來代表。但 DocBook 卻有 literallayout, programlisting, screen, synopsis 這些標籤來表示。這些標籤的資料性質和顯示效果大同小異,之所以取不同名字,literallayout 表一般含格式文字,programlisting 表程式命令語法,screen 表示電腦終端顯示,synopsis 摘要表示。DocBook 轉換成 HTML 則都以 pre 標籤顯示。

Example 1-35. 版面格式表示法

<literallayout>
我躂躂的馬蹄
            是個美麗的錯誤
                          我不是歸人
                                    是個過客
</literallayout>

顯示樣式

我躂躂的馬蹄
            是個美麗的錯誤
                          我不是歸人
                                    是個過客


1.13.2. 特殊字元的顯示及除能

SGML 預設有下列的特殊功能字元:

Table 1-3. DocBook 特殊字元表

字元顯示ASCII 十進位碼實體字串功能敘述
<60&lt;標記開始字元
>62&gt;標記結束字元
&38&amp;實體字串前置字元
"34&quot;字串包夾字元

由上列表可知,由於這些字元負有協助標記解析的分隔資料功能,所以當其出現時,並非原來表示的字元含意了。這時如果我們仍要顯示其原本代表的字元,就必須用表列的實體字串來表示要顯示該字元的含意。

如果你想要解除這些特殊字元的標記分隔功能,讓他們去顯示他們原來的字元意義,那麼 SGML 一個通用的區段標記也適用在 DocBook。範例如下:

Example 1-36. 特殊字元除能表示法

<literallayout>
<![CDATA[
  <chapter><title>章標題</title>
    <para>章段落敘述 ...... </para>
  </chapter>
]]>
</literallayout>


Chapter 2. 特殊資料格式的標籤

在前一章談到的基本標籤表示法,不管那一種格式文件,都會利用的到。但既然 DocBook 主要的目的在 write a book,那麼我們就不能不介紹,一本書中,除了主要的章節敘述外,其他比較不一樣的資料格式,譬如說是作者出版資訊,版權宣告,參考書目,及詞彙索引等等。這些特殊格式資料的出現位置大抵如下:

Example 2-1. Book 的特殊資料區段位置

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<book><title>書籍名稱</title>
  <bookinfo>作者及其他相關出版訊息...</bookinfo>
  <dedication>作者序言...</dedication>
  <index>自製區段資料索引...</index>
  <chapter><title>章標題</title>
    <sect1><title>節標題</title>
      <para>節敘述...</para>
    </sect1>
  </chapter>
  <chapter><title>...</title>
    ......
  </chapter>
  <appendix><title>附錄</title>
    <qandaset>問題解答集...</qandaset>
    <qlossary>專業詞彙解釋...</qlossary>
    <bibliographic>參考書目...</bibliographic>
  </appendix>
</book>

至於上面的範例,格式並不完整,如果你直接將他交給解譯程式,通常不會有正確結果。之所以要如此表示,只是說明他們可能出現在一本書的那個位置,至於各特殊格式資料標籤的完整而合法的表示法,請看接下來的各章節。


2.1. 出版訊息表示法

DocBook 表示出版訊息的標籤是 bookinfo,解釋是 Meta-information,詮釋訊息,詮釋什麼呢?似乎仍然很隱晦。其實從實質內容組成來說比定義解釋容易令人恍然大悟,就是說明文件的作者,出版商,出版日期...等等,這些與書籍的主要目的無關,但又不能不交待的一些資料。

實際上 DocBook 的每個主要資料區塊都有他自己所屬的 info 標籤,如 book 的 info 標籤叫 bookinfo,chapter 的叫 chapterinfo ,article 的叫 articleinfo,甚至連 sect 也有 sectinfo,其他區塊也有的配有專屬的 blockinfo。至於為何 DocBook 不用統一的 info 來為所有這類區塊的標籤命名,而要不同的所屬有自己專屬名稱的 info 標籤?或許是一種策略選擇,統一的 info 命名比較好使用製作,但採用不同的名稱,保留了文件轉換輸出時,可以分別不同類型區塊的不同處理方式[10]

下面用本手冊的 bookinfo 範例來說明,當能讓你更明白 info 標籤的組成結構。更詳細的 bookinfo 及其他 info 的結構,請參考 DocBook 線上手冊

Example 2-2. bookinfo 出版訊息表示法

<bookinfo>
  <title>DocBook 文件寫作入門</title>
  <legalnotice><para>版權宣告敘述...</para></legalnotice>
  <abstract><para>書籍簡介敘述 ...</para></abstract>
  <authorgroup>  <!-- 作者群(可有許多作者) -->
    <author>                       <!-- 作者 -->
      <honorific>先生</honorific>  <!-- 尊敬稱謂 -->
      <firstname>...</firstname>
      <surname>...</surname>       <!-- 姓,家族名稱。 -->
      <othername>...</othername>   <!-- 別名,暱名。 -->
      <affiliation>                <!-- 所屬組織 -->
        <jobtitle>編輯</jobtitle>  <!-- 在組織中的職稱 -->
        <orgname>台灣企鵝寶寶工作隊</orgname>  <!-- 作者所屬組織名稱 -->
        <orgdiv>資料組</orgdiv>    <!-- 在組織中所屬部門名稱 -->
      </affiliation>
      <address>                    <!-- 作者真實世界的地址 -->
        <street>...</street>
        <postcode>...<postcode>
        <city>...</city>
        <state>...</state>
        <country>...</country>
        <phone>...</phone>
        <fax>...</fax>
        <email>xxx@xxx.xxx.tw</email>
      </address>
    </author>
    <editor>                       <!-- 編輯 -->
      <!-- 組成之子標籤同於 author 之子標籤 -->
    </editor>
  </authorgroup>
  <publisher>                      <!-- 出版者 -->
    <publishername>台灣企鵝寶寶工作隊</publishername>  <!-- 出版機構名稱 -->
    <address>
      <!-- 組成同於 author 之子標籤 address -->
    </address>
  </publisher>
  <revhistory>                     <!-- 出版紀錄,可以有很多版本。 -->
    <revision>                     <!-- 某一版本 -->
      <revnumber>n.n.n</revnumber> <!-- 版本編號 --> 
      <date>day/month/year</date>  <!-- 發佈出版日期 -->
      <authorinitials>...</authorinitials>  <!-- 作者簡稱識別 -->
      <revremark>第一次草稿</revremark>  <!-- 版本發佈簡述 -->
    </revision>
  </revhistory>
</bookinfo>


2.2. 作者序言表示法

相信你去書局買的書,在一切章節開始之前,打開書皮的前幾頁,多半少不了,會有一個作者自序,來介紹自己的著作經過或感謝一些人。也有的會邀請其他社會名望之士代為寫序,目的則是推薦,增加讀者購買信心。

不管這些事是否必要,或有那麼點給他無聊而多餘,既然它是個社會慣例,而你也不想太特立獨行,那就考慮使用 DocBook 的 dedication 來安排你的作者序言資料吧。

dedication 沒有太複雜的子標籤結構,你可以把他想成是 chapter 標籤去除掉 sect[n] 階層後的樣子,也就是 dedication 基本結構就是一個 title 配上幾個 para 或類似 para 的其他區塊標籤而成的。譬如:

Example 2-3. dedication 作者序言表示法

<dedication><title>我的感謝</title>
  <para>首先要感謝我爸...</para>
  <para>其次要感謝我媽...</para>
  <para>其次要感謝老師...</para>
  <para>其次要感謝社會...</para>
  ......
</dedication>

就是因為你不應該在序言裡廢話太多,惹得讀者不耐煩掉頭而去,所以 DocBook 只給你的序言一個最簡單的格式,希望你盡量簡短些。


2.3. 目錄索引表示法

在一般書籍的慣例中,章節及分類資料目錄索引就算是文件探討主題真正的開始了。DocBook 在做文件輸出格式轉換時,通常會將 chapter 和 sect 的 title 標籤內容自動編成章節目錄索引。但如果你希望在章節目錄之外,另加一些其他資料區段的目錄索引(譬如範例或圖表),你就必須自行在 DocBook 文件中加入 index 標籤結構。[11]

Example 2-4. index 目錄索引表示法

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
<chapter><title>自製目錄索引表示法</title>
  <index><title>圖表目錄</title>
    <indexdiv><title>一索引一標籤</title>
      <indexentry>
        <primaryie><xref linkend="t1" endterm="t1.title"></primaryie>
      </indexentry>
      <indexentry>
        <primaryie><link linkend="g1">Linux Logo</link></primaryie>
      </indexentry>
    </indexdiv>
    <indexdiv><title>一索引兩標籤</title>
      <indexentry>
        <primaryie>表格 1</primaryie>
        <secondaryie><xref linkend="t1" endterm="t1.title"></secondaryie>
      </indexentry>
      <indexentry>
        <primaryie>圖片 1</primaryie>
        <secondaryie><link linkend="g1">Linux Logo</link></secondaryie>
      </indexentry>
    </indexdiv>
  </index>
  <sect1><title>第一節</title>
    <para>第一節內容敘述......</para>
    <table id="t1"><title id="t1.title">縱橫相等表</title>
      <tgroup cols="3">
        <tbody>
          <row>
            <entry>1</entry>
            <entry>2</entry>
            <entry>3</entry>
          </row>
          <row>
            <entry>2</entry>
            <entry>3</entry>
            <entry>5</entry>
          </row>
          <row>
            <entry>3</entry>
            <entry>5</entry>
            <entry>8</entry>
          </row>
        </tbody>
      </tgroup>
    </table>
  </sect1>
  <sect1><title>第二節</title>
    <para>第二節內容敘述......</para>
    <figure id="g1"><title>Linux Logo</title>
      <graphic fileref="penguin.gif">
    </figure>
  </sect1>
</chapter>

由上範例可知,index 即為 DocBook 的目錄索引標籤,它主要由 indexentry 這個子標籤構成。index 可以直接包含 indexentry ,也可以透過 indexdiv(index divion 索引分部) 轉包含 indexentry 。在 index 中使用 indexdiv 表示 index 中還再細分群組,沒有使用 indexdiv 表示所有 indexentry 直接構成 index 一個整體。

一個 indexentry 可以只用一個位置指引 primaryie ,也可以用兩個位置指引:primaryie 和 secondaryie。不管是 primaryie or secondaryie ,都可以直接使用一般字串或其他資料區塊的 ID 識別。有關在 primaryie or secondaryie 中使用 ID 連結標籤的方法,請參考前一章基礎標籤的運用有關 xref and link 的說明。


2.4. 詞彙解釋表示法

任何一門專門學科總有些專有名詞,所以大部分專業書籍都喜歡在書籍最後附上一份專門詞彙解釋章節(glossary)。當然,本手冊也不能免俗的在手冊的附錄提供了份DocBook 參考字典。他的 DocBook 表示法敘述是:

Example 2-5. glossary 詞彙解釋表示法

<glossary><title>DocBook 的專有名詞</title>
  <para>本節提供一些 DocBook 的專有名詞解釋</para>
  <glossdiv><title>D</title>
    <glossentry id="dtd">
      <glossterm>Document Type Definitions</glossterm>
      <acronym>DTD</acronym>
      <glossdef>
        <para>文件型態定義:使用在 SGML 文件中,...<para>
        <glossseealso otherterm="sgml">SGML</glossseealso>
      </glossdef>
    </glossentry>
  </glossdiv>
  <glossdiv><title>S</title>
    <glossentry id="sgml">
      <glossterm>Standard Genralized Markup Language</glossterm>
      <acronym>SGML</acronym>
      <glossdef>
        <para>通用標準標記語言:一種描述文件分類及組織架構...</para>
      </glossdef>
    </glossentry>
  </glossdiv>
</glossary>

由上面範例可知,詞彙解釋(glossary)的基本組成是 glossentry ,它也如前一節 index 一樣,可以直接由 glossentry 構成,也可以由數個 glossdiv 包含 glossentry 構成。至於一個 glossentry 有下列的組成:

 

  1. glossterm:詞彙全名

  2. acronym:詞彙簡稱

  3. glossdef:

     

    1. para:詞彙解說敘述

    2. glossseealso:其他詞彙解釋區段索引

 

Note

一個 glossentry 要能被其他的 glossentry 的 glossseealso 參照到連結,必須設有 ID 屬性,這樣其他的 glossseealso 的 otherterm 屬性才能設定加以參照連結。如範例中 SGML 的 glossentry 必需先做 <glossentry id="sgml"> 這樣的表示,DTD 的 <glossseealso otherterm="sgml"> 才會真正產生連結作用。


2.5. 參考書目表示法

大部分的學術論文作者都喜歡在他的著作中專門使用一個章節,來條列一些相關主題的其他書籍或參考資料。雖然它真正會吸引起讀者深入探索的效果令人懷疑,但至少顯示出作者博覽群書,發言有憑有據。所以,如果你也想你的文件看起來很有專業的樣子,不妨使用 bibliographic 標籤來組織你的參考書目資料。

bibliographic 也和前幾節的 index,glossary 結構型態一樣大同小異,它可以直接由 biblioentry 構成,也可以由數個包含 biblioentry 的 bibliodiv 構成。使用 bibliodiv 表示將參考資料分成數個大類,如:書籍,期刊,線上文件...等。至於 biblioentry 的子結構,其實就是 info 結構,只不過因為是很多書籍的集中列表,所以不如單一書籍的 bookinfo 資料這麼詳細,寫得簡單省略些而已。下面是本手冊參考資料的範例:

Example 2-6. bibliography 參考書目表示法

<bibliography><title>參考資料</title>
  <para>當你第一眼看見本節,你會發覺所收集的參考資料不是很多...</para>
  <bibliodiv><title>線上資料</title>
    <biblioentry>
      <title>DocBook XML/SGML Processing Using OpenJade</title>
      <subtitle>
        <ulink url="&install.jade.url;">建立 DocBook 的解譯環境(中譯)</ulink>
      </subtitle>
      <authorgroup>
        <author>
          <firstname>Saqib</firstname>
          <surname>Ali</surname>
        </author>
        <author><othername>老貢生</othername></author>
      </authorgroup>
      <revhistory>
        <revision>
          <revnumber>1.0.0</revnumber>
          <date>2003-11-19</date>
        </revision>
      </revhistory>
    </biblioentry>
    <biblioentry>
    ......
    </biblioentry>
  </bibliodiv>
  <bibliodiv>
  ......
  </bibliodiv>
</bibliography>

顯示效果亦如參考資料>


2.6. 問題解答集表示法

在網際網路的學習環境中,有種格式的文件常會用來給新手瀏覽,以方便它能快速的熟悉某一特定專業領域的各層面,就是 Q & A,question and answer。

Q & A 藉由一問一答的方式,一方面加深閱讀者印像,另一方面也點出某些領域的重點及需留意事項。這樣的文件不管是獨立成一篇文章,或附在章節之後,做些內容的複習及補充,都非常合適,因此 DocBook 特別用 qandaset 標籤來表示這種資料結構。

qanaset 基本結構可由 qandaentry 直接構成,也可由數個 qandadiv 包含 qandaentry 構成,qandaset 下使用 qandadiv 標籤,表示對各問答項做分類或分組。至於 qandaentry 的基本結構是:

 

  • question:問題

     

    • label:發問標題(省略 label 將以整個問題敘述為標題)

    • para:問題敘述

  • answer:回答

     

    • label:回答標題(通常只在答案有一個以上時使用)

    • para:回答敘述

一個 qandaentry 中只能有一個 question ,但可以有好幾個 answer 。範例如下:

Example 2-7. 問題解答集(qandaset)範例

<qandaset><title>DocBook 寫作問答</title>
  <qandaentry>
    <question><label>我該用 DocBook 取代其他格式文件嗎?</label>
    <para>既然 DocBook 可以一次輸入,然後轉成 HTML,PS,RTF...</para>
  </question>
  <answer>
    <para>我個人的答案是否定的...</para>
  </answer>
  </qandaentry>
  <qandaentry>
    <question><label>我的資料消失了?</label>
      <para>DocBook 文件中某些資料,並未出現在新的文件中...</para>
    </question>
    <answer>
      <para>...在某些 DSSSL 檔案下不會轉到新文件中...</para>
    </answer>
  </qandaentry>
</qandaset>

顯示效果請參看 DocBook 寫作問答


2.7. 結語

介紹 DocBook 的各種標籤及組織結構至此,常用的表示法已學了七八成,一本書籍可能出現的資料格式,大概都有了交待,用這些來寫本完整的書或手冊,也應該不至於太離譜。

但不管本手冊的標籤佔所有 DocBook 標籤的數量,或者對一個標籤可變換出的不同呈現方法,都不到三成而已。所以如果你想更進一步探究 DocBook 的能力,或其他的疑惑有待解答,DocBook 的線上手冊,都是你必需常常前往查閱的,查閱前先讀熟本手冊附錄的如何查詢標籤的組織結構,有助你順利的了解 DocBook 線上手冊的語法。

歡迎展開 DocBook 探索之旅,相信不久的將來,你對 DocBook 的理解和熟練,將遠遠的超過我,這也是我最大的期盼。


Appendix A. 附錄

DocBook 寫作問答

A.1. 我該用 DocBook 取代其他格式文件嗎? A.2. 我的資料消失了? A.3. 應該注意使用的編碼字元

這裡嘗試回答一些你在製作 DocBook 文件時,可能碰到的問題。

A.1. 我該用 DocBook 取代其他格式文件嗎?

既然 DocBook 可以一次輸入,然後轉成 HTML,PS,RTF 多種格式輸出,那是否意味著以後我只要學 DocBook 一種格式就好,反正其他的格式可以用轉換的。

我個人的答案是否定的。第一:DocBook 本身不是被設計來取代任何其他可供閱覽的格式文件用的,他存在目的不是要改變你的顯示方法和行為,他存在的目的是整理組織你的各種文件,也就是他把一堆雜亂的資料,彙整到你想表達的模式中去。所以 DocBook 不能取代 HTML,PS,RTF ,因為那是不同功能的兩種東西,你應該同時學習一種你喜歡的閱覽格式文件再加學一個 DocBook ,用 DocBook 幫你組織和交換你的資料來源。

第二:DocBook 並未包含所有的文件主題,就像本手冊中一再強調的,DocBook 的目的在製作出論理性的,技術性的文件。對於一些文藝性的,甚至多媒體格式,DocBook 並不適合。所以在寫理論文章時,你可以用 DocBook 加一個其他閱覽格式當良好的組合方案,但如果你要表達詩詞歌賦的意境,多媒體的藝術感動,你必需為你使用的閱覽格式文件,尋求其他的配套組合。

A.2. 我的資料消失了?

為何我在 DocBook 文件中某些標籤的內容資料,轉換成其他格式文件後,並未出現在新的格式文件中?我標籤的語法和內容資料格式都合法,並通過解析器的合法檢測,並無任何錯誤顯示,請問錯誤出在那裡呢?

非常有可能是毫無錯誤,因為負責設定轉換樣式的 DSSSL 文件不只能決定一個標籤輸出成什麼樣子,更可以決定那些標籤資料要輸出,那些標籤不輸出。所以如果你參照 http://www.study-area.org/tips/doctrans/doctrans.html 中譯的說明,分別在 -d 選項使用 Norman Walsh's DSSSL 的 docbook.dsl 和 TLDP 的 ldp.dsl 編譯一次,就會明白某些部份 docbook.dsl 和 ldp.dsl 會有選擇輸出的不同。所以,DocBook 的某些標籤內容資料,在某些 DSSSL 檔案下不會轉到新文件中,不僅正常,而且正是 DSSSL 要發揮的選擇功能。

A.3. 應該注意使用的編碼字元

DocBook 中除了 '<','>','&' 負有特殊功能,有使用限制外,還有那些字元的使用有限制呢?

'_' 底線字元

底線字元不該出現在實體(ENTITY)設定字串,或屬性設定字串裡。


A.1. 如何查詢標籤的組織結構

DocBook 的標籤有三百多個,並且有嚴格的次序和上下階層組織。所以我們在將自己寫的 DocBook 格式文件送交編譯時,轉譯器常常會顯示標籤出現不合法或是格式不完整的訊息。可以這麼說,DocBook 的解譯遠比他的同宗兄弟 HTML 格式文件挑惕,所以時常翻閱 DocBook 的線上手冊,以查明每個標籤的上下階層及出現次序,幾乎是 DocBook 文件寫作終將會面對的事。


A.1.1. 位置的規則

我們在 DocBook 標籤的使用上首先要重視的就是上下階層關係,除了在前面 根標籤一節所說的根標籤,是一份文件中所有其他標籤的先祖外,每個標籤都至少有一個父標籤,以及若干的子標籤。例如當我們進入 DocBook: The Definitive Guide 的 II. Reference I. DocBook Element Reference 目錄,選 chapter 這個標籤開始查詢,你會發覺 chapter 專屬解說頁會有個 Parents 區段,裡面列出 chapter 的父標籤是 book 和 part ,這表示 chapter 只能出現在 book 和 part 標籤之中,除此之外,都是非法的。

另外一般標籤的說明還有 Children 的區段,除了空標籤沒有 children 外,其他標籤都有 children 區段,例如 chapter 的 children 就有 abstract, address, anchor, ......sect1, section..... 一大串,這表示 chapter 標籤中可以容納上列的各種標籤。

明瞭那些標籤可以出現在何處,是使用 DocBook 標籤的第一項知識。


A.1.2. 次數的規則

光知道那個標籤中有那些組成並不足以完整的說明一個標籤的組織結構,標籤的組織結構第二個要點是一個標籤的組成元素,有些是必要的,有些是選項的,有些是只能出現一次的,有些是可以出現很多次的,我們稱為標籤出現次數的規則。

次數的規則就不是靠 parents , children 區段看得出來了,我們要看個語法比較複雜的區段,Content Model。譬如 table 標籤的 Content Model 區段敘述是這樣的:

table ::=
((blockinfo?,
  (title,titleabbrev?),
  (indexterm)*,
  textobject*,
  (graphic+|mediaobject+|tgroup+)))

 

Content Model 敘述解析

  • table 目前查詢的標籤名稱

  • ::= 由右方元素組成

  • ((blockinfo?,...|tgroup+))) 組成元素列示

在 Content Model 中對子元素出現規則的表示法是"子標籤名稱+出現規則表示字符" 。出現規則表示字符有四種狀況,就是 '?','+','*' 加上什麼字符都不加四種情況,現就以 table 的 Content Model 來解說:

 

子元素出現規則表示法

title

title 標籤一定要出現一次,而且只能出現一次。

blockinfo?

blockinfo 標籤最多出現一次,但也可以不出現。

graphic+

graphic 標籤最少出現一次,最多無上限。

textobject*

textobject 標籤可以不出現,也可以無限多次出現。


A.1.3. 次序的規則

我們知道了一個標籤該擺放的位置,也知道他出現的規則,那是否就完全知道DocBook 標籤的組織規則呢?不然,有項標籤彼此的關係我們還沒談到,那就是在標籤結構中,有些標籤必須先出現,有些則放後面,有些則可以隨你高興,任意擺放。我們稱這為次序規則,次序規則一樣要由觀察 Cintent Model 得知,現在我們假設有個甲標籤,他由 atag,btag,ctag 三個子標籤構成,那他們的次序規則敘述是:

Table A-1. 單純標籤次序規則敘述表

次序敘述解說
(atag,btag,ctag)a,b,c tag 必須依先後次序一個個排列
(atag|btag|ctag)a,b,c tag 中選一個出現
(atag&btag&ctag)a,b,c tag 可以用任何次序出現

如果把次序規則和次數規則結合顯示,就會有很多的變化出來:

Table A-2. 綜合標籤次序規則敘述表

次序敘述解說
(atag?,btag,ctag+)atag 可以選項是否出現,btag 一定要出現一次,ctag 出現一次以上,a,b,c tag 需按次序出現。
((atag|btag),ctag+)atag 和 btag 擇一出現,ctag 出現一次以上,c 要排在 a or b 之後。
((atag|btag)?,ctag+)atag 和 btag 可以擇一出現,也可以都不出現,ctag 出現一次以上,c 要排在 a or b 之後。
((atag|btag)+,ctag?)atag 和 btag 需交替出現,或重複出現一次以上,ctag 可以出現一次或不出現,如c 要出現需排在 a or b 之後。
((atag|btag|ctag)+)abc tag 可以以任何次序交替或單一標籤連續出現一次以上。
((atag|btag|ctag)*)這是最自由的子標籤結構表達示,表示abc tag 可以以任何次序任意次數出現,通通合法。

學會看 DocBook 線上參考書的 Content Model 敘述,掌握了標籤的位置,次數,次序規則,下次再遇到編譯器向你抱怨標籤不合法,你就能很輕易找出毛病所在。而且會看 Content Model ,你就可以跨過本手冊的入門,迅速透過自修,直達 DocBook 專家的堂奧,有志學習 DocBook 的,應該花點心力在這上面。

 

Note

DocBook 的 Content Model 敘述,是和 SGML & XML 的 DTD 語法規則是一致的,看懂 Content Model ,將來看 DTD 也不是難事。

參考資料

當你第一眼看見本節,你會發覺所收集的參考資料不是很多,沒辦法,這表示作者學養有限,並沒有看很多書。但至少你可以肯定一點,列得少的好處是,每一個都是確實有參考價值的文獻,不會有撐場面湊數的情況。


線上資料

DocBook XML/SGML Processing Using OpenJade: 建立 DocBook 的解譯環境(中譯) , Saqib Ali and 老貢生.

Revision History
Revision 1.0.02003-11-19 
 

DocBook Install mini-HOWTO, Robert B Easter.

Revision History
Revision v1.82002-02-04Revised by: rbe
 

同樣是建立 DocBook 解譯環境的文章,會談到一些和上一篇技巧和方法。

DocBook: The Definitive Guide: DocBook 線上手冊 , Norman Walsh and Leonard Muellner, 1999, 2000, 2001, 2002, 156592-580-7.

 

Writing Documentation Using DocBook: A Crash Course, David Rugge, Mark Galassi, and Eric Bischoff, 1997-2002.

這是一篇怎樣使用 DocBook 工具來製作 DocBook 文件的導覽文章。

DocBook 文件寫作入門(source download).

本手冊的原始格式,DocBook 文件。不相信 DocBook 真的管用的,不妨下載這篇回去參考。

DocBook 參考字典

DocBook 相關字詞解釋

D

Document Style Semantics and Specification Language (DSSSL)

文件樣式表示及設定語言:一種以 SGML 標記語法定義的標記語言,他被定義的目的是要替其他以 SGML 語法定義的格式文件,決定一個輸出的樣式。簡單的說法 DSSSL 是其他 SGML 文件的型版或樣式表,透過他 SGML 能轉換成其他各種不同格式的文件。

See Also: Standard Genralized Markup Language.

Document Type Definitions (DTD)

文件型態定義:使用在 SGML 文件中,一種用來描述某特定格式的文件分類和階層結構的說明文件,是 SGML 文件的基礎和起點。

See Also: Standard Genralized Markup Language.

E

Element (tag)

分類元素:這是使用在 SGML DTD 文件中的一個基本組成。首先我們將某特殊格式文件做分類,然後用標記加以區隔,並給不同的類別一個特定的名稱,我們稱一個類別就是一個 Element (其實也就是一個標籤的另一種說法),而一份文件就是由不同的 Element 有組織有架構的組織起來的。

See Also: Document Type Definitions.

ENTITY (ent)

實體,這個名詞很難望文生義,就其實際代表的含意是指:本文部份片段的代名詞。本文片段小到一個字符,一個字串,大到一個檔案,都可以取一個名稱來代表它,而最後解譯的結果,顯示的也是它代表意義,而非那個代名

O

Organization for the Advancement of Structured Information Standards (OASIS)

結構化資訊標準宣導組織(如果你願意,也可以叫它綠洲組織,這樣的縮寫名稱應該是有意的安排吧)。這是非營利的推廣組織,主要是在負責推動一些產業界資訊標準的研究,資料蒐集與開發,尤其是 SGML 和 XML 的推廣和介紹。本文介紹的 DocBook 格式文件標準,即由 OASIS 負責制定,維護,更新。

P

Public Identifier (PI)

公共識別字串:就是每個不同種類及版本的文件格式標準製作者,為自己的格式標準取一個獨特且唯一的識別字串,並公告周知。讓別人或解譯程式看到這樣的字串,就知道此文件採用某種特定格式的標準,而據以處理。一般他的格式是:

"prefix//owner-identifier//text-class text-description//language//display-version"

例如 DocBook 4.2 DTD 的 PI 是:

"-//OASIS//DTD DocBook V4.2//EN"

各部份組成意義如下:

 

prefix, 前置符號

分為 '+' 和 '-' 兩個字符,'+' 表示有經 ISO 組織正式註冊,'-' 則是未向 ISO 組織申請註冊手續。

owner-identifier, 擁有者識別字串

表明此一標準是由那個個人或組織負責訂定及維護的,例如 DocBook 4.2 DTD 是由 OASIS 這個組織制定維護的。

text-class, 文件類別

在 SGML 中較常見的分類有:DOCUMENT,DTD,ELEMENTS,ENTITIES,NONSGML。

text-description, 文件描述

制定標準者可以為其制定的格式標準使用一個獨特的描述詞,如 DocBook V4.2。

language, 語言區域標識

表示這個文件標準是使用何種地區的語言文字製作的,通常使用 ISO 組織兩字符區域語言標準協定。

display-version, 版本編號標識

如果同樣的類別,同樣描述的格式標準,先後出了幾個有修正的版本,可以使用此項識別。這是一個選項,不一定要使用。有些 PI 字串在 text-description 中就包含了版本分別,所以沒有使用到 display-version 這項識別。

See Also: Organization for the Advancement of Structured Information Standards, Document Type Definitions, Element, ENTITY.

S

Standard Genralized Markup Language (SGML)

通用標準標記語言:一種描述文件分類及組織架構的表示語法,這種語法是透過在文件中插入標記資料,來做文件內容分類和組織。透過共同的 SGML 語法標準,不同的閱覽者及閱覽程式,能夠準確的掌握文件的結構並加以有效的處理。制定 SGML 的 ISO 組織並努力制定不同機器平台和作業環境的資料交換格式標準,藉由這些附加標準,遵照 SGML 標準寫作的文件,都能享有跨平台交換資料的可攜性便利。

SGML Declaration (SGML DCL)

SGML 宣告:提供編譯 DTD所需的全部資訊及剖析文件實例所需的部份資訊。例如,它定義了文件的字元(Characters Set)、標籤的界限符號 (Delimiters)、處理文件時所需的儲存容量(Storage Capacity)、文件使用的具體語法(Concrete Syntax)、具體語法適用的範圍(Scope)、文件使用的SGML特徵(SGML Features)等等。

See Also: Document Type Definitions.

X

Extensible Markup Language (XML)

可延伸式標記語言:為了在 Web 網站上運作,便於資料交換傳遞專門設計的 SGML 精簡指令集。他基本上延續了 SGML 的精神和運作模式,但採用了更嚴格的標記表示法,並刪除了一些 SGML 上與網路運作沒有直接關聯的指令和功能,目的是讓應用程式能更簡便而快速的達成解析轉譯的工作。

See Also: Standard Genralized Markup Language.

Extensible Stylesheet Language (XSL)

延伸式樣式表語言:就如同 DSSSL 之於 SGML 的負責格式及輸出轉換,XSL 也負責 XML 的格式及輸出轉換。

See Also: Extensible Markup Language, Document Style Semantics and Specification Language.

Extensible Stylesheet Language Transformations (XSLT)

XSL 的變體,又稱為新一代的 XSL 。

See Also: Extensible Markup Language, Extensible Stylesheet Language.

Notes

[1]

XML 定義的 DocBook 樣式表是 XLS or XLST ,用 SGML 定義的 DocBook 樣式表是 DSSSL

[2]

有關共同文件寫作部份,本手冊不會談到,或許將來有機會寫 DocBook 進階手冊時,會專門著重在這上面,本手冊只談個人的寫作層面。

[3]

簡稱 TLDP ,亦即 Linux 作業系統的文件說明專案計畫。

[4]

各種所謂意義分類,顯示與資料來源分開處理的文件格式發展的故事,都跟 SGML 脫不了關係。至於 SGML 自身那一段發展的故事也頗長的,不過不是本手冊論述的主題了,各位讀者有個概念即可。

[5]

其實 SGML 本身並沒有分列印顯示和意義分類的標記語法,它只是一種標記的表示和組織方法,用這種方法定出來的格式文件,可能以版面顯示為主,也可能以意義結構分類為主。

[6]

當然正統的建議是在 DocBook 中加入適當的備註,有利於作者群溝通觀念及管理文件。

[7]

不管你在 para 標籤內輸入文字資料時是否有斷行,DocBook 一律不會做斷行處理,而是串成一行列示到底,直到 para 結束標籤出現,或遇到其他區塊標籤,才會斷行。所以,如果你希望把文字分作兩行以上輸出,請使用多個並列 para 加以處理。

[8]

在同一層級的區段中,相同層級的 sect 不限一個,也就是在 sect1 內,可以連續並列使用好多個 sect2。

[9]

上面範例中,行首的插入空白行只是有利於文件製作者辨明不同的 sect 之間的層級關係而已,對於最終的轉換輸出結果毫無影響。也就是就算你行首不插入空白,甚至凸排,都不會改變他的階層關係。

[10]

我們可以在 DSSSL 輸出樣式表中設定那些類型的標籤內容要輸出,那些忽略不處理。根據 Norman Walsh's DSSSL 設定,bookinfo,chapterinfo,articleinfo 會被輸出,其他的就不一定了,所以有些標籤內容在轉換成其他格式文件後不見了,這是正常的,並非錯誤。

[11]

那些段落的 title 會編成目錄索引,其實是由樣式表決定的。所以 Norman Walsh's DSSSL 的預設 docbook.dsl 樣式表,和 TLDP 的 ldp.dsl 編制目錄的包括範圍是不同的。



Google
<script type="text/javascript"> </script> <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> </script>
<script type="text/javascript"> </script> <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> </script>
相关推荐
©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页