Extension:TocTree
 Release status: beta |
|
|---|---|
| Implementation | API |
| Author(s) | Roland Unger, Matthias Mullie |
| Latest version | 1.12.0 |
| MediaWiki | 1.20 |
| Database changes | No |
| Licence | GPLv2 |
| Download | |
| Translate the TocTree extension if it is available at translatewiki.net | |
| Issues | Open tasks · Report a bug |
Installation
To install this extension, add the following to LocalSettings.php:
require_once( "$IP/extensions/TocTree/TocTree.php" );
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, see for instance Missing Bullet Points
- Design problems of narrow tocs and positoning 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).
- Tested only with Monobook skin.
Feedback
Open tickets in Wikimedia's Bugzilla under the "TocTree" component in the "MediaWiki extensions" product.
 | This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |