DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
XML Watch:以 XML 描述開放原始碼專案(三)
編輯:XML詳解     

在本系列前兩篇文章中,我分析了描述開放原始碼專案的 XML/RDF 詞彙表在原理與設計上的種種問題。DOAP(Description of a Project,專案描述)詞彙表應該能滿足兩類人的需要:一是那些發現自己得在無數網站重複註冊軟體的專案維護者,二是尋找並交換這類資訊的人。第 1 部分回顧了目前這方面的研究並界定專案邊界;第 2 部分提出了候選術語,並強調了若干設計問題。

本文將給出 DOAP 詞彙表的初步草案,以及幾個專案的範例描述。文中包含大量範例,建議你在閱讀過程中動手建立自己的 DOAP 描述。

概述

我將使用 RDF 模式語言來討論 DOAP。雖然 DOAP 可以當作 XML 使用,但你會看到它在本質上是一個 RDF 詞彙表。要注意本文用到的兩個 RDF 模式概念:類(Class)與屬性(Property)。在 RDF 中,類是一種資源型別,就像 Java 語言中類是物件的型別一樣;屬性則是資源與其他資源或文字值之間的關聯。其他介紹 RDF 的 developerWorks 文章請參閱「參考資料」。

在正式介紹 DOAP 詞彙表的術語之前,先來看一個簡單的範例。清單 1 是 DOAP 專案本身的最小化描述:

清單 1. DOAP 專案的最小化描述

<Project xmlns="https://usefulinc.com/ns/doap#"
         xmlns:rdf="https://www.w3.org/1999/02/22-rdf-syntax-ns#"
         xmlns:foaf="https://xmlns.com/foaf/0.1/">
  <name>DOAP</name>
  <homepage rdf:resource="https://usefulinc.com/doap" />
  <created>2004-05-04</created>
  <shortdesc xml:lang="en">
    Tools and vocabulary for describing community-based
    software projects.
  </shortdesc>
  <description xml:lang="en">
    DOAP (Description of a Project) is an RDF vocabulary and
    associated set of tools for describing community-based software
    projects. It is intended to be an interchange vocabulary for
    software directory sites, and to allow the decentralized
    expression of involvement in a project.
  </description>
  <maintainer>
    <foaf:Person>
      <foaf:name>Edd Dumbill</foaf:name>
      <foaf:homepage rdf:resource="https://usefulinc.com/edd" />
    </foaf:Person>
  </maintainer>
</Project>

從清單 1 可以歸納出編寫 DOAP 文件的一些通用規則:

  • 類以首字母大寫的詞彙標記,如「Project」與「Person」。這是編寫 RDF 詞彙表的一般約定,運作良好;屬性則用小寫書寫。
  • DOAP 文件最外層元素是 <Project>。2004 年 2 月的 RDF 語法規範(請參閱「參考資料」)允許省略 <rdf:RDF> 容器,直接用外層節點來描述。
  • 朋友的朋友(FOAF)詞彙表用於描述人,我曾為此寫過幾篇文章(請參閱「參考資料」)。
  • DOAP 命名空間是 https://usefulinc.com/ns/doap#。
  • 標準屬性 xml:lang 用於標示文字屬性的語言。

DOAP 詞彙表目前包括三個類:

  • Project:主專案資源
  • Version:發布軟體的實例
  • Repository:原始碼資料庫

事實上,Repository 還有幾個子類,後面會說明。現在我們來逐一分析各個類。

Project 類

如您所料,Project 是 DOAP 中的主類。每個 Project 都由其首頁 URI(我在上一篇文中說明了原因)唯一標識。此外,專案描述還應列出過去所有首頁的 URI,因為它們仍是有效的唯一標識符,其他人可能仍在用來參照該專案。

表 1 列出了 Project 可用的屬性。描述可以包含每個屬性的多個實例,數量不限。一般而言,Project 只有一個名稱是合理的,但也不一定如此。此外,只要作者願意,Project 描述可以只含很少的屬性,唯一的要求是至少要有首頁屬性。

表 1. Project 類的屬性(星號表示標識屬性)

