ja:plugin:toctweak
目次
目次微調整プラグイン
この拡張は二年以上更新されていません。もはや維持管理や対応がされておらず、互換性に問題がある可能性があります。
This extension is not in the 'plugin' or 'template' namespace and is therefore ignored.
類似 inlinetoc, intoc, toc, tocafterheadline
インストール
拡張機能管理かプラグイン管理と最新バージョンがリンクされた上記のダンロード URL を使ってプラグインをインストールして下さい。 プラグインのインストール方法を参照して下さい。
例と使用方法
1. 目次を閉じた状態に初期設定する
~~CLOSETOC~~
- 目次ボックスを閉じた状態に初期設定します(ページに目次を表示する場合)。自分では何も出力しない制御マクロの一種です。
2. 目次に表示する見出しの最上位と最下位レベルの設定
~~TOC:2-4 ~~
- ページの目次の内容を操作します。二つの数字パラメータです:設定項目: toptoclevelと 設定項目: maxtoclevel
- 上の例の場合、目次にページ表題(例:最初の第1見出し)は含みません。自動作成の目次に含まれるのはレベル2から4の見出しです。
- 以下の例のように、見出しの最上位か最下位レベルのどちらかを微調整できます:
~~TOC:2~~ ~~TOC:-3~~
3. 目次の配置の移動
{{TOC}}
- 右上隅に配置された目次ボックスをページ上の任意の場所へ移動・スライドします。Wiki 文章内の
{{TOC}}
マクロは元の目次 HTML と同様に表示されるので、正確には目次位置はページ内の垂直方向のみに変更可能です。タグ行との競合を避けるために、二番目の見出しの後に目次ボックスを配置したい場合に便利です。
{{TOC:wide}}
#dw__toc
と識別される目次 div ボックスに css クラスを与えます。上の例の場合、“wide” というクラス名を目次ボックスに適用し、#dw__toc.wide
と識別され、目次はページ内に 100% 幅で表示されます。“wide” クラスはこのプラグインの style.css で定義されています。
{{TOC:2-3 wide}}
- この構文では、クラスと見出しレベルパラメータの両方を与えることができます。
4. インラインの目次
{{INLINETOC:width18 3-4}}
- この構文は、ページ内容の中にページの目次を表示します。“width18” クラスはこのプラグインの all.css で定義されています。
設定
管理者メニューにある設定管理画面上で、プラグインの設定ができます。
tocPosition | 通常ページの目次の配置を変更する。 |
---|---|
0: デフォルト(右上) | |
1: 最初の見出しの後 | |
2: 最初の第1見出しの後 | |
3: 目次を表示しない(無効にする)。目次を表示するには {{TOC}} か {{INLINETOC}} を使用する。 |
開発
github リポジトリの変更履歴
- add ~~TOC_HERE_CLOSED~~ (2018-04-06 14:45)
- Merge pull request #11 from ssahara/v2.0.3 (2018-04-06 11:29)
- allow toc macros found in other pages (2018-04-05 09:25)
- integrate closetoc to autotoc syntax (2018-04-03 15:56)
- separate render_xhtml() from render() (2018-04-03 14:47)
TODO と要望一覧
- コードの最適化
- 目次のサイドバーへの移動。{{SIDETOC}} みたいな?
- 微調整した目次を有効にしつつ、組込の目次を無効にするオプション(2014-04-26 リリース済)
既知のバグと問題
- inlineToc は RTL 画面ではうまく機能しません。点が目次ボックスの外に配置されます。又下位の見出しが字下げされません。(2014/05/06)
→2014年5月7日のリリース以降、RTL スタイルが all.css に追加されました。RTL 言語にとって充分かどうかを確認しここにコメントしてください。
FAQ
議論
ja/plugin/toctweak.txt · 最終更新: 2014-07-18 19:00 by 106.136.23.104