Download the PHP package ideea/toc without Composer
On this page you can find all versions of the php package ideea/toc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package toc
Short Description Simple Table-of-Contents Generator for PHP. Generates TOCs based off H1...H6 tags
License MIT
Homepage http://github.com/caseyamcl/toc
Informations about the package toc
PHP TOC Generator
Generates a Table of Contents from H1...H6 Tags in HTML Content
This package provides a simple, framework-agnostic library to build a Table-of-Contents from HTML markup. It does so by evalutating your H1...H6 tags. It can also automatically add appropriate id anchor attributes to header tags so that in-page links work.
Features:
- Generates HTML menus and KnpMenu Item Menus
- Adds anchor ID attributes to H1...H6 tags in your content where they do not already exist
- You can specify which H1...H6 heading tag levels to include in the TOC
- Includes a Twig Extension for generating TOCs and compatible markup directly from templates
- Uses the flexible KnpMenu Library to generate menus
- PSR-0 thru PSR-2 Compliant
- Composer-compatible
- Unit-tested
In the spirit of KISS philosophy, this library makes a few assumptions:
- The hierarchy of your content is defined solely by the header (H1...H6) tags. All other tags are ignored when generating the TOC.
- The link titles in the Table of Contents match either the
title
attribute of the header tag, or if there is notitle
, the plaintext body of the header tag.
Installation Options
Install via Composer by including the following in your composer.json
file:
{
"require": {
"caseyamcl/toc": "~1.0",
}
}
Or, drop the src
folder into your application and use a PSR-4 autoloader to include the files.
Usage
This package contains two basic classes:
TOC\MarkupFixer
: Addsid
anchor attributes to any H1...H6 tags that do not already have any (you can specify which header tag levels to use at runtime)TOC\TocGenerator
: Generates a Table of Contents from HTML markup
Basic Example:
Twig Integration
This library includes a Twig extension that enables you to load TOC lists and add anchors to markup from your Twig templates.
In order to enable Twig integration, you must register the TocTwigExtension
with your Twig environment:
Specifically, the extension adds a Twig function for generating Table of Contents HTML:
It also provides a function and a filter for ensuring that your content includes anchors for all HTML header tags. They both do the same thing, so choose which one suits your needs best:
Your HTML content may be hard-coded in your Twig Template. An easy way to accomodate this is to make sure the content is surrounded by {% block %}...{% endblock %}
tags, and then just pass in that block to the toc function.
For example:
Specifying Heading Levels to Include
You can choose to include only specific h1...h6 heading levels in your TOC. To do this, pass two additional arguments to the TocGenerator::getHtmlMenu()
method: $topLevel
and $depth
. For example:
Most other methods in the package handle these arguments as well:
Twig functions and filters accept these arguments as well:
Customizing Menu Output
You can customize the rendering of lists that the TocGenerator
class outputs. By default, TocGenerator
uses the KnpMenu ListRenderer class to output the HTML.
You can pass your own instance of the ListRenderer
class to TocGenerator::getHtmlMenu()
. Or, you can pass in your own renderer (implements Knp\Menu\Renderer\RendererInterface
).
For example, you may wish to use different CSS classes for your list items:
Customizing with Twig
The KnpMenu library offers more robust integration with the Twig Templating System than is offered by default with this library. You can take advantage of it by using the TwigRenderer that is bundled with KnpMenu:
All versions of toc with dependencies
masterminds/html5 Version ^2.1
cocur/slugify Version ^1.0|2.0|^3.0
knplabs/knp-menu Version ^2.0