Extension:DynamicSidebar
 Release status: stableCategory:Stable extensions |
|
|---|---|
 |
|
| Implementation | SkinCategory:Skin extensions, MyWikiCategory:Personalization extensions |
| 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 backward compatible.Category:Extensions with release branches compatibility policy |
| MediaWiki | 1.29+Category:Extensions with manual MediaWiki version |
| License | GNU General Public License 2.0 or later |
| Download | Category:Extensions in Wikimedia version control |
|
|
| Quarterly downloads | 25 (Ranked 87th) |
| Translate the DynamicSidebar extension if it is available at translatewiki.net | |
| 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 move the extracted
DynamicSidebarfolder to yourextensions/directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/DynamicSidebar - Add the following code at the bottom of your LocalSettings.php file:
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 user-category based sidebars under MediaWiki:Sidebar/Category:<category>. (It will only show the sidebar if the category is set on the user page.)
// Default: true
$wgDynamicSidebarUseCategories = true;
// Allow category based sidebars under MediaWiki:Sidebar/Category:<category> (will only show the sidebar if the category is set on the page).
// Default: false
$wgDynamicSidebarUsePageCategories = 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 to allow Users to add sidebars to pages based on the category set in their own user page.
$wgDynamicSidebarUsePageCategories must be enabled to allow Users to add sidebars to pages based on the category set in the page.
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 or the page itself.
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 or directly by adding a category in the page.
Possible issues
If the Dynamic sidebar doesn't appear or the menu is not collapsible then you need install the CollapsibleVector (link below):
See also
 | This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |