contents2_1.inc.php

org:自作プラグイン/contents2_1.inc.phpのミラーです。

contents2_1.inc.php の開発は停止します。改めて一から書き直した Plugin/contentsx.inc.php に移行してください。 -- 2006-05-17 (Wed) 01:30:43

#contents のプラグイン化、そして拡張 (old)

Table of Contents

説明 関連 書式 オプション ダウンロード もっと便利に - include2.inc.php 使用例 既知の問題点 コメント

説明

contents プラグインは実際のところプラグインではなく、本体組み込みの機能です。 拡張がしにくいのでプラグイン化しました。 アイデアの多くはls2_1.inc.php?からきています。ということで名前はcontents2_1 です。

#contents をおいた位置より上の見出しが表示されても無駄だなと思っていた人が使うかもしれません。例えばこのページだと上の contents2_1.inc.php のリンクがいらない、と。

MenuBar に

#contents2_1(fromhere=false,hierarchy=false)

としておくのも便利かもしれません。hierarchy はお好みで。

関連

• org:欲しいプラグイン/91
  • #include内部の見出しも#contentsで階層化する
• org:欲しいプラグイン/125
  • #contentsプラグインを拡張(ページ内の記述場所以降の見出しを一覧)
• org:欲しいプラグイン/170
  • #contentsをMenuBar内に表示
• org:質問箱/287
  • #contentsの内容をMenuBar側に表示するには？
• org:続・質問箱/221
  • contents の拡張 別バージョン(#contentsをMenuBar内に表示)
• org:続・質問箱/220
  • contents の拡張(見出し一覧の階層を制限)
• dev:BugTrack/617
  • contentsプラグインが出力する目次のレベル制御を行いたい
• org:質問箱/59
  • ページへのリンクと#contents(バグ)
• org:続・質問箱/447
  • [携帯電話] #contents と 注釈 のリンクについて(バグ)
• org:続・質問箱/306)
  • タイトルが打ち消し線付きでも contents の一覧には反映されない
• org:開発日記/2003-03-29
  • リストの位置あわせをclass指定で

書式

#contents2_1([オプション])

&contents2_1([オプション]);

インライン型プラグイン時は強制的に display=inline となります。

オプション

• page=ページ名

  見出しリストを行うページを指定。デフォルトはカレントページ。

• fromhere=true|false

  #contents2_1 がある次の行以降の見出しのみをリストする。fromhere だけでも true になります。
  ファイル中の PLUGIN_CONTENTS2_1_FROMHEARE で初期値を設定できます。デフォルトで TRUE です。
  Note: 現状では #contents2_1 が２つあると一番上のものだけに反応してしまいます。 あえて page オプションで表示ページと異なるページを指定した場合は発動しないようにしています。

• display=hierarchy|flat|inline

  リスト表示形式の指定。hierarchy では見出しのレベルに応じた階層的リスト表示。 flat では見出しのレベルによらず平らに表示。inline では横に並べて表示。
  ファイル中の PLUGIN_CONTENTS2_1_DISPLAY で初期値を設定できます。デフォルトは hierarchy です。
  Note: インライン型プラグインとして使用する場合は強制的に display=inline となる。
  

• inline_before=文字列

  display=inline 時の前につける文字を設定。
  ファイル中の PLUGIN_LS2_1_DISPLAY_INLINE_BEFORE で初期値を設定できます。デフォルトでは '[ ' です。

• inline_delimiter=文字列

  display=inline 時の区切り文字を設定。
  ファイル中の PLUGIN_LS2_1_DISPLAY_INLINE_DELIMITER で初期値を設定できます。デフォルトでは ' | ' です。

• inline_after=文字列

  display=inline 時の後ろにつける文字を設定。
  ファイル中の PLUGIN_LS2_1_DISPLAY_INLINE_AFTER で初期値を設定できます。デフォルトでは ' ]' です。

• compact=true|false

  リストのレベルを調節する。display=hierarchy 用のオプションです。compact だけでも true になります。
  ファイル中の PLUGIN_CONTENTS2_1_COMPACT で初期値を設定できます。デフォルトで TRUE です。

• number=\d+ *1

  表示件数の指定。
  Note: include ページ名の表示も１つとカウントします。

• depth=\d*[-+]?\d**2

  見出しレベル指定。1 なら見出しレベル 1 のみを表示する。 2-3 のような指定も可能 (2,3 の意)。2- のように指定するとレベル 2 以上の見出し。。 2+1 のような指定も可能 (2 とそこから +1 。つまり 2,3 の意)。
  Note: include ページ名がレベル０、見出しはレベル１以降です。 現状は compact を使用していても(デフォルトで TRUE)、depth オプションで指定するレベルは変わりません。 よって見た目と指定すべきレベルが違うかもしれません。一旦 compact=false として調べれば確実です。

