Extension:SidebarEx

From MediaWiki.org

Pending changes are displayed on this page

Documentation page unreviewed

Jump to: navigation, search

**MediaWiki extensions manual** - **list**
SidebarEx Release status: stable
Implementation	MyWiki
Description	Provides customizable sidebars.
Author(s)	Jean-Lou Dupont
Last version	1.1.0
MediaWiki	1.82, 1.93, 1.10, 1.11, 1.12
License	No license specified
Download	SVN See SVN ($Id: SidebarEx.doc.wikitext 1185 2008-06-17 20:08:20Z jeanlou.dupont $)
Example	here
Check usage (experimental)

Provides a means of adding page links to the 'sidebar' based on group membership & per-user basis.

[edit] Features

Integration with Extension:PageSidebar
Can be used independantly of BizzWiki environment
all defined groups are supported (standard MW and ones defined in installation)
sidebar page name corresponds to 'group' name
No patches to standard MW installation for MW version >= 1.10
Group name prioritization
Per-User sidebars using 'username/Sidebar' page
Per-Namespace sidebars using 'MediaWiki:Sidebar/Ns/...namespace name here...'

[edit] Usage Note

This extension replaces to the standard sidebar defined at MediaWiki:Sidebar. The new default sidebar is located at MediaWiki:Sidebar/*.

[edit] Parameters

//Define (if desired) the base namespace where the pages will be fetched:
$bwSidebarNs = NS_ADMIN;  // must be defined prior, defaults to 'NS_MEDIAWIKI'
 
//Define (if desired) the base page where the 'sidebar' pages will be fetched:
$bwSidebarPage = 'Sidebars';
 
// Define the priority list i.e. group membership search order.
$bwSidebarSearch = array ('somegroup', 'sysop', 'user', '*' );

[edit] CONFIGURATION NOTES

[edit] Group membership based sidebars

 1) Define (if desired) the base namespace where the pages will be fetched:
    $bwSidebarNs = NS_ADMIN;  // must be defined prior
 
 2) Define (if desired) the base page where the 'sidebar' pages will be fetched:
    $bwSidebarPage = 'Sidebars';
 
 3) Define the priority list i.e. group membership search order.
    $bwSidebarSearch = array ('somegroup', 'sysop', 'user', '*' );
 
    Corresponding sidebar pages:
                MediaWiki:Sidebar/somegroup
                MediaWiki:Sidebar/sysop
                MediaWiki:Sidebar/user
                MediaWiki:Sidebar/*

[edit] Per-User sidebars

Edit the page 'User:username/Sidebar'.

[edit] Per-Namespace sidebars

Examples:

MediaWiki:Sidebar/Ns/Main
MediaWiki:Sidebar/Ns/Category
...

[edit] Installation

See the Mediawiki Extension table entry "download" above.^[1]

[edit] LocalSettings.php

Extension:ExtensionManager: See footnote^[2]

Add the following to LocalSettings.php, if the extension was downloaded from Jean-Lou Dupont's MediaWiki SVN directory (link in the download entry of the table above)^[2]:

require_once( "$IP/extensions/SidebarEx/SidebarEx.php" );

Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.

[edit] PEAR

PEAR is a repository of PHP software code.

Install the channel PEAR channel ' http://mediawiki.googlecode.com/svn '

pear channel-discover mediawiki.googlecode.com/svn

Install extension through PEAR:

pear install mediawiki/SidebarEx

Add the following to LocalSettings.php^[2]^[3]:

require 'MediaWiki/SidebarEx/SidebarEx.php';

Note that the required version of PEAR must be respected. Currently, the minimum version of PEAR usable with this channel is v1.6.2. Perform the following command to upgrade to the latest version of PEAR:

pear upgrade pear

[edit] Upgrades through PEAR

Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.

pear clear-cache

or use the force method:

pear upgrade --force mediawiki/SidebarEx

[edit] PEAR Web Frontend

For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here.

[edit] RSS feed

To keep up-to-date with this channel, use the following RSS feed__.

[edit] Notes

[edit] Other Extensions From the same author

Consult User Jldupont's page.

↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
↑ ^2.0 ^2.1 ^2.2 Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
↑ Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

[edit] History

Release	Notes
1.0.0	Initial Release
1.0.1	Removed integration of default sidebar
1.1.0	Added Integration with Extension:PageSidebar

[edit] See Also

[up-0] The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.

[em-1] 2.0 ^2.1 ^2.2 Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.

[mod-2] Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

[1]

[2]

[3]

Extension:SidebarEx

Contents

[edit] Features

[edit] Usage Note

[edit] Parameters

[edit] CONFIGURATION NOTES

[edit] Group membership based sidebars

[edit] Per-User sidebars

[edit] Per-Namespace sidebars

[edit] Installation

[edit] LocalSettings.php

[edit] PEAR

[edit] Upgrades through PEAR

[edit] PEAR Web Frontend

[edit] RSS feed

[edit] Notes

[edit] Other Extensions From the same author

[edit] History

[edit] See Also

Personal tools

Namespaces

Variants

Views

Actions

Search

Site

Support

Download

Development

Communication

Print/export

Toolbox