(ヽ´ω`) < 助けてほしいマン

わからないことを助けてほしいマンが書くブログ

(ヽ'ω`) < Moinmoinのマクロについて-はじめに

(ヽ´ω`) < マクロってなんなの?

Moinmoinでのマクロとは、公式のドキュメントでは以下のように説明されている。

Macros allow the insertion of system features into normal wiki pages;

HelpOnMacros - MoinMoin

ユーザがページ内に埋め込むことができる、システム(Moinmoin)の機能ということで、管理者側の仕組みというわけではなく、主にユーザ側で利用される機能となる。

(ヽ´ω`) < で、何ができるの?

ページ内にマクロを記述することで、検索のためのテキストボックスを設置したり、ページカウンターを設置することができる。

デフォルトで用意されているマクロはいくつかあるが、公式ドキュメントでは以下の4グループに分類されている。

  1. 検索マクログループ
  2. ナビゲーションマクログループ
  3. システム情報マクログループ
  4. その他グループ

それぞれについての簡単な説明

1. 検索マクログループ

ページ検索のためのマクロ群。検索フォームを作成したり、条件にマッチするページ一覧を表示する機能を提供する。

カテゴリ表示のための<<FullSearch(category:HogeCategory)>>なんかもこのグループ。

2. ナビゲーションマクログループ

"最近更新されたページ一覧"や"どのページからもリンクされてないページ一覧"など、特定の条件のページを表示したり、ページ内の見出しを作成する機能を提供。

更新されたページをサイドバーに表示するのはよくあるパターンですわな。

あと<<TableOfContents()>>は見やすいページを作成するのに必須かと。

3. システム情報マクログループ

ページカウンターやページのサイズの表示のほか、システムに入っているPythonの情報や、wikiconfig.pyに関する情報を表示することができる。

が、多分普通のユーザにはページカウンターの<<Hits>>ぐらいしか意味が無いかと。

4. その他

その他、上記グループに属しないマクロ群。

グループ分けができなかっただけで、実はこのグループに属するマクロの使用頻度は高いと思われる。

特に使用頻度が高そうなのが、

  • Moinmoinで用意されているアイコンを埋め込むことができる<<Icon>>
  • 改行を行う<<BR>>

の2つ。

(ヽ´ω`) < なんか多そう…

全部のグループをひとまとめで見るとかなり多そうだが、グループ単位で、さらに実際に使用する可能性があるものに絞ってみてみると、そこまで多くない感じ。

別エントリで1グループづつ、使わなさそうなマクロは除外して解説していく。