Extension:StickyTOC

File:Wikiteq - logo.png

<translate> This extension is professionally maintained by the WikiTeq team.</translate>

<translate> WikiTeq provides official support for [[<tvar name=1>Special:MyLanguage/Version lifecycle</tvar>|MediaWiki LTS releases only]].</translate> <translate> It may work with other MediaWiki releases.</translate>

MediaWiki extensions manual

File:OOjs UI icon advanced-invert.svg 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	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate> README
Parameters $wgStickyTOCFloat $wgStickyTOCNavbar $wgStickyTOCReplaceTitle
Hooks used BeforePageDisplay ResourceLoaderGetConfigVars
Quarterly downloads
Public wikis using
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

• MediaWiki 1.35+
• Chameleon skin 2+

Installation

• <translate> [[<tvar name=2>Special:ExtensionDistributor/StickyTOC</tvar>|Download]] and move the extracted <tvar name=name>StickyTOC</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/StickyTOC
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'StickyTOC' );
  

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

Configuration parameters

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