Page TOC Generator (0.9)

参照ページ：Page TOC Generator

テスト環境

• サーバ：DreamHost 　
  • PHP 5.2.6
  • MYSQL 5.0.32
• MODx： 0.9.6.3
• Page TOC Generator (0.9)

利用の流れ

1. Page TOC Generator plugin を導入します。
2. 目次を生成したいドキュメントにおまじないを書きます
   • おまじないを書いたドキュメントにのみ目次が挿入されます

インストール

以下の要項で、プラグインを作成します。プラグインの作成方法は、こちらを参照して下さい。このプラグインに外部リソースはありません。

• プラグイン名：Page TOC Generator
• システムイベント
  • OnWebPagePrerender

運用

1. ページ中で、目次化したい始まりに以下を書きます。
   • <!--#toc_plugin#_START_TOC_INDEXING-->
2. ページ中で、目次化したい終わりに以下を書きます。
   • <!--#toc_plugin#_END_TOC_INDEXING-->
3. 目次を書き出したい位置に以下を書きます。
   • <!--#toc_plugin#_TOC_OUTPUT-->
4. コンフィギュレーションを書きます（後述）

インスタンス

入力例

<!--#toc_plugin#_TOC_OUTPUT-->
<!--#toc_plugin#_START_TOC_INDEXING-->						
<h2>ここは見出し２です</h2>
<p>ここは、文章です。</p>
<h2>ここは見出し２です</h2>
<h3>ここは見出し３です</h3>
<p>ここは文章です。</p>
<h3>ここは見出し３です</h3>
<p>ここは文章です。</p>
<!--#toc_plugin#_END_TOC_INDEXING-->

出力例

<div id="toc">
  <h2>Page Contents</h2> 
  <ul>
    <li><a href="#Here is a heading_1">ここは見出し２です</a></li>
    <li><a href="#Here_is_another_heading_2">ここは見出し２です</a>
      <ul>
        <li><a href="#Here_is_a_subheading_3">ここは見出し３です</a></li>
        <li><a href="#Here_is_another_subheading_4">ここは見出し３です</a></li>
      </ul>
    </li>
  </ul>
</div>

コンフィギュレーションパラメータ

<!--#toc_plugin#_START_CONFIGURATION-->

コンフィギュレーションパラメータの始まりを宣言します。(オプション)

<!--#toc_plugin#_list_type=ul-->

 出力タイプを<ul>にするか<ol>にするかを決定します。デフォルト<ul>

<!--#toc_plugin#_start_level=1-->

目次化する始まりの見出しを決定します。デフォルト「1（<h1>）」。1～6（<h1>～<h6>）を指定できます。

<!--#toc_plugin#_end_level=2-->

目次化する終わりの見出しを決定します。デフォルト「2（<h2>）」。1～6（<h1>～<h6>）を指定できます。

<!--#toc_plugin#_header=Page Contents-->

目次のタイトルを指定します。デフォルト「Page Contents」

<!--#toc_plugin#_header_tag=h2-->

目次タイトル用のタグを指定します。デフォルト「<h2>」。<p>や<div>なども指定できます。

<!--#toc_plugin#_parent_tag=div-->

目次を囲むタグを指定します。デフォルト「<div>」。取り去る場合は、何も指定しないで下さい。

<!--#toc_plugin#_parent_tag_id=toc-->

目次を囲むタグのidを指定します。デフォルト「toc」。

<!--#toc_plugin#_END_CONFIGURATION-->

コンフィギュレーションパラメータの終わりを宣言します。 (optional)

サンプル

このページをご覧ください。他にページにも徐々に追加していく予定です。。

サンプルコンフィギュレーション

<!--#toc_plugin#_START_CONFIGURATION--> 
<!--#toc_plugin#_list_type=ul--> 
<!--#toc_plugin#_start_level=2--> 
<!--#toc_plugin#_end_level=3--> 
<!--#toc_plugin#_header=目次--> 
<!--#toc_plugin#_header_tag=h2--> 
<!--#toc_plugin#_parent_tag=div--> 
<!--#toc_plugin#_parent_tag_id=toc--> 
<!--#toc_plugin#_END_CONFIGURATION--> 

<!--#toc_plugin#_TOC_OUTPUT-->  //ここに目次が出力されます