Extension:DynamicSidebar

MediaWiki extensions manual

DynamicSidebar Release status: stable
Implementation	Skin , MyWiki
Description	Provides dynamic sidebars based on user pages, groups, and categories.
Author(s)	Ryan Lane (Ryan lanetalk)
Latest version	1.1 (2020-05-12)
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backwards compatible.
MediaWiki	1.29+
MediaWiki 1.36	Not formally tested
MediaWiki 1.34	Not formally tested
MediaWiki 1.32	Not formally tested
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parameters $wgDynamicSidebarUseUserpages $wgDynamicSidebarUseCategories $wgDynamicSidebarUsePageCategories $wgDynamicSidebarUseGroups
Hooks used SidebarBeforeOutput
Hooks provided DynamicSidebarGetGroups
Translate the DynamicSidebar extension if it is available at translatewiki.net
Check usage and version matrix.
Issues	Open tasks · Report a bug

The DynamicSidebar extends the capabilities of the sidebar for logged in users. If allowed, users can add their own custom sidebars via the page "User:<username>/Sidebar". Administrators can add sidebars for groups, and userpage categories via the pages "MediaWiki:Sidebar/Group:<group>", and "MediaWiki:Sidebar/Category:<category>".

Installation

• Download and place the file(s) in a directory called DynamicSidebar in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php:

  wfLoadExtension( 'DynamicSidebar' );
  

• Configure as required.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

The following options are available:

// Enable debugging
$wgDebugLogGroups['dynamic-sidebar'] = '/tmp/sidebar-debug.txt';

// Allow users to create their own custom sidebars under User:<username>/Sidebar
// Default: true
$wgDynamicSidebarUseUserpages = true;

// Allow group sidebars under MediaWiki:Sidebar/Group:<group>
// Default: true
$wgDynamicSidebarUseGroups = true;

// Allow category based sidebars under MediaWiki:Sidebar/Category:<category>
// Default: true
$wgDynamicSidebarUseCategories = true;

Usage

Custom user sidebars

$wgDynamicSidebarUseUserpages must be enabled, then an administrator must add the following on the page "MediaWiki:Sidebar":

* USER-SIDEBAR

This string will be replaced with the user's sidebar.

Users should define their sidebar on the page "User:<username>/Sidebar".

Group sidebars

$wgDynamicSidebarUseGroups must be enabled, then an administrator must add the following on the page "MediaWiki:Sidebar":

* GROUP-SIDEBAR

This string will be replaced with the user's group sidebars.

Administrators must add a sidebar for each group on the page "MediaWiki:Sidebar/Group:<group>". If a user is in multiple groups, sidebars will be shown for each group. The group name listed here should be as expressed in LocalSettings.php, so "MediaWiki:Sidebar/Group:sysop", not "MediaWiki:Sidebar/Group:Administrator" or "MediaWiki:Sidebar/Group:Administrators".

Category sidebars

$wgDynamicSidebarUseCategories must be enabled, then an administrator must add the following on the page "MediaWiki:Sidebar":

* CATEGORY-SIDEBAR

This string will be replaced with the sidebars of the categories on the user's userpage.

Administrators must add a sidebar for each category at "MediaWiki:Sidebar/Category:<category>". If a user's userpage has multiple categories, sidebars will be shown for each category. Users can add sidebars by adding a category to their userpage.

Possible issues

If the Dynamic sidebar don't appear or the menu is not collapsible then you need install the CollapsibleVector (link below):

• Extension:CollapsibleVector