Title: 目次の自動作成ウィジェット プラグイン

Anchor in Circle Imageこのプラグインは、記事の中の見出し行(H1 や H2 などの見出し用の HTML タグ)を基に目次を自動生成します。

記事の目次が自動生成されるので、手動で目次を作成して更新したり、アンカーリンクを張る手間が省けます。よくある「見出しを変更した際に目次を更新し忘れる」等の人為的なミスも防ぐことができます。また、目次を設置することで記事の内容をひと目で把握しやすくなる効果が期待できます。

注意点は、H1、H2、H3 などの見出し行を階層的に記述・設置する必要があることです。この点だけ注意すれば、とても便利な目次を簡単に設置できますので、是非ご活用ください。



Original Icon by Timothy Miller iconfinder.com/ic…
License: Creative Commons (Attribution-Share Alike 3.0 Unported)





インストール



下のリンクをクリックしてプラグインの .zip ファイルをダウンロードします。



サーバーセットアップ > プラグインのページの「新規プラグインのインストール」で .zip ファイルを選択してアップロードします。

アップロードが完了すると、「インストール済みプラグイン」の一覧に「I18N ERROR」が表示されますが、これはプラグイン中の日本語ファイルがまだ動作に反映されていないために表示されるエラーです。

I18N エラー

TeamPage を再起動すると、このエラーは表示されなくなります。サーバーセットアップ > 一般 > サーバー管理 の [TeamPage の再起動] ボタンをクリックして TeamPage を再起動してください。TeamPage クラウドでは再起動が2回必要です。

サーバーセットアップ > プラグイン のページを開き、[目次ウィジェット (TOC Widget)] が表示されていることを確認します。

インストール完了

以上でインストールは完了です。

見出しの表示例



下図は目次の表示例(画像)です。見出しの階層や見出しの記号(黒丸や数字)などはウィジェットの挿入/編集ダイアログで選択・設定できます。

目次を一階層のみ表示した例



目次を一階層のみ表示した例

目次を二階層まで表示した例



目次を二階層まで表示した例

目次を三階層まで表示した例



目次を三階層まで表示した例

目次の見出し記号を数字にした例



目次の見出し記号を数字にした例

使い方



次に、使い方を (1) ウィジェットの挿入と (2) 見出し行の作成・設定に分けて説明します。どちらから始めても構いません。

ウィジェットを挿入する



目次を挿入する場所にカーソルを移動し、[ウィジェットの挿入/編集] アイコンをクリックします。ウィジェットの一覧の中から [目次] を選択します。

ウィジェットを挿入する

ウィジェットの設定画面が表示されます。



ウィジェットの設定

設定が完了したら [OK] をクリックします。

記事本文のカーソル位置にウィジェットが挿入されたことを確認します。

ウィジェットが挿入された

見出し行を作成・設定する



記事の本文に見出し行を作成します。

見出しにする行を選択し、ドロップダウンリストから「ヘッダー1」〜「ヘッダー6」に変更します。それぞれが「H1」〜「H6」に対応します。

見出し行を設定する

各見出しが階層的になるように注意してください。

例えば、次のように「ヘッダー 1 の一階層下にヘッダー 2 があり、さらに一階層下にヘッダー 3 がある」のはOKです。



それに対して、次のように、「ヘッダー 1 より浅い階層にヘッダー 2 があり、ヘッダー 3 を飛ばしてヘッダー 4 がある」ようなものはNGです。



見出しの一番上の階層(最も浅い階層)は、ウィジェットの「開始レベル」設定(上述)選択した階層に合わせてください。例えば、「開始レベル」設定で「レベル 2 (H2)」を選択した場合は、見出しの階層を「ヘッダー 2」から始めます。

記事の投稿



ウィジェットの挿入と見出し行の作成が完了したら、[送信] ボタンをクリックして記事を投稿します。

記事を投稿する

目次の動作確認



投稿された記事に目次が表示されていることを確認します。

目次が挿入された

旧型の目次作成プラグインとの比較



同じような目次作成ウィジェットとして Download1189: 記事の目次ウィジェット プラグイン (「旧型」と呼びます)が既にありますが、旧型プラグインでは、見出しは必ず「ヘッダー 1」から始める必要があります。それに対して、この新型プラグインでは、見出しを「ヘッダー 2」や「ヘッダー 3」から始めることができ、既に作成済みの、ヘッダー 1 がない記事(見出しがヘッダー 2 や 3 から始まる記事)にも導入しやすくなっています。

旧型ウィジェットを記事に埋め込み済みの場合、記事を編集して旧型ウィジェットを新型ウィジェットへ置き換える必要はありません。旧型プラグインをアンインストールまたは非アクティブにして、新型プラグインをインストールすれば、記事に埋め込み済みの目次ウィジェットは自動的に新型に置き換わります。



Attachments:
toc_lv1.png
toc_lv2.png
toc_lv3.png
toc_ol.png
toc_02.png
toc_04.png
toc_06.png
anchor_200x200.png
toc_1.png
toc_2.png
toc_3.png
i18n_error_ja.png
toc_installed_ja.png
関連記事
Article: Download1985 (permalink)
Categories: :DocJp:プラグイン
Date: 2017/08/04; 16時40分02秒 JST

Author Name: TeamPage サポート
Author ID: jpbo