ref- GLOBALBASE PROJECT | POWERD BY HIROHISA MORI

GLOBALBASEマニュアル集 >> マニュアル環境とマニュアルの書き方 >> マニュアルXML文章記述タグ >> ref
2007-11-04版

ref

著者:　森　洋久 / joshua＠globalbase.org 　※　

プロトタイプ

<ref/>
<ref ref="[code]"> [マニュアル文章形式] </ref>

内部要素

[マニュアル文章形式]

属性

ref [必須] 参照先のコード等。

所属エージェント

要素パス表現

[マニュアルXML基本タグ] /ref

説明

マニュアル記述において様々なタグで設定したcodeを参照する。codeの内容が解釈されこの場所に、章番号や章のタイトルなどが挿入される。属性refに指定出来るのはcodeと、URLである。

プロトタイプ1の記述方式をした場合、マニュアル環境のデフォルトの文字列が挿入される。デフォルトの文字列も、PDFの場合とHTMLの場合で異なる。

PDFの場合
- refの内容がcodeの場合
  参照先のタグの章番号などTeX順所の参照番号が「節」「章」「図」「表」などの文字とともに挿入される。
- refの内容がURLの場合
  URLがそのまま記述される。
HTMLの場合
- refの内容がcodeの場合
  参照先のタグのtitleの文字列が挿入される。必要に応じて「図」「表」などの文字とともに挿入される。この挿入文字全体を、アンカーで囲い、参照先へのリンクをはる。
- refの内容がURLの場合
  URLの参照先へのリンクのアンカーで囲われたURLが記述される。

プロトタイプ2の記述方式をした場合、囲われている[マニュアル文章形式]に対して以下のような加工がなされる。

PDFの場合
- refの内容がcodeの場合
  [マニュアル文章形式]の直後に、 () つきで、参照先のタグの章番号などTeX順所の参照番号が「節」「章」「図」「表」などの文字とともに挿入される。
- refの内容がURLの場合
  [マニュアル文章形式]の直後に、 () つきで、URLが記述される。
HTMLの場合
- refの内容がcodeの場合
  [マニュアル文章形式]の全体を、アンカーで囲い、参照先へのリンクをはる。
- refの内容がURLの場合
  [マニュアル文章形式]の全体を、URLで示されるページへのアンカーで囲う。

codeが解決出来なかった場合は、UNDEF REFERENCE ( codde) の文字列を挿入する。

▲ページトップへ戻る

参考

バグ

▲ページトップへ戻る

$GLOBALBASE��AI[v\[XE\tgEFAxvOSOURCEFORGE.JP��QBĂ܂B$