Extension:TocTree: Difference between revisions

**MediaWiki extensions manual**
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.47.0
	Hooks used ApiParseMakeOutputPage; BeforePageDisplay; GetPreferences;
Licence	GNU General Public License 2.0 or later
Download	Download extension ; Git [?]: Browse repository (GitHub); Gerrit code review; Git commit log; Download source tarball;
	Translate the TocTree extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

Browse history interactively

← Older edit

Content deleted Content added

VisualWikitext

Inline

Latest revision as of 17:36, 10 May 2025

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

Installation

Download and move the extracted TocTree folder to your extensions/ 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:

@@ Line 1: / Line 1: @@
+<languages/>
-This extension was written to modify the table of contents (toc). The main entries will get toggles to expand or collapse the toc trees.
+{{Extension
+|name          = TocTree
+|status        = stable
+|type1         = interface
+|type2         =
+|username      =
+|author        =
+|description   = <translate><!--T:1--> Allows for expansion and collapsing of the table of contents</translate>
+|changelog     =
+|parameters    =
+|tags          =
+|rights        =
+|example       =
+|compatibility =
+|download      = {{WikimediaDownload}}
+|phabricator     = MediaWiki-extensions-TocTree
+}}
+<translate>
+<!--T:6-->
+The <tvar name=1>'''TocTree'''</tvar> extension allows for initial expansion and collapsing of the table of contents.
+==Installation== <!--T:2-->
-This extension is under construction. Changes are possible.
+</translate>
+{{ExtensionInstall
+|TocTree
+|registration=required
+}}
+<translate>
-== Installing TocTree ==
+== Customization == <!--T:3-->
-Copy TocTree.php, TocTree.i18n.php, TocTree.js and TocTreeCollapsed.css into the TocTree folder in the extensions folder of your MediaWiki installation. Then add the following line to your LocalSettings.php file (near the end):
-<source lang="php">
- require_once( "$IP/extensions/TocTree/TocTree.php" );
-</source>
-Please copy the following style sheets to the [[MediaWiki:Common.css]]:
-* Will be filled ...
-== Individualization ==
+<!--T:7-->
 The PHP script will add two new options to the user preferences. They were added to the Misc section:
+</translate>
-* Expand table of contents
-* Floated table of contents
+* <translate><!--T:8--> Floated table of contents</translate>
-Defaults are collapsed but not floated tocs.
+* <translate><!--T:9--> Expand table of contents</translate>
+<translate><!--T:10--> Defaults are collapsed but not floated tocs.</translate>
-== Used messages ==
+You can overwrite the default values by setting true in your LocalSettings.php file:
+<syntaxhighlight lang="php">
-Message strings ― noted in TocTree.i18n.php ― are available now for three languages (de, en, and pl).
+$wgDefaultUserOptions['toc-floated'] = false;
+$wgDefaultUserOptions['toc-expand'] = false;
+</syntaxhighlight>
+<translate>
-<source lang="php">
+== Prevention of TOC floating == <!--T:4-->
-<?php
+</translate>
- /**
+The author has the opportunity to prevent floating of the TOC set by the user(s) by using a <code>div</code> tag with the style class <code>noFloat</code> enclosing the TOC.
- * Internationalisation file for TocTree extension.
- *
- * @package MediaWiki
- * @subpackage Extensions
-*/
+<pre>
-$TocTreeMessages = array();
+<div class="noFloat">__TOC__</div>
+</pre>
+<translate>
-$TocTreeMessages['en'] = array(
+== Known problems == <!--T:5-->
-	'tog-toc-expand'   => 'Expand table of contents',
-	'tog-toc-floated'  => 'Floated table of contents',
-);
+<!--T:11-->
-$TocTreeMessages['de'] = array(
+There are the well-known problems of floated boxes like:
-	'tog-toc-expand'   => 'Vollständiges Inhaltsverzeichnis',
+</translate>
-	'tog-toc-floated'  => 'Umflossenes Inhaltsverzeichnis',
-);
+* <translate><!--T:12--> Missing list bullets</translate>
-$TocTreeMessages['pl'] = array(
+* <translate><!--T:13--> Design problems of narrow TOCs and positioning problems with text and wide right-floated boxes.</translate>
-	'tog-toc-expand'   => 'Rozwijanie spisu treści',
-	'tog-toc-floated'  => 'Opływanie spisu treści',
-);
+<translate>
-?>
+<!--T:14-->
-</source>
+Additional:
+</translate>
+* <translate><!--T:15--> Bidi support (right-to-left writing direction) implemented but not yet tested (for instance needed for Hebrew and Arabic).</translate>
-== Known Problems ==
+* <translate><!--T:16--> Support of only the MonoBook and Vector skins.</translate>
+{{OnWikimedia}}
-There the the well-known promlems of floated boxes like:
+{{Used by}}
+[[Category:TOC extensions{{#translation:}}]]
-* Missing list bullets, see for instance [http://css-discuss.incutio.com/?page=MissingBulletPoints Missing Bullet Points]
-* Design problems of narrow tocs and positoning problems with text and wide right-floated boxes.

Pppery (talk | contribs)

Latest revision as of 17:36, 10 May 2025

Installation

Customization

Prevention of TOC floating

Known problems