Extension:TocTree
From Linux Web Expert
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 | |
Quarterly downloads | Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin'). |
Public wikis using | Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin'). |
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.
File:Wikimedia-logo black.svg | <translate> This {{<tvar name=1>#ifeq:Extension|Extension</tvar>|extension|skin}} is being used on one or more [[<tvar name=2>m:Special:MyLanguage/Wikimedia projects</tvar>|Wikimedia projects]].</translate> <translate> This probably means that the {{<tvar name=1>#ifeq:Extension|Extension</tvar>|extension|skin}} is stable and works well enough to be used by such high-traffic websites.</translate> <translate> Look for this {{<tvar name=1>#ifeq:Extension|Extension</tvar>|extension's|skin's}} name in Wikimedia's <tvar name=2>CommonSettings.php</tvar> and <tvar name=3>InitialiseSettings.php</tvar> configuration files to see where it's installed.</translate> <translate> A full list of the {{<tvar name=1>#ifeq:Extension|Extension</tvar>|extensions|skins}} installed on a particular wiki can be seen on the wiki's <tvar name=ver>Special:Version</tvar> page.</translate> |
File:OOjs UI icon information-progressive.svg |
Categories:
- Pages with script errors
- Pages with broken file links
- Stable extensions
- Extensions without an image
- User interface extensions
- Extensions without a compatibility policy
- GPL licensed extensions
- Extensions in Wikimedia version control
- ApiParseMakeOutputPage extensions
- BeforePageDisplay extensions
- GetPreferences extensions
- All extensions
- Extensions used on Wikimedia
- TOC extensions