Extension:TocTree

MediaWiki extensions manual

File:OOjs UI icon advanced-invert.svg TocTree Release status: stable
Implementation	User interface
Description	Allows for expansion and collapsing of the table of contents
Author(s)	Roland Unger, Matthias Mullie
Latest version	1.12.0
MediaWiki	>= 1.42
License	GNU General Public License 2.0 or later
Download	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate>
Hooks used ApiParseMakeOutputPage BeforePageDisplay GetPreferences
Quarterly downloads
Public wikis using
Translate the TocTree extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

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

Installation

• <translate> [[<tvar name=2>Special:ExtensionDistributor/TocTree</tvar>|Download]] and move the extracted <tvar name=name>TocTree</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
  <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TocTree
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'TocTree' );
  

• File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Customization

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

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

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.