5 修訂描述

本文翻譯自 http://www.tei-c.org/release/doc/tei-p5-doc/zh-tw/html/HD.html#HD6, 2011.12.5-6

TEI header 的最後一個子元素,revisionDesc 元素,提供一個詳細的變更紀錄,對於文本的每一個變更都可以在這裡記錄。

它的使用是非必須的,但是高度建議使用。

它為大量被更新、更正、修改的檔案管理提供不可或缺的資訊,當檔案在研究人員之間或系統之間傳遞時,它也提供非常有用的說明。

如果沒有變更記錄,很容易混淆某個檔案的不同版本,或者停留在散佈環節中的某些早期連結,而沒有察覺到檔案中某些細小但是重要的變更。

如果在變更紀錄之中沒有對應的記錄的話,不應對任何符合 TEI 的檔案做變更。

<revisionDesc> (修訂描述) 概述檔案的修訂歷史。

<change> 概述多位研究者共享的某版本電子文本當中,某特定的內容變更或修正。

修訂描述的主要目的是記錄文本裡的變更。

不過,在 TEI 實務上也建議記錄檔頭本身 (當然是指修訂描述本身以外) 的重大變更。

至少應該有一筆紀錄指出檔頭的創建日期。

該紀錄由一個條目清單組成,每個變更對應到一個條目。

這可以使用 3.7 Lists 描述的 list 元素來標記,或者使用一系列專門用途的 change 元素,它可以包含更詳細的變更描述。

@when 和 @who 屬性分別用來指出變更的日期以及負責人員。

變更本身的描述可以是一個簡單的片語到一系列的段落。

如果有某個數字關聯到一個或多個變更(例如修訂編號),可以使用全域 @n 屬性來指出它。

建議以反向的時間順序來排序這些變更,最近的放第一個。

例如:

<!-- ... --><revisionDesc>
 <change n="RCS:1.39" when="2007-08-08" who="#jwernimo.lrv">Changed <val>drama.verse</val>
  <gi>lg</gi>s to <gi>p</gi>s. <note>we have opened a discussion about the need for a new
  value for <att>type</att> of <gi>lg</gi>, <val>drama.free.verse</val>, in order to address
  the verse of Behn which is not in regular iambic pentameter. For the time being these
  instances are marked with a comment note until we are able to fully consider the best way
  to encode these instances.</note>
 </change>
 <change n="RCS:1.33" when="2007-06-28" who="#pcaton.xzc">Added <att>key</att> and <att>reg</att>
  to <gi>name</gi>s.</change>
 <change n="RCS:1.31" when="2006-12-04" who="#wgui.ner">Completed renovation. Validated.</change>
</revisionDesc>

上例中的 @who 屬性指向較早包括在同一檔頭中的 titleStmt 裡面的 respStmt 元素:

<titleStmt>
 <title>The Amorous Prince, or, the Curious Husband, 1671</title>
 <author>
  <persName ref="#abehn.aeh">Behn, Aphra</persName>
 </author>
 <respStmt xml:id="pcaton.xzc">
  <persName>Caton, Paul</persName>
  <resp>electronic publication editor</resp>
 </respStmt>
 <respStmt xml:id="wgui.ner">
  <persName>Gui, Weihsin</persName>
  <resp>encoder</resp>
 </respStmt>
 <respStmt xml:id="jwernimo.lrv">
  <persName>Wernimont, Jacqueline</persName>
  <resp>encoder</resp>
 </respStmt>
</titleStmt>

不過,沒有要求這個人一定要用 respStmt,也沒有要求所指元素必須包含在相同文件內。

例如,某個專案可能一個單獨的文件,以 15.2.2 The Participant Description 描述的 person 元素列出所有人員。