舊文件

此處文件僅供參考,請自行考量時效性與適用程度,其他庫藏文件請參考文件頁面
我們亟需您的協助,進行共筆系統搬移、及文件整理工作,詳情請查閱參與我們

修改 MozTW 網頁

出自 MozTW Wiki

MozTW 的所有網頁都放在版本控制系統 SVN 裡,並且對外開放。這意思是說你可以

  1. 自己抓一份 MozTW 全站網頁回去自己的主機放,雖然我們並不建議這麼做 (也沒有必要)
  2. 幫忙修改你看到的錯誤,然後送回給管理員更新。

這篇文章將簡介協助 MozTW 更新網頁的方法。

抓 MozTW 的網頁回自己的電腦

首先請用 SVN 軟體 Check Out (co) 這個網址: http://svn.openfoundry.org/moztw/ ,你可能必須先永久接受 OpenSVN 網站的 SSL 簽證

如果你還不了解什麼是 SVN,Google 能幫你點忙

平常我慣用的 SVN Client 如下:

  • Windows: TortoiseSVN,有中文介面,很好用
  • Linux: SVN Workbench,易用性比 TortoiseSVN 差點,但還是蠻好用的
  • Console: 就單純使用 subversion

這會在你的硬碟上已經有 MozTW 所有網頁檔案,我們接著要找到對的檔案來改

了解 MozTW SVN 上的目錄結構

SVN checkout 後有好幾個目錄,最重要的有三個:

你可以試著在目錄裡找一下想改的網頁,當然這跟你在 http://moztw.org 看到的路徑會有相關;好比,http://moztw.org/firefox/ 的網頁,正是 /htdocs/firefox/index.shtml

關於 http://moztw.org 比較詳細的目錄結構介紹,請參考 MozTW 網頁目錄結構說明

範例:修改 Firefox 版本資訊

Firefox 的版本資訊 (Release Notes) 協助使用者了解這個版本的修改之處與已知問題,MozTW 會希望盡可能每個版本都翻譯。事實上,小改版 (例如 3.0.1 到 3.0.2) 之間的更動並不大,可以當個不錯的入門教材。

在 MozTW 主機裡,版本資訊會放在 /htdocs/{軟體名稱}/release/{版本號}/index.shtml,另外也複製一份最新版的資訊做為 /htdocs/{軟體名稱}/release/index.shtml。實務上,通常是修改 releases 目錄下的檔案 (亦即最新版),然後再新開版本號目錄複製一份過去。這麼一來,使用者可以從 http://moztw.org/{軟體名稱}/releases/ 連到某軟體最新版的資訊、也可以從 http://moztw.org/{軟體名稱}/releases/{版本號}/ 連到特定版號的資訊。

在 mozilla.com 上,版本資訊則是放在 http://www.mozilla.com/en-US/{軟體名稱}/{版本號}/releasenotes/

在此,我們假設目前 MozTW 主機上最新的版本資訊是 3.0 版,說明升級 3.0.1 版時的文件修改步驟與注意事項:

  1. 首先以編輯軟體開啟 /htdocs/firefox/releases/index.shtml
  2. 比對英文版的 Firefox 3.0 版本資訊3.0.1 版本資訊,找出其相異處。
    • 你當然可以用 diff 等檔案差異比對工具,會方便得多
    • 如果不使用 diff,基本上小改版需要注意的部份有新鮮事 (What's New)與已知問題 (Known Issues) 兩處,偶爾會非官方建製版 (Contributed Builds) 部份也有修改。
  3. 比對差異後,就把新增與減少的部份,反映在我們的 index.shtml 上,所有的標籤與樣式設定原封不動搬過來就可以了。當然,請將英文翻譯為中文。
  4. 存檔

修改後,請盡可能自己先測試除錯。如果你願意長期協助 MozTW 修改網頁,可以在自己電腦上架一個含有 SSI 功能的 WWW 伺服器,這樣就可以在自己的電腦上測試。

如果你有 SVN 的 Commit (ci) 權限,那麼你就可以直接將修改檔送回 SVN 中 — 不過,大部分的人不會有這個權限,所以接下來將說明把修改檔提報給 MozTW 網頁管理員的方法。

更新主機上的檔案

MozTW 目前使用 Google Code 作為我們的問題追蹤系統,要使用這個系統,你必須有個 Google 帳戶。有了 Google 帳戶之後就可以開新 issue、把檔案傳上去讓管理員知道,順便也可討論相關事宜。

以下是你提報網頁修改相關的新 issue 時,應該寫上的資訊:

  • 標題:簡短標題說明你修改的東西,例如「Firefox 3.0.1 版本資訊更新」
  • 內容:如有必要,請稍微說明修改的部份
  • 檔案:請附上你修改的檔案
  • 標籤:以 Firefox 3.0.1 版本資訊為例,請加上「product-firefox」、「www-moztw」等標籤 (Label)。

關於修改檔,你有兩種選擇:

  • 你可以把修改後的檔案與原先檔案的 diff 檔送上來,方便我們查閱修改了哪些部份。(推荐使用這種方式,節省大家時間)
  • 或者,你也可以直接把修改過的 shtml 檔送上來。

不要直接從 http://moztw.org 抓檔案下來改,因為這麼一來管理員還得確定是否影響 SSI 引入的檔案範圍。從 SVN 上的檔案改可以確保 SSI 相關格式都正確保留無誤。

當你送出這份 issue 之後,管理員會處理檔案更新事宜,更新後你應該會收到 Google Code 的信件通知。當然,管理員也有可能會希望你能配合修改其他部份,所有這類的相關討論記錄都會在 Google Code 上公開、若你有任何想法也歡迎發表。

參考資料

個人工具