SimpleTOC – 目次ブロック

説明

投稿やページに目次ブロックを追加します。TOC は、記事またはページで見つかったすべての見出しへのリンクのネストされたリストです。これを使うには、ブロックを追加して「SimpleTOC」または単に「TOC」を検索するだけです。

ブロックのサイドバーで目次の最大深度を設定することができます。「目次」という見出しを非表示にして、通常の見出しブロックを使って独自の見出しを追加することができます。

SimpleTOC はオープンソースで、GitHub Pages で開発されています。もしバグを見つけたり、機能のアイディアがあれば、お気軽に貢献し、プルリクエストを作成してください。

SimpleTOC がインストールされた状態の、新しい WordPress インスタンスを起動する

機能

  • 設定はゼロ: SimpleTOC ブロックを投稿に追加するだけです。
  • 最小限かつ有効な HTML 出力。
  • アコーディオンメニューを有効にしない限り、JavaScript や CSS を一切使用しません。
  • Gutenberg のために設計されています。
  • Gutenberg のネイティブグループスタイリングオプションで SimpleTOC をスタイリングします。
  • テーマのスタイルを継承します。
  • 複数の言語に翻訳されています。以下を含みます: ドイツ語、日本語、中国語(繁体字)、オランダ語、ブラジルポルトガル語、フランス語、スペイン語、ラトビア語。

カスタマイズ

  • Gutenberg のグループを使って背景色や文字色を追加。
  • ワイドとフルワイドのネイティブブロックに対応。
  • 見出しの最大深度を制御します。
  • 順序付きリスト、箇条書きリストから選択できます。リストをインデントできます。
  • 見出しレベルを選択することや、段落にすることができます。
  • TOC ブロックの h2 見出しを無効にして、独自の見出しを追加します。

互換性

  • GeneratePress と Rank Math に対応。
  • 人気の AMP プラグインに対応。

クレジット

This plugin is forked from pdewouters and uses code from Easy-Table-of-Contents

Tom J Nowell と Sally CJ には、wordpress.stackexchange.com での私の質問をたくさん助けてもらいました。

紀元前100年頃、目次を発明したクイントゥス・ヴァレリウス・ソラヌスに感謝します。

スクリーンショット

  • Gutenberg エディターの SimpleTOC ブロック。
  • 投稿内の SimpleTOC。
  • シンプルでパワフル。各目次を好きなようにカスタマイズ。
  • 見出しの最大深度を制御します。
  • SimpleTOC styled with Gutenbergs native group styles.
  • SimpleTOC Advanced 機能
  • Gutenberg Heading block: Set a custom anchor
  • SimpleTOC hidden in the accordion menu.

ブロック

このプラグインは1個のブロックを提供します。

  • SimpleTOC Adds a Table of Contents.

インストール

SimpleTOC は WordPress の管理画面内のプラグインメニュー (プラグイン -> 新規追加) からインストールすることができます。または、WordPress.org からダウンロードし、手動でインストールすることもできます。

Gutenberg でブロックを追加し、”SimpleTOC” または単に “TOC” を検索してください。ブロックを使用する前に、コンテンツを保存してください。

FAQ

Gutenberg のグループを使って SimpleTOC に背景色を追加するにはどうすればよいですか ?

ブロックを選択し、コンテキストメニューから「グループ」を選択します。このグループに「背景色」、「リンク色」、「文字色」を適用します。SimpleTOC にこれらのスタイルが継承されます。このスタイルが適用されたSimpleTOC グループを、次に記事を書くときに使いたいですか ? 再利用可能なブロックに変換してください。

目次から一つの見出しを隠すには、どのようにすれば良いですか ?

If you really want to hide a single heading from the table of contents, then add the CSS class “simpletoc-hidden” to a heading block. You can find this field in the same place as the HTML anchor field: In the Block > Advanced sidebar. But first, think about the reason you would like to hide a specific heading. Maybe you would like to remove all headings of a specific depth level. Then there is an option for that in the blocks options in Gutenberg. If you think this heading should not be part of the toc perhaps it is not needed in the post itself?

I would like to save my SimpleTOC settings as default. Is that possible?

You can convert your configured SimpleTOC block into a reusable block in Gutenberg. It will keep its settings. This way, you can use your desired settings for each new post by adding the reusable block.

How to add a div tag wrapper to the TOC?

If you add a custom class to the SimpleTOC block in “Advanced” and then “Additional CSS Class(es)” a div with that class will be wrapped around the HTML output. You can force this with a filter, too.

例:

add_filter( 'simpletoc_wrapper_enabled', '__return_true' );

How to allow developers to exclude specific headings programmatically?

