Extension: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.43 |
| License | GNU General Public License 2.0 or later |
| Download | |
| Quarterly downloads | 13 (Ranked 126th) |
| 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
- Download and move the extracted
TocTreefolder to yourextensions/directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TocTree - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'TocTree' );
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
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.
| 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. |
| This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |