Extension:StickyTOC

This extension is professionally maintained by the WikiTeq team.
WikiTeq provides official support for MediaWiki LTS releases only. It may work with other MediaWiki releases.
MediaWiki extensions manual
StickyTOC
Release status: stable
px
Implementation Skin
Description Makes TOC sticky.
Author(s) WikiTeq team
Maintainer(s) WikiTeq team
Latest version 1.0.0 (2023-03-24)
Compatibility policy For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension.
MediaWiki 1.35+
Database changes No
License GNU Library General Public License v2 only
Download
README
  • $wgStickyTOCFloat
  • $wgStickyTOCNavbar
  • $wgStickyTOCReplaceTitle
Quarterly downloads 4 (Ranked 128th)
Translate the StickyTOC extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The StickyTOC makes the Table of Contents float to a page side and act as a sticky panel.

Created for the National Gallery of Art HEALD wiki.

Requirements edit

Installation edit

  • Download and move the extracted StickyTOC 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/StickyTOC
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'StickyTOC' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters edit

$wgStickyTOCFloat
Allows controlling to which side the TOC will float by passing one of the following values:
  • left - TOC floats to the left (default)
  • right - TOC floats to the right
  • aside - TOC jumps to the left and acts as a column, shifting the page contents to the right
$wgStickyTOCNavbar
If set to true will force the TOC to treat the current layout navbar as being sticky. By default this is set to false. There is no need to change this for the default Chameleon stickyhead.xml layout, only for custom ones.
$wgStickyTOCReplaceTitle
If set to true will replace TOC title with article title. By default this is set to false.