Tracのwikiテンプレートを利用する

Tracwikiには予めテンプレートを用意しており、新規ページに作成時にはこれを使うようにしている。目的は下記の通り。

記載項目の共通化

例えば、wikiページに目次やナビゲーションを表示する下記のプラグインは全てのwikiページで利用しているが、こんな項目を新規のwikiページへいつも書くのは面倒だ。テンプレートに予め記載されていれば書く手間が省けて都合がよい。

同様に、見出し項目(構成)やプロジェクト固有の情報もテンプレート化して準備しておくと記載が統一されて便利だろう。

マクロの記載

Tracプラグインを幾つも導入していると、その記載方法が直ぐに思い出せなくて困ることがある。標準のwiki記法に記載されている箇条書きなら頻繁に使うので忘れないけれど、プラグイン固有の記法なんてたまにしか使わないのでなかなか覚えられない。仕方ないので、テンプレートに予め記載しておくようにした。これなら直ぐに使えて便利だ。

以上を合わせたテンプレートのサンプルはこんな形になる。必須項目はそのまま利用して、必要な項目はコメント領域に記載されているものをコピーして使えばよい。(下記のiPhoneがプロジェクト名に相当するので、ここを置換して使う)

= Title =
[[TracNav(TocMenu)]]
[[TOC]]

{{{
#!comment

== 目次 ==
 * [wiki:iPhone/Tools 開発ツール]
 * [wiki:iPhone/ChangeLog 変更履歴]
 * [wiki:iPhone/Tasks 課題]
 * [wiki:iPhone/Tips Tips]

== 関連 ==
[[ListTagged("iPhone")]]

== 状況 ==
== チケット ==
[[TicketQuery(status= accepted|new|reopened,component=iPhone,order=id,desc=1,format=table,col=summary|type|status|changetime|owner)]]
=== リポジトリ ===
[[ChangeLog(/iPhone, 3)]]
}}}

こんなページを作ってPageTemplates直下に保存しておく。あとは新規wikiページ作成時に、ポップアップメニューでテンプレートを選ぶだけだ。

After you have created your new template, a drop-down selection box will automatically appear on any new wiki pages that are created.

PageTemplates – The Trac Project



関連