Khok-tián:TocTree

This page is a translated version of the page Extension:TocTree and the translation is 35% complete.
MediaWiki extensions manual
TocTree
Release status: stable
Implementation User interface
Description Ū-tsūn khok-tián hām tsih-áu bo̍k-lo̍k
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 13 (Ranked 130th)
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.

An-tsong

  • 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.

Kè-hōo-huà

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;

Hông-tsí TOC phiau-phû

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>

Í-king tsai-iánn ê būn-tê

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.