上一篇文章的結尾,Gentoo Linux 網站換上了一張全新的臉,但工作還沒結束。在這篇(也是本系列最後一篇)裡,我要替這個站點做最後一輪打磨,讓它成為一個功能完整、觀感講究、模組化且日後易於修改的 XML 網站。先接著上次未談完的部分說起。
第一,雖然站點有了新外觀,但只有文件部分是建在 XML 之上的。幾個主要的「類別」頁面仍是手寫的 HTML,必須一併轉成 XML/XSLT 方案,日後才好維護與擴充。
第二,我的開發人員在原始 HTML 裡發現了幾個問題。用 Netscape 4.77 開啟時,站點的模樣實在很難看——這顯然得處理。另外在較現代的瀏覽器上也有一些小毛病,其中最惱人的是一條細長的黑色分隔線沒有一路延伸到底,破壞了「飛碟高手正在講解主內容區」那種視覺上的完整感。再者,文件頁的風格與外觀更講究的新類別頁之間並沒有完全搭得起來,顯然有些地方需要更新。
這是 Gentoo Linux 站點的最後一次改造計畫。首先,我會全面重寫首頁的 HTML:整體觀感維持不變,但讓它與各瀏覽器的相容性更好;同時做幾項訪客建議的顯示改進,並修掉現有 guide 文件系統的相容性問題。
接著,把整個站點轉移到 XML 與 XSLT。做完之後,站點上的任何修改都將透過編輯 XML 與 XSLT 來完成,而不是直接改 HTML,而且這一切可以靠 xsltproc 自動產生。維護成本會大幅下降。由於 Gentoo Linux 是社群共同開發的專案,這反過來也讓我們的開發人員(還有我)能隨時依需要維護和改進網站。這件事讓我頗為振奮:它既省下我的時間,也確保訪客每次看到的都是最新內容。
話雖如此,Netscape 4.x 當時仍有可觀的使用者,我很難判斷究竟該為它付出多少代價。是只要確保站點「可讀」(不出大錯)就好?還是不惜犧牲 CSS、在 HTML 裡塞進各種相容性寫法,也要讓它在 Netscape 4.x 中看起來完美無瑕?
最後我的決定是:對 HTML 做幾處重大調整,讓站點在 Netscape 4.x 中依然體面,而不去計較表格間距、字型顯示這類小瑕疵。(Gentoo Linux 開發小組已經提交過好幾個這類修正。)
先說最典型的一個:Netscape 4.x 有個 bug,會把區塊元素的 CSS 背景色渲染錯。例如下面是指南文件某個段落在 IE5 中的預期模樣:
圖 1. IE5 中的範例指南文件
而同一段在指定了 CSS 背景色之後,用 Netscape 4.x 開啟會變成:
圖 2. Netscape 4.7 中的同一段;顯然需要補救
這實在不好看。解法是把現有的區塊元素(像這樣)
<p class="note">This paragraph doesn't look so good in 4.x</p>
換成一個表格:
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td bgcolor="#ddffff"><p class="note">
This looks a whole lot better in 4.x</p></td>
</tr>
</table>
背景顯示的問題是修好了,但代價是把顏色資訊塞回 HTML 裡——這恰好抵銷了使用 CSS 的初衷。對我這種 CSS 擁護者來說相當無奈,然而為了相容 Netscape 4.x,別無選擇。
再來處理那條不能一路延伸到底的黑色分隔線。我找不到一個能同時在 4.x 與 5.x 瀏覽器上都正確運作的解法:每一種在 5.x 下正常的寫法,都會觸發 Netscape 4.x 的 bug;而每一種 4.x 相容的寫法,在 5.x 中又難看至極。最後我乾脆把整條線拿掉——這樣站點就能在各種瀏覽器上正常運作。下一步,我要建立一套類似 guide 的語法,用來產生首頁。
我沒有為首頁設計全新的標記集。我認為盡可能沿用「guide」XML 文件的標記才是聰明的做法(guide XML 格式的細節請見本系列第 2 部分)。於是我丟掉原先為首頁寫的那些 XSL,改用我的 guide XSL 當工作底稿。一兩個小時後,一套能將類似 guide 的語法轉換成 HTML 首頁的完整 XSL 轉換就成形了。首頁修訂版 2 的模樣如下:
圖 3. 新首頁修訂版
既然首頁已經有了 XML/XSLT 後端,我把注意力轉向 guide 系統的 HTML 輸出。我不只要修掉一堆 Netscape 4.7 的相容性問題,還得更新產生的 HTML 與圖片,讓它們和煥然一新的首頁搭配得宜。就在此時我靈光一閃:何不稍微調整新的首頁 XML/XSL,讓它同時能產生文件的 HTML?畢竟為了讓 guide 標記可用於首頁內容,我已經幾乎為每一個 guide XML 標記都寫好了支援。
結果證明這條路輕鬆可行。我只調整了新的 XSLT 檔,讓它在處理文件頁時移除左側的「連結欄」,並對輸出的 HTML 做幾處小改動。由於絕大部分 XSLT 都相同,guide 文件與類別頁可以共用同一套主 XSLT 模板。
圖 4. 新 XSL 的運作方式
如此一來,我不只維護一套 XSLT 模板,兩種風格的 HTML 輸出因為源自同一份主文件,也共享同一份 CSS 樣式表。這代表不必再為「兩套截然不同的樣式表與輸出 HTML」反覆同步外觀。而如你所見,新的文件 HTML 與新首頁搭配得天衣無縫。
圖 5. 新文件頁與新首頁完美搭配
實際的實作相當單純。既有的 guide XML 語法要求每份文件都是單一主 <guide> 元素的一部分。為了支援主要類別頁,我新增了一個主元素:<mainpage>。建立類別頁時,我把所有內容放進 <mainpage> 而非 <guide>,XSLT 便會輸出對應的結果。除此之外,唯一另一處較大的改動,是加上一個選用的 <sidebar> 元素,用來指定類別頁上那個浮動表格的內容。
原本的 <guide> XSLT 模板長這樣:
<xsl:template match="/guide">
<html>
<head>
guide header goes here
</head>
<body>
top part of guide body html content goes here
<!--next, we insert our content-->
<xsl:apply-templates select="chapter" />
bottom part of guide body html content goes here
</body>
</html>
</xsl:template>
如果你對 XSLT 還不熟:這個模板告訴處理程序,用一層 HTML 外殼取代 <guide></guide> 標記,並把模板套用到 <guide> 內的每個 <chapter> 元素上,把產生的結果插入 HTML 外殼的中段。
因此,為了支援類別頁,我需要指定:當內容全部包在單一 <mainpage> 元素裡時,改用另一層 HTML 外殼。於是我加了一個新模板:
<xsl:template match="/mainpage">
<html>
<head>
mainpage header goes here
</head>
<body>
top part of mainpage body html content goes here
<!--next, we insert our content-->
<xsl:apply-templates select="chapter" />
bottom part of mainpage body html content goes here
</body>
</html>
</xsl:template>
因為幾乎所有其他 XML 元素(從 <chapter> 之後的全部)對 guide 頁與類別頁都產生相同的 HTML 輸出,所以幾乎其他所有 XSLT 模板都能被兩類頁面共用。最後我們只需要一個定義兩種「HTML 外殼」的 XSLT 檔,加上一套公用於 XML 轉 HTML 的模板集,任務就完成了。一如往常,程式碼重用果然是好東西。
你或許記得,在本系列第 2 部分我提過 cvs2cl.pl 這個 CVS 變更日誌產生腳本可以輸出 XML,而我最終打算用它作為新網站上每日「CVS 變更日誌」頁面的基礎。現在有了 XML 後端,加上這個頁面可說易如反掌。以下是 cvslog.sh 的增強版,它還負責 XML 到 HTML 的轉換:
#!/bin/bash
#various paths
HOMEDIR=/home/drobbins
CVSDIR=${HOMEDIR}/gentoo/gentoo-x86
OUTLOG=${HOMEDIR}/gentoo/XMLcvslog.txt
OUTMAIL=${HOMEDIR}/gentoo/cvslog.txt
WEBDIR=/usr/local/httpd/htdocs
XSLTP=/opt/gnome/bin/xsltproc
TMPFILE=${HOMEDIR}/gentoo/XMLcvslog.tmp
USER=drobbins
#if $CVSMAIL is undefined, set it to "yes"
if [ -z "$CVSMAIL" ]
then
export CVSMAIL="yes"
fi
#the main script
cd $CVSDIR
cvs -q update -dP
yesterday=`date -d "1 day ago 00:00" -R`
today=`date -d "00:00" -R`
cvsdate=-d\'${yesterday}\<${today}\'
nicedate=`date -d yesterday +"%d %b %Y %Z (%z)"`
#generate cvs2cl.pl XML output
/usr/bin/cvs2cl.pl --XML -f $OUTLOG -l "${cvsdate}"
#use sed to remove "xmlns=" from cvs2cl.pl output
/usr/bin/sed -e 's/xmlns=".*"//' $OUTLOG > ${OUTLOG}.2
#convert cvs2cl.pl XML output to guide format using $XLSTP
$XSLTP ${WEBDIR}/xsl/cvs.xsl ${OUTLOG}.2 > $TMPFILE
#convert guide XML output to html format using $XLSTP
$XSLTP ${WEBDIR}/xsl/guide-main.xsl $TMPFILE > ${WEBDIR}/index-changelog.html
#fix perms
chmod 0644 ${WEBDIR}/index-changelog.html
#automatically send cvs mail if $CVSMAIL is set to "yes"
if [ "$CVSMAIL" = "yes" ]
then
/usr/bin/cvs2cl.pl -f ${OUTMAIL} -l "${cvsdate}"
mutt -x gentoo-cvs -s "cvs log for $nicedate" > ${OUTMAIL}
fi
這支腳本看起來比舊版複雜得多,實際上只多了四五個關鍵行;其餘新增的行不是註解就是環境變數定義。
以下是與 XML 相關的新段落如何運作。首先呼叫 cvs2cl.pl,要它產生一份以 XML 為基礎、涵蓋昨日所有修改檔案的變更日誌。接著用 sed 過一遍這個 XML 輸出,移除不需要的 xmlns= 屬性。下一步把這份略經修改的 XML 餵給 xsltproc,指定套用 cvs.xsl 中的處理指令;這些指令會把 cvs2cl.pl 的 XML 輸出轉成正確的 guide XML 文件。最後再用 xsltproc 把 guide XML 轉成可在 Web 上發布的 HTML,並管線輸出到 Web 伺服器的 htdocs 目錄。生成的 HTML 變更日誌就這樣完成了:
圖 6. 自動產生的「變更日誌」頁面
你或許會訝異 cvs.xsl 裡的 XSLT 有多簡單。我們只為 <changelog>、<entry> 與 <file> 寫了三個模板,另外參照了來源 XML 中的 <date>、<author> 與 <msg>(cvs2cl.pl 用它們承載提交者的註解)。以它僅約 35 行的規模來說,cvs.xsl 已經相當能幹了。
<?xml version='1.0' encoding="iso-8859-1"?>
<xsl:stylesheet version="1.0" xmlns:xsl="https://www.w3.org/1999/XSL/Transform">
<xsl:output encoding="iso-8859-1" method="xml" indent="yes"/>
<xsl:template match="/changelog">
<mainpage id="changelog">
<title>Gentoo Linux Development Changelog for <xsl:value-of select="entry/date"/></title>
<author title="script">cvs-xml.xsl</author>
<standout>
<title>About the Development Changelog</title>
<body>
This page contains a daily Changelog, listing all modifications made to our
CVS tree on <xsl:value-of select="entry/date"/> (yesterday).
</body>
</standout>
<version>1.0.0</version>
<date><xsl:value-of select="entry/date"/></date>
<chapter>
<xsl:apply-templates select="entry"/>
</chapter>
</mainpage>
</xsl:template>
<xsl:template match="entry">
<section>
<title>Files modified by <xsl:value-of select="author"/> at
<xsl:value-of select="time"/>
</title>
<body>
<note><xsl:value-of select="msg"/></note>
<ul>
<xsl:apply-templates select="file"/>
</ul>
</body>
</section>
</xsl:template>
<xsl:template match="file">
<li><path><xsl:value-of select="name"/></path>, <xsl:value-of select="revision"/></li>
</xsl:template>
</xsl:stylesheet>
從一開始重新設計 Gentoo Linux 網站,我們擬出了以使用者為中心的行動計畫,打造了新的 XML 文件系統、新的標誌、新的站點外觀,把剩餘部分全部轉成 XML,最後再加上這個基於 XML 的「變更日誌」頁面。呼,一口氣做完了。
希望你陪我走這一遭的過程是愉快的,也能從中挑到幾個好點子與靈感。我已經收到不少來信,詢問更多細節以及與重新設計相關的程式碼,因此我特別建了一個「Gentoo Linux XML 專案」頁面,收錄 www.gentoo.org 目前使用中的 XML、XSLT、腳本與文件。除了走一趟那個專案頁面,也別忘了參考下方列出的有價值資源。