Use the ‘simpletoc_excluded_blocks’ filter. For example, this code will exclude heading blocks that are inside a column block.

例:

add_filter( 'simpletoc_excluded_blocks', function ( array $blocks ) {
    $blocks[] = 'core/column';

    return $blocks;
} );

How do I change the color of the accordion menu?

The heavy plus character I used can not be colored with css without hacks. But you can change the icon to something else and change the color of the new icon.

.simpletoc-collapsible::after {
    content: "✖";
    color: #e94c89;
}

すべての記事に SimpleTOC を自動的に追加するにはどうすればよいですか ?

I don’t see an easy solution at the moment. SimpleTOC is only a block that can be placed in your post. If there was a plugin that adds blocks to every post, then this would be the solution. I think this should be another separate plug-in to keep the code of SimpleTOC clean and … well, simple.

評価

2023年1月9日
No need for shortcodes. This TOC is conveniently added as a block from within the editor. Various useful block settings can be configured from within the editor. Desirably lightweight.
2022年12月13日 1 reply
one of the best plugins I have ever used. BUT THE TOC AUTO UPDATE IS SO ANNOYING, PLEASE LIKE BEFORE THERE WAS A BUTTON TO DO THAT
2022年11月27日
I'm not a code and I can't judge of the real optimization of this plugin but it is simple to use and clean. Much appreciated.
2022年11月7日 1 reply
I like the plugin a lot. It's simple. It works pretty well and has a few configurations but not too many. Thanks for it! I am using it to learn Wordpress blocks development, which coming from PHP I think it's quite a challenge. Blocks change the development weight from PHP to JS/React a lot!
2022年10月31日
The beauty of SimpleTOC is that you can add it to longer posts that need a Table of Contents, with the ability to choose which Heading levels should be shown and other options. Nothing fancy ... and that's what I like about this plug-in. Thanks / Danke to Mark.
2022年10月23日 1 reply
A great plugin allowing a Table of Contents to be created with minimal input. A great follow-up service too. Marc was extremely helpful and reviewed my query within minutes of posting. He guided me through what I needed to do, and he was able to update me on my query. Super service.
49件のレビューをすべて表示

貢献者と開発者

SimpleTOC – 目次ブロック はオープンソースソフトウェアです。以下の人々がこのプラグインに貢献しています。

貢献者

“SimpleTOC – 目次ブロック” は16ロケールに翻訳されています。 翻訳者のみなさん、翻訳へのご協力ありがとうございます。

“SimpleTOC – 目次ブロック” をあなたの言語に翻訳しましょう。

開発に興味がありますか ?

コードを閲覧するか、SVN リポジトリをチェックするか、開発ログRSS で購読してみてください。

変更履歴

5.0.53

  • Fix: Prevent direct access to plugin files. Thanks rafaucau!

5.0.52

  • Fix: wp_set_script_translations undefined in older WordPress installations.

5.0.51

  • Fix: Accordion menu CSS alignment.

5.0.50

  • Fix: Identifier ‘i’ has already been declared
  • Fix: SimpleTOC will not nag the user about changed content in the editor anymore. Therefore I removed the corresponding option from the settings.
  • Fix: Minor changes to accordion css.

5.0.45

  • Feature: Option to render SimpleTOC heading as paragraph.
  • Fix: Added margin to the bottom of the accordion menu.

5.0.43

  • Compatibility with WordPress 6.1
  • Feature: Hide SimpleTOC in an accordion menu. Adds minimal JavaScript and css styles if enabled.
  • Feature: Option to change SimpleTOC block heading level.
  • Fix: Accordion menu can now be added multiple times.
  • Fix: Accordion styling in Gutenberg editor.
  • Fix: Minor accordion styling fixes.
  • Fix: Added JavaScript and CSS for the accordion menu by using standard methods.

5.0.36

  • Feature: Spin up a new WordPress instance with the SimpleTOC plugin already installed.
  • Fix: Better handling for simpletoc-hidden class to hide headings. Thank you blronaldhuereca!

5.0.34

  • Feature: Moved list controls to toolbar and rearranged settings to fit block order.
  • Feature: Filter for developers to wrap toc with a div tag. Thank you rafaucau!
  • Fix: Minor localization tweaks.

5.0.31

  • Feature: Filter for developers to exclude specific blocks. See faq for details. Thanks rafaucau!
  • Feature: Easier development with @wordpress/env to start a dev environment. Thanks rafaucau!

5.0.28

  • Feature: Change the TOC headline in the block options. Thank you Philipp Stracker!

5.0.17

  • 機能: 見出しのカスタムアンカー ID をサポートしました。Matthias Altmann さん、ありがとうございます。