説明

ページの目次を作成するプラグインです。
(contentsx v1.0 系統版のマニュアルをWebから拾ってきてコピーしたものです。詳しくは、「contentsx」でググること)

書式

#contentsx(オプション)

option=bool なオプションは共通して、 option, option=true, option=on でそのオプションが有効になり、option=false, option=off で無効になります。

  • fromhere=bool
    • #contentsx がある行以降の見出しのみをリストする。デフォルトで有効。
      備考:page オプションで別ページを指定した場合は強制的に off になります。
  • include=bool
    • #include プラグインで取り込んでいるページとその見出しも扱う。 デフォルトで有効。
  • hierarchy=bool
    • 階層的表示。デフォルトで有効。
  • compact=bool
    • リストのレベルを詰める。デフォルトで有効。使用例参照のこと。
  • num=数字
    • 表示件数指定。正数は前からN件目、負数は後ろからN件目の意味。
      num=1:10 で先頭1件目から10件目までの意味。num=-10:-1 で後ろ10件目から後ろ1件目までの意味。num=2: で先頭2件目から最後までの意味。
      num=5+2 で先頭5件目から、そこから2件先まで(5,6,7)の意味。
  • depth=数字
    • 見出しレベル限定。数字の指定は num と同じ書式。includeページタイトルはレベル0になる。 compact=on,off に関わらず絶対値指定。
  • except=正規表現
    • リストしない見出しを正規表現にて指定。
      ヒント: ereg で判定を行います。 except=Test|sample → Test または sample を含む見出しを除く。
  • filter=正規表現
    • リストする見出しを正規表現で限定する。
      ヒント: ereg で判定を行います。
  • link=on|off|anchor|page
    • リンク形態指定。デフォルトは on。
      on は現在ページへは link=anchor、page オプションで別ページが指定されていた場合 link=page。
      anchor は強制的にアンカーのみ使用。
      page は強制的にページ名も含めたリンク。
      off はリンクしない。
      ヒント: link=anchor で include したページに対してもページ内アンカーによるリンクを貼れます。include にはもともと対応していますが、類似のものにも対応できると思います。link=page はついでです。
  • page=ページ名
    • 見出しリストを行うページを指定。デフォルトはカレントページ。
  • cache=on|off|reset
    • キャッシュの利用。デフォルトで有効。reset でキャッシュの強制再作成。

トップ   差分 バックアップ リロード   一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2010-09-07 (火) 01:34:14 (3458d)