Gitiles
Code Review Sign In
gerrit.wikimedia.org / mediawiki / extensions / StickyTOC

MediaWiki extension StickyTOC

Clone this repo:

Branches

  1. 0811c33 build: Updating dependencies by libraryupgrader · 3 days ago master
  2. 8b65d0d Localisation updates from https://translatewiki.net. by Translation updater bot · 3 months ago REL1_42
  3. e4bfde2 Localisation updates from https://translatewiki.net. by Translation updater bot · 5 months ago
  4. 993a73e build: Updating eslint-config-wikimedia to 0.25.0 by libraryupgrader · 12 months ago
  5. 15c0baf Merge "Updates README" by Hashar · 12 months ago

StickyTOC

Makes the TOC float to a page side and act as a sticky panel

Requirements:

Setup

  • Clone the extension into the extensions folder
  • Add wfLoadExtension('StickyTOC'); to the bottom of LocalSettings.php

Configuration

  • $wgStickyTOCFloat - allows controlling to which side the TOC will float. By default it's set to left, but it can be changed to right or aside:
    • left - TOC floats to the left
    • 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 truem 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.

Created for the National Gallery of Art HEALD wiki.