• except=正規表現

  リストしない見出しを正規表現にて指定。
  ヒント： ereg で判定を行います。 except=Test|sample → Test または sample を含む見出しを除く。

• include=true|false

  #include プラグインで取り込んでいるページとその見出しも扱う。include だけでも true になります。
  ファイル中の PLUGIN_CONTENTS2_1_INCLUDE で初期値を設定できます。デフォルトで TRUE です。
  Note: ページタイトルへのジャンプは #include がアンカーを張ってくれないと無理です。 下のもっと便利に - include2.inc.php をご覧ください。

• fixed_anchor=true|false

  固定アンカーがあればそれを利用する。fixed_anchor だけでも true になります。推奨です。
  ファイル中の PLUGIN_CONTENTS2_1_FIXEDANCHOR で初期値を設定できます。デフォルトで TRUE です。
  Note: 固定アンカーをつけるためには pukiwiki.ini.php 中で $fixed_heading_anchor = 1 と設定しなければいけません。現在の pukiwiki ではデフォルトで 1 です。

ダウンロード

拡張子の番号をはずして、plugin ディレクトリに放りこんでください。

もっと便利に - include2.inc.php

include プラグインは現状ではページタイトルの見出しにアンカーをつけてくれないので、 ジャンプできません。

Plugin/include2.inc.php? は #contetns2_1 のアンカーリンクに対応しているのでそちらを利用するとページタイトルへジャンプできるようになります。

使用例

次のような「とあるページ」があったとします。

**ＡＡ
#contents2_1
*Ｂ
***ＢＢＢ
**ＣＣ
#include(別のページ)
*Ｄ

「別のページ」の内容は次のとおりだったとします。

*１
#contents2_1
**１１

「とあるページ」の #contetns2_1 が変更されると思ってください。

---

#contents2_1

• Ｂ
  • ＢＢＢ
• ＣＣ
• 別のページ
  • １
    • １１
• Ｄ

---

#contents2_1(fromhere=false)

• ＡＡ
• Ｂ
  • ＢＢ
• ＣＣ
• 別のページ
  • １
    • １１
• Ｄ

MenuBar に設定する場合は fromhere=false を用いることになるでしょう。

---

#contents2_1(page=別のページ)

• １
  • １１

---

#contents2_1(compact=false)

• Ｂ
  • ＢＢＢ (表現できません。もう一段階さがります。)
  • ＣＣ

• 別のページ
  • １
    • １１
  • Ｄ

#contents2_1(compact=false,include=false)

• Ｂ
  • ＢＢＢ
  • ＣＣ
• Ｄ

---

#contents2_1(compact=false,depth=1-2)

• Ｂ
  • ＣＣ
• １
  • １１
• Ｄ

#contents2_1(compact=true,depth=1-2)

• Ｂ
• ＣＣ
• １
  • １１
• Ｄ

#contents2_1(compact=false,depth=1-2,include=false)

• Ｂ
  • ＣＣ
• Ｄ

---

#contents2_1(display=flat)

• Ｂ
• ＢＢＢ
• ＣＣ
• 別のページ
• １
• １１
• Ｄ

---

#contents2_1(display=inline,depth=1)

[ Ｂ | １ | Ｄ ]

---

#contents2_1(number=5)

• Ｂ
  • ＢＢＢ
• ＣＣ
• 別のページ
  • １

---

#contents2_1(except=Ｂ)

• ＣＣ
• 別のページ
  • １
    • １１
• Ｄ

---

#contents2_1(include=false)

• Ｂ
  • ＢＢＢ
• ＣＣ
• Ｄ

既知の問題点

プラグインで相対アンカーに完全対応できないことがわかっています。

1. アンカー番号は convert_html が呼ばれた回数が振られるのですが、#contents2_1 が数えているのは結局のところ #include の数にしかすぎません。つまり、convert_html を呼ぶ include 以外のプラグインが呼ばれるときっとずれます。
2. #include でとりこまれたページで表示される #contents2_1 のアンカーリンクの番号がまた１からはじまりうまくいきません。これは痛いです。

考察

1. convert_html 中の static $contents_id を global にしたらどうかと考えてみましたが、だめです。 できたとしても本体を改造してもらうのは痛いです。
2. plugin_contents2_1_convert を convert_html が呼んだときに引数で $contents_id を渡す ことができたらどうかと考えてみましたが、そのように convert_html を改造できたとしても、問題２は直せますが問題１は変わりません。
   ちなみに本体組み込み #contents は convert_html が $contents_id を渡しているこのような形です。include オプションがないのでこれ以上は悩む必要がないのです。
3. 固定アンカーで逃げる。

結論

1. 固定アンカー必須にせざるを得ない。

コメント

Note?

---

*1 \d+ は正規表現による表記です。例えば \d は数字のことです。
*2 \d*[-+]?\d* は正規表現による表記です。\d は数字のことです。