システム変数
システム変数
下記のシステム変数を設けています。これらは変更不可です。
・@Doc = doc #この文書そのもの ・@DocTitle = doc.title #この文書の文書名 ・@DocIndex = doc.index #この文書の文書番号(0〜) ・@DocText = doc.text #この文書の生テキスト ・@NextDocTitle = docs[next_index].title #次の文書の文書名 ・@NextDocIndex = docs[next_index].index #次の文書の文書番号(0〜) ・@PrevDocTitle = docs[prev_index].title #前の文書の文書名 ・@PrevDocIndex = docs[prev_index].index #前の文書の文書番号(0〜) ・@Item = item #この文書があるアイテムそのもの ・@ItemSubject = item.title #アイテムの件名 ・@ItemMessageId = item.message_id #アイテムのメッセージID ・@ParentSubject =doc.parent.parent #親アイテムの件名 ・@ParentMessageId =doc.parent.message_id #親アイテムのメッセージID ・@ProjectSubject = doc.parent.project #プロジェクトの件名 ・@ProjectMessageId = doc.parent.project.message_id #プロジェクトのメッセージID ・@NextItemSubject = doc.parent.next.title #次のアイテムの件名 ・@NextItemMessageId = doc.parent.next.message_id #次のアイテムのメッセージID ・@PrevItemSubject = doc.parent.prev.title #前のアイテムの件名 ・@PrevItemMessageId = doc.parent.prev.message_id #前のアイテムのメッセージID
使い方
システム変数も文書中で ERB にて展開しているので、基本的にはプラグインと同じ使い方です。
{{ システム変数 }}
にて記述記述してください。
以下、例を示します。
前の文書タイトル
テキスト
この文書は
・@DocTitle = {{@DocTitle}}
・@DocIndex = {{@DocIndex}}
表示
この文書は
- @DocTitle = 前の文書タイトル
- @DocIndex = 1
システム変数のテスト文書
テキスト
・@Doc = {{@Doc}}
・@DocTitle = {{@DocTitle}}
・@DocIndex = {{@DocIndex}}
・@NextDocTitle = {{@NextDocTitle}}
・@NextDocIndex = {{@NextDocIndex}}
・@PrevDocTitle = {{@PrevDocTitle}}
・@PrevDocIndex = {{@PrevDocIndex}}
・@Item = {{@Item}}
・@ItemSubject = {{@ItemSubject}}
・@ItemMessageId = {{@ItemMessageId}}
・@ParentSubject = {{@ParentSubject}}
・@ParentMessageId = {{@ParentMessageId}}
・@ProjectSubject = {{@ProjectSubject}}
・@ProjectMessageId = {{@ProjectMessageId}}
・@NextItemSubject = {{@NextItemSubject}}
・@NextItemMessageId = {{@NextItemMessageId}}
・@PrevItemSubject = {{@PrevItemSubject}}
・@PrevItemMessageId = {{@PrevItemMessageId}}
表示
- @Doc = #
- @DocTitle = システム変数のテスト文書
- @DocIndex = 2
- @NextDocTitle = 次の文書タイトル
- @NextDocIndex = 3
- @PrevDocTitle = 前の文書タイトル
- @PrevDocIndex = 1
- @Item = #
- @ItemSubject = システム変数
- @ItemMessageId = 20080310095542064026@1214510797115.TPZ
- @ParentSubject = HtmlOut_for_TPZ
- @ParentMessageId = 2008030319070408254@1214510797115.TPZ
- @ProjectSubject = HtmlOut_for_TPZ
- @ProjectMessageId = 2008030319070408254@1214510797115.TPZ
- @NextItemSubject = html入力支援コマンド
- @NextItemMessageId = 2008031017045104360@1214510797115.TPZ
- @PrevItemSubject = 文字列の置換について
- @PrevItemMessageId = 2008053010442006580@1214510797115.TPZ
補足 @Doc や @Item は、オブジェクトそのものなので、 実際の出力は
<li>@Doc = #<Tpz::TpzItemDocument:0x297d98c></li>
<li>@Item = #<Tpz::TpzItem:0x297d874></li>
となっています。
これは、プラグインから使いやすいように用意してあります。
次の文書タイトル
テキスト
この文書は
・@DocTitle = {{@DocTitle}}
・@DocIndex = {{@DocIndex}}
表示
この文書は
- @DocTitle = 次の文書タイトル
- @DocIndex = 3
一応最初だったり最後だった場合は、何もしない
テキスト
この文書は最後の文書です。次の文書は？
・@PrevDocTitle = {{@PrevDocTitle}}
・@PrevDocIndex = {{@PrevDocIndex}}
表示
この文書は最後の文書です。次の文書は？
- @PrevDocTitle = システム変数のテスト文書
- @PrevDocIndex = 2