name(公開的專案主名稱)、shortname(縮寫名,通常用於檔名)、homepage*(專案首頁 URI)、old-homepage*(過去首頁 URI)、created(建立日期,格式 YYYY-MM-DD)、description(普通文字描述,數句話)、shortdesc(簡要描述,八九個詞)、category(表示專案分類的 URI)、wiki(附屬 Wiki 的 URI)、bug-database(缺陷追蹤系統或電子郵件位址)、screenshots(含專案截圖的網頁 URI)、mailing-list(相關郵件列表 URI)、programming-language(實作或計畫使用的語言)、os(專案限定的作業系統)、license(許可證 URI)、download-page(下載位置 URI)、download-mirror(下載鏡像站 URI)、repository(doap:Repository)、release(doap:Version)、maintainer/developer/documenter/translator/helper(皆為 foaf:Person,分別描述維護者、開發者、文件撰寫者、翻譯者與其他貢獻者)。

清單 2 展示了一些可用來擴充清單 1 的屬性,可插入到 </Project> 標籤之前:

清單 2. Project 類的一些附加屬性

<mailing-list
    rdf:resource="https://lists.usefulinc.com/mailman/listinfo/doap-interest" />

<!-- Freshmeat category:
     Information Management :: Metadata/Semantic Models -->
<category rdf:resource="https://software.freshmeat.net/browse/1020/" />

<!-- OSDIR category:
     All Platforms :: Information Management (XML) -->
<category
    rdf:resource="https://osdir.com/Downloads+index-req-viewsdload-sid-201.html" />

<license rdf:resource="https://usefulinc.com/doap/licenses/GPL" />

清單 2 也體現了 DOAP 詞彙表的其他幾條原則:

  • 以 URI 為值的屬性,使用 RDF 結構 rdf:resource 來承載該 URI。
  • DOAP 不提出自己的分類方案。現存的分類方案琳瑯滿目,各有優勢,專業社群甚至可能自有一套。DOAP 採取的做法是:僅要求類別必須是一個 URI。清單 2 用了兩種分類方案——分別來自 Freshmeat 與 OSDIR.com,每種情況下類別都取自網站上對應類別頁面的 URI。但要注意正規化,因為網站常允許不同形式的 URL 指向同一頁面;對於常見站點,DOAP 需要在這方面加以標準化。
  • 如本系列第 2 部分所述,常見的軟體許可證都將有一個 DOAP 指定的知名 URI。但身為 DOAP 專案的維護者,我並不希望壟斷許可證標識符,而會提供適當機制允許使用任意 URI。對於處理到「軟體尚不認識的許可證 URI」的情形,應能抓取關於該許可證的簡短 RDF 描述,以便向軟體提供人類可讀的說明。

如前所述,xml:lang 屬性可用於實現 DOAP 描述的國際化。xml:lang 的允許值,就是 RFC 3066 中定義的標準語言代碼(請參閱「參考資料」)。圖 1 是一段關於 DOAP 自身的完整描述片段的截圖(請參閱「參考資料」)。之所以用截圖,是因為並非所有讀者手邊都有合適的字型來檢視這些文字。

圖 1. 國際化的描述屬性

Repository 類

DOAP 模式定義了一個 Repository 類,這是描述原始碼資料庫的通用類。它本身用途有限,因此 DOAP 另外定義了 Repository 的四個更具體的子類,分別對應 Subversion、BitKeeper、CVS 與 GNU Arch 這幾套原始碼修改控制系統。表 2 列出各子類與適用屬性:

表 2. 適用於 Repository 子類的屬性

anon-root(匿名存取資料庫的根路徑)、module(資料庫中原始碼的模組名)、browse(資料庫的網頁瀏覽介面 URL)、location(檔案的基 URL)等屬性,在 SVNRepository、BKRepository、CVSRepository、ArchRepository 各子類中的適用情形互有差異。

DOAP 僅限於描述資料庫唯讀的公開存取版本。如此一來,就不必為可寫入的資料庫編碼存取控制資訊,從而簡化了 DOAP;這樣做損失有限,因為參與開發的人員可以透過其他方式取得這些資訊。

為了明確起見,下面給出針對每套系統的範例描述。Subversion 資料庫就是一個簡單的 URL。比如我為本專案建立的 DOAP 公開資料庫,其 URL 是 https://svn.usefulinc.com/svn/repos/trunk/doap/,並且也能供公眾瀏覽(請參閱「參考資料」)。用 DOAP 編寫如下:

<SVNRepository>
  <location rdf:resource="https://svn.usefulinc.com/svn/repos/trunk/doap/" />
  <browse rdf:resource="https://svn.usefulinc.com/cgi-bin/viewcvs.cgi/trunk/doap/" />
</SVNRepository>

