Extension:Simple Breadcrumb

From mediawiki.org
MediaWiki extensions manual
Simple Breadcrumb
Release status: stable
Implementation Parser function , Hook
Description Implements a simple hierarchical breadcrumb
Author(s) Nicolas Bernier, Jeffrey C. Parry
Latest version 2.0 (2023-09-11)
MediaWiki 1.39+
PHP 5.2.4
Database changes Yes
License LGPL v3.0
Download
README

The extension implements a {{#breadcrumb: }} tag to set a parent page for each page. The resulting breadcrumb is displayed under the page title.

Usage[edit]

Just add a {{#breadcrumb: }} tag anywhere in your page to set its parent.

{{#breadcrumb: Parent_Page | Parent }}

The tag can be used in templates and accepts variables.

{{#breadcrumb: Category:Releases {{{product}}} | {{{product}}} }}

You should not add more than one breadcrumb tag in your page.

Installation[edit]

  • Download and place the file(s) in a directory called Simple Breadcrumb in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'Simple Breadcrumb' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

The extension offers a bunch of configuration variables that can be overridden in LocalSettings.php after the inclusion of the extension.

$wgbcdelimiter            = ' > ';     // Breadcrumb delimiter string
$wgbcMaxCount             = 5;            // Maximum elements in breadcrumb
$wgbcOverflowPrefix       = '…';   // Prefix when breadcrumb has more elements than fixed limit