TocMacro

Tracの[管理]-[プラグイン]でtractocmacroをONにしてください。(デフォルトON)

プラグインの概要

ページのインデックスを表示するマクロです。

概観

toc.png

使い方

インデックスを表示したい場所に [[TOC]] と記入します。別のページのインデックスを作成することもできます。

以下のオプションで必要なものを指定することで、表示形式を変更することができます。なお、オプション名と同名のWikiページがあった場合はオプションの方が優先されます。

オプション 内容
heading=タイトル名 ヘッダーで表示される"Table of Contents"をタイトル名に書き換えます (使用例 1)
noheading ヘッダーを表示しません
depth=n 表示する見出しの階層を指定します。 n階層まで表示します (使用例 1)
inline 黄色のボックスでサイドに表示せずに、ページの本文側に表示します  (使用例 2)
sectionindex Wikiページの一覧とページのタイトルを表示します
titleindex Wikiページの一覧とページのタイトルを表示します。標準マクロのTitleIndexと似た動作のようです (使用例 3)
notitle ページのタイトルを表示しません (使用例 3)
reverse   titleindexやsectionindexを使用する際にページ名を逆順ソートして表示するようです (使用例 3)

使用例 1

ヘッダーと階層はいくつか指定してみます。該当ページのインデックスが表示されます。

[[TOC(heading=depth無指定です)]]
[[TOC(heading=depth=1です,depth=1)]]
[[TOC(heading=depth=2です,depth=2)]]

= XXプロジェクトのTracにようこそ =
toc01.png

使用例 2

1行目は別ページである WikiFormattingとTracGuideのページのまとめてインデックスを作成しています。表示結果が①です。
2行目はTracQueryをインライン表示をしています。その結果が②です。

[[TOC(heading=Wikiフォーマットとガイド,WikiFormatting,TracGuide)]]
[[TOC(TracQuery,inline)]]

= XXプロジェクトのTracにようこそ =

toc02.png

使用例 3

1行目は !Wikiページ の titleindex の表示になります。表示結果が①です。
2行目は !Wikiページ の titleindex を逆ソートしてインライン表示しています。その結果が②です。

[[TOC(titleindex, notitle, heading=All pages)]]

[[TOC(titleindex, notitle, heading=All pages,inline,reverse)]]
toc03.png