BitKeeper 的 DOAP 描述與 Subversion 類似,一個 URL 就足以確定資料庫。下面是對 Linux 2.6 核心的描述:

<BKRepository>
  <location rdf:resource="https://linux.bkbits.net/linux-2.6" />
  <browse rdf:resource="https://linux.bkbits.net:8080/linux-2.6" />
</BKRepository>

CVS 可能是開放原始碼世界應用最廣泛的原始碼修改控制系統。每個資料庫都以根名稱與模組名標識。比如,可用命令 cvs co -d:pserver:anonymous@anoncvs.gnome.org:/cvs/gnome epiphany 檢出 GNOME 的 Epiphany 網頁瀏覽器。Epiphany 資料庫的 DOAP 描述如下:

<CVSRepository>
  <anon-root>:pserver:anonymous@anoncvs.gnome.org:/cvs/gnome</anon-root>
  <module>epiphany</module>
  <browse rdf:resource="https://cvs.gnome.org/viewcvs/epiphany/" />
</CVSRepository>

GNU Arch 修改控制系統目前很受歡迎。它避開了中央資料庫的概念,改採「每個開發人員都擁有自己的資料庫」的原則。不過,專案仍需指定一個資料庫,從那裡建立軟體的正式發布版本。Arch 具有「檔案位置」與「模組名」的概念。比方說,你可以用 https://www.gnome.org/~jdub/arch/ 上的檔案,搭配模組名 jdub@perkypants.org--projects/planet--devel--0.0,來存取「PlanetPlanet」RSS 聚合系統的一個版本。用 DOAP 編寫如下:

<ArchRepository>
  <location rdf:resource="https://www.gnome.org/~jdub/arch" />
  <module>jdub@perkypants.org--projects/planet--devel--0.0</module>
</ArchRepository>

要把資料庫位置嵌入 DOAP 描述,必須讓它作為 repository 屬性的值。可以參考 DOAP 自身的 DOAP 檔(請參閱「參考資料」)了解實際寫法。

Version 類

雖然本系列第一篇說過,追蹤每個專案的版本並非 DOAP 第一階段的一部分,但仍然需要描述軟體專案的當前版本。Version 類代表軟體版本的一個實例,表 3 說明了它的屬性。

表 3. Version 類的屬性

branch(表示版本分支的字串,如穩定版、不穩定版、gnome24 或 gnome26)、name(版本名,如 Panther)、created(發布日期,YYYY-MM-DD 格式)、revision(版本修訂號,如 1.0)。

比如,關於 Mac OS X 10.3 的版本描述可以寫成:

<Version>
  <branch>stable</branch>
  <name>Panther</name>
  <revision>10.3</revision>
  <created>2003-10-24</created>
</Version>

每個專案可能有多個當前版本,因此需要 branch 屬性。比如一個專案在維護穩定分支的同時,又發布一個不穩定分支以測試新功能,這種情況並不少見。

DOAP 模式

DOAP 詞彙表中類與屬性的形式化定義,都收錄在 DOAP 模式中(請參閱「參考資料」)。它以 RDF 模式編寫,並從 OWL 本體語言借用了一個術語來表示標識屬性(用 OWL 的說法,叫「反轉功能屬性(inverse functional properties)」)。支援 RDF 模式或 OWL 的工具,可用該模式來輔助編輯或解讀 DOAP 描述。

RDF 模式有個很好的特性:只要正確使用,就能把它們轉換成多種文件格式。Morten Fredriksen 已為此建立了一個線上服務。在「參考資料」部分,你可以看到所有 DOAP 術語的引用連結。圖 2 呈現了其中一部分:

圖 2. 使用 Fredriksen 的模式檢視器檢視轉換後的 DOAP 模式

就像本文的範例一樣,你也可以直接把 DOAP 當作 XML 來處理。但我並不鼓勵這麼做。RDF 最好還是以 RDF 的方式處理,而且相關工具並不匱乏。不過,DOAP 適當地採用正規 XML 語法,最大的長處是能建立 XSLT 樣式表,把 DOAP 描述轉換成易於閱讀的 HTML 區塊。

結語

DOAP 專案至關重要的下一步,是建立一套用於建立與使用這種詞彙表的工具。若要兌現「作為軟體交換詞彙表」的承諾,就需要在現實世界中實際部署。

其次,很明顯 DOAP 需要擴充以處理軟體版本。版本公告是軟體專案的一大負擔,某種能自動化這一流程的方法,將能切實幫助維護者。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved