Giter Club home page Giter Club logo

contao-content-navigation's Introduction

Contao Content Navigation Element

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.

contao-content-navigation's People

Contributors

dmolineus avatar cliffparnitzky avatar tristanlins avatar leo-unglaub avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.