クロスリファレンス文法¶
クロスリファレンスは、意味解釈済みのテキストロールから生成されます。
基本的には :ロール:`用語` という形式で書くだけでクロスリファレンスを作成することができます。
このときは 用語 というアイテム名で、 ロール で指定されたタイプを持つリンクが作成されます。
リンクに表示されるテキストは 用語 と同じになります。
追加の補助機能¶
追加の補助機能がいくつかありますが、これはロールに対するクロスリファレンスの目的を増やすものになります。:
:ロール:`タイトル <参照対象>` というreSTのハイパーリンクに似た書き方をすると、タイトルと参照対象の両方を明示することができます。 この場合は 参照対象 を参照するリンクになりますが、リンクテキストとして表示されるのは タイトル になります。
用語の先頭の文字に ! を指定すると、参照もハイパーリンクも作成されなくなります。
用語の先頭の文字に ~ を設定すると、リンクテキストは最後の項目だけが表示されるようになります。 例えば、 get() というマークアップがあったとすると、 Queue.Queue.get に対して参照が作成されますが、リンクテキストとしては get が表示されます。
HTML出力時には、リンクの title アトリビュート(マウスを上に持って行ったときにツールチップとして表示されるテキスト)には、常に、完全な参照対象の名前が設定されます。