STEP 4: 注釈

$Id: step4.html 1.11 2000/02/22 15:01:07 murata Exp $

text by 村田　真

html by 難波　亮丞

DTDを説明する資料を作るのは大変重要な作業です．DTDは単に構文を定義する だけですから，自然言語による大量の注釈によって意味を説明することが必要 になります．STEP 4は、注釈のために用意されている機能について説明します。

1. annotation要素

注釈を挿入するためのトップレベルの要素が，annotation要 素です．annotation要素が入れられるのは，次の箇所です．

• interface要素の前に一つだけ
• interface要素の中に複数個
• export要素の中に一個だけ
• elemenRule, hedgeRule, tag, attListなどと同じレベルに複数個
• elementRule要素の長男要素として一個だけ
• hedgeRule要素の長男要素として一個だけ
• tag要素の長男要素として一個だけ
• attList要素の長男要素として一個だけ
• attribute要素の長男要素として一個だけ
• include要素の中に一個だけ
• element要素の長男要素として一個だけ

annotation要素は，子要素としてdocumentation とappinfoをいくつでも持つことができます．

1.1 documentation要素

自然言語による説明を表現するための要素がdocumentation 要素です．RELAX Namespaceが制定されていない現時点は，テキストデータし か入れられません．

documentation要素がsource属性を持つ場合は， 説明を参照するURIが属性値です．この場合は，documentation 要素の内容は使われません．モジュールを表示するツールは，リンクを利用し た表示を提供します．

documentation要素にxml:lang属性が指定され たときは，documentation要素の内容が，どの自然言語で書かれ ているかを示します．

1.2 appinfo要素

文書とRELAXモジュールを照合する検証プログラム以外にも，RELAXモジュー ルを操作するプログラムはいくらでも存在し得ます．たとえば，モジュールか らデータベースのスキーマを生成するプログラムです．そのようなプログラム が利用するための隠し情報を表現するのがappinfo要素です． RELAX Namespaceが制定されていない現時点は，テキストデータしか入れられ ません．

appinfo要素がsource属性を持つ場合は，隠し 情報を参照するURLが属性値です．この場合は，appinfo要素の 内容は使われません．

2. まとめ

STEP 4で，モジュールの説明を書くのが容易になりました。RELAX!