Extension:HideSection

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
English • ‎Türkçe • ‎日本語
MediaWiki extensions manual
OOjs UI icon advanced.svg
HideSection
Release status: beta
Implementation User interface, Skin
Description A MediaWiki extension that adds links on each header to hide/show the section.
Author(s) Brent Laabs (BrentLaabstalk)
MediaWiki 1.25+
PHP 5.5+
Database changes No
License MIT License
Download
Example allthetropes.org
Parameters
$wgHideSectionImages, $wgHideSectionHideText, $wgHideSectionTitleLink
Hooks used
ParserSectionCreate
SkinEditSectionLinks
SkinTemplateOutputPageBeforeExec
BeforePageDisplay
Translate the HideSection extension if it is available at translatewiki.net
Check usage and version matrix.

HideSection is a MediaWiki extension that adds links on each header to collapse and expand the section. This allows users to easily wade through long wiki pages and jump to the section they want to read.

This extension hides sections hierarchically. That means if you hide a top level header, any headers below it are automatically hidden. Typically, the header will display a "show" or "hide" link next to the edit link, though this can be configured to display an image instead. Additionally, there is a "show all"/"hide all" button, either on the first header or next to the page title.

For reporting an issue or a bug, please use Miraheze Phabricator.

Installation

  • Download and place the file(s) in a directory called HideSection in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'HideSection' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

$wgHideSectionImages
Use these images as hide/show links. Default is null. If this array is set, images will be added according the the place marked in location. Location "begin" is before the first text of the header, while "end" places it at the very end of the header.
$wgHideSectionImages = [
	"show" => "https://upload.wikimedia.org/wikipedia/commons/b/bc/Vector_right_arrow_link.png",
	"hide" => "https://upload.wikimedia.org/wikipedia/commons/2/27/Vector_down_arrow_link.png",
	"location" => "begin" # or "end"
];
$wgHideSectionHideText
If set to a true value, text show/hide links are disabled. Useful when only images are wanted.
$wgHideSectionTitleLink
If set to a true value, adds a show all/hide all button to the right of the page title.

Known Issues

  • Strange interaction with disabled VisualEditor: task T146564
  • Prevents hiding of sections with Skin:Minerva, which is actually a default feature of that skin.

See Also