hofff/contao-content-navigation

Provides a table of contents for elements based on one or more articles within the page.

2.0.4 2024-03-20 14:16 UTC

Requires

• php: ^8.1
• ausi/slug-generator: ^1.1
• contao/core-bundle: ^4.13 || ^5.3
• doctrine/dbal: ^3.8
• symfony/config: ^5.4 || ^6.4
• symfony/dependency-injection: ^5.4 || ^6.4
• symfony/http-foundation: ^5.4 || ^6.4
• symfony/http-kernel: ^5.4 || ^6.4
• symfony/routing: ^5.4 || ^6.4
• symfony/string: ^5.4 || ^6.4
• symfony/translation-contracts: ^1.1 || ^2.0 || ^3.0

Requires (Dev)

• contao/manager-plugin: ^2.1
• doctrine/coding-standard: ^12.0
• phpcq/runner-bootstrap: ^1.0@dev

Conflicts

• contao/manager-plugin: <2.1 || >=3.0

LGPL-3.0-or-later

• Nicky Hoff
• David Molineus

• contao
• TOC
• contents
• nabigation

README

This extension provides a table of contents for elements based on one or more articles within the page.

This extension was previously published as ce_navigation and maintained by Tristan Lins.

Although the extension is based on ce-navigation, it is not backwards compatible. Configurations must be renewed.

Requirements

• Contao: ^4.9
• PHP: ^7.1 || ^8.0

Usage

• Create a content element "Table of contents" and define the source
• Active option "Include in table of contents" for each content element

Now you get an content navigation for each element marked as included and having a headline.

You can define the source for the table of content structure depending where the content element is included:

• Article: Column, Specific article or parent element (current article)
• News: Parent element (news)
• Event: Parent element (event)
• FAQ: Parent element (FAQ entry)

Customization

If your 3rd party module also works like the news or events module (category defining a jumpTo page and an entry holding content elements), you can enable support for your own module by adding it to the hofff_contao_content_navigation.jump_to_relations parameter.

Known limitations

Only content elements of the direct source are recognized. Including articles or modules are not supported right now. That means, you cannot define a table of contents element in an article and building a content navigation for a news entry included by a news reader module.