Extension:TocTree

From mediawiki.org
MediaWiki extensions manual
OOjs UI icon advanced-invert.svg
TocTree
Release status: stable
Implementation User interface
Description Allows for expansion and collapsing of the table of contents
Latest version 1.12.0
MediaWiki >= 1.35.0
License GNU General Public License 2.0 or later
Download
Translate the TocTree extension if it is available at translatewiki.net

Check usage and version matrix.

Issues Open tasks · Report a bug

The TocTree extension allows for initial expansion and collapsing of the table of contents.

Installation[edit]

  • Download and place the file(s) in a directory called TocTree in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php :
    wfLoadExtension( 'TocTree' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Customization[edit]

The PHP script will add two new options to the user preferences. They were added to the Misc section:

  • Floated table of contents
  • Expand table of contents

Defaults are collapsed but not floated tocs. You can overwrite the default values by setting true in your LocalSettings.php file:

$wgDefaultUserOptions['toc-floated'] = false;
$wgDefaultUserOptions['toc-expand'] = false;

Prevention of TOC floating[edit]

The author has the opportunity to prevent floating of the TOC set by the user(s) by using a div tag with the style class noFloat enclosing the TOC.

<div class="noFloat">__TOC__</div>

Known problems[edit]

There are the well-known problems of floated boxes like:

  • Missing list bullets
  • Design problems of narrow TOCs and positioning problems with text and wide right-floated boxes.

Additional:

  • Bidi support (right-to-left writing direction) implemented but not yet tested (for instance needed for Hebrew and Arabic).
  • Support of only the MonoBook and Vector skins.