Opis
Axismundi Table of Contents provides the axismundi/toc block: a dynamic,
server-rendered list built from the current post’s headings, with a scroll-spy
that marks the section you are reading.
The block render and a render_block_core/post-content filter share one
deterministic slug function, so the table-of-contents anchors always match the
heading ids — regardless of render order or where you place the block (a template
aside or inside the content). Author-provided HTML anchors are respected, and
duplicate headings are de-duplicated (-2, -3).
- Two placements: a sidebar rail, or a collapsible disclosure above the
content (a native<details>whose summary can echo the current
section). A „Table of contents (above content)” pattern ships the disclosure
ready to drop before the post content. - Builds from
h2–h4by default (configurable per block). - Unordered list by default; switch to a numbered (ordered) list per block.
- Emits the shared
toc-list/toc-h2…h4/is-currentclass vocabulary so a
theme’s table-of-contents skin couples for free; ships a Material Design 3
token skin (with fallbacks) in the meantime. - Scroll-spy marks the current heading and clears when you leave the content
(above the first heading or past the post content).
Bloki
Wtyczka dodaje 1 blok.
- Table of Contents Builds an on-page table of contents from the post's headings, with a scroll-spy active state.
Instalacja
- Install and activate the Axismundi theme (for the Material Design 3 skin; the
block also works under any theme that styles.toc-list/.is-current). - Upload and activate this plugin.
- Add the Table of Contents block where you want it — typically a sidebar aside
in the single-post template, or inside a Details block above the content.
Najczęściej zadawane pytania
-
Does this plugin require an external service?
-
No. The table of contents is built on the server from the post’s own headings.
-
How are the heading ids created?
-
From the heading text via
sanitize_title(), de-duplicated in document order. If
a heading already has an HTML anchor, that id is kept. The same function feeds the
block and the heading-id injection, so the anchors always resolve. -
Does it work with non-Latin headings?
-
Yes. Non-ASCII headings (for example Korean) are percent-encoded into the same
value on both the heading id and the table-of-contents link, and the scroll-spy
matches them literally.
Recenzje
Wtyczka nie ma jeszcze żadnej recenzji.
Kontrybutorzy i deweloperzy
„Axismundi Table of Contents” jest oprogramowaniem open source. Poniższe osoby miały wkład w rozwój wtyczki.
Zaangażowani
Przetłumacz wtyczkę “Axismundi Table of Contents” na swój język.
Interesuje cię rozwój wtyczki?
Przeglądaj kod, sprawdź repozytorium SVN lub czytaj dziennik rozwoju przez RSS.
Rejestr zmian
0.1.2
- Let the host theme or template control disclosure placement and sticky
behavior so the block remains layout-neutral in the editor.
0.1.1
- Prepare the package for WordPress.org Plugin Check by removing the hidden
distribution manifest and relying on WordPress.org translation loading.
0.1.0
- Initial release: the
axismundi/tocblock (server-rendered list from post
headings) with deterministic, shared heading-id slugs andis-current
scroll-spy. - IntersectionObserver plus an rAF scroll fallback decide the active section from
one rule; the active state clears when the reading position leaves the content. - Material Design 3 token skin (with fallbacks) over the shared
toc-list/
is-current vocabulary; smooth in-page scrolling is owned by the theme. - Rail and disclosure placements. The disclosure is a native
<details>;
placement and sticky behavior are controlled by the host theme or template.
Open-by-default and summary mode are per-block, and its summary can track the
current section. Ships a „Table of contents (above content)” pattern.