Extension:BreadCrumbs

MediaWiki extensions manualManual:Extensions

BreadCrumbs Release status:Extension status stable
ImplementationTemplate:Extension#type	User interface
DescriptionTemplate:Extension#description	Shows the users path through the wiki.
Author(s)Template:Extension#username	Tony Boyles, Manuel Schneider
Latest versionTemplate:Extension#version	0.6.1 (2018-08-10)
MediaWikiTemplate:Extension#mediawiki	1.29+
Database changesTemplate:Extension#needs-updatephp	No
LicenseTemplate:Extension#license	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history code review README CHANGELOG
ParametersTemplate:Extension#parameters $wgBreadCrumbsShowAnons $wgBreadCrumbsAllowUPOs
Hooks usedTemplate:Extension#hook ArticleViewHeaderManual:Hooks/ArticleViewHeader OutputPageParserOutputManual:Hooks/OutputPageParserOutput
Translate the BreadCrumbs extension if it is available at translatewiki.net
Check usage and version matrix.
IssuesPhabricator	Open tasks · Report a bug

The BreadCrumbs extension shows the users paths through the wiki.

This extension creates breadcrumbs in the traditional "How did I get here?" sense; use Extension:BreadCrumbs2 for breadcrumbs in the recently popular category-based "Where am I?" sense.

Installation

• Download and place the file(s) in a directory called BreadCrumbs in your extensions/ folder.

• Add the following code at the bottom of your LocalSettings.php:

  wfLoadExtension( 'BreadCrumbs' );
  

• Configure as described below this section.
• Y Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.28 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.28 and earlier), instead of wfLoadExtension( 'BreadCrumbs' );, you need to use:

require_once "$IP/extensions/BreadCrumbs/BreadCrumbs.php";

Configuration

Parameters

By default the following options are set by this extension:

$wgDefaultUserOptions['breadcrumbs-showcrumbs'] = true; # Set of the breadcrumbs should be shown or not
$wgBreadCrumbsAllowUPOs = true; # Allow users to edit their BreadCrumbs preferences
$wgBreadCrumbsShowAnons = true; # Show breadcrumbs to anonymous users
$wgDefaultUserOptions['breadcrumbs-preceding-text'] = ''; # Text to appear before breadcrumbs
$wgDefaultUserOptions['breadcrumbs-delimiter'] = '>'; # Set the delimiter between breadcrumbs
$wgDefaultUserOptions['breadcrumbs-numberofcrumbs'] = 5; # Set the number of breadcrumbs to be shown
$wgDefaultUserOptions['breadcrumbs-namespaces'] = true; # Show namespaces in breadcrumbs
$wgDefaultUserOptions['breadcrumbs-filter-duplicates'] = false; # Exclude a page from the breadcrumbs if it's already in the list once.
$wgDefaultUserOptions['breadcrumbs-ignore-refreshes'] = true; # Do not add a page to the breadcrumbs twice in a row

You may change each one of these parameters by including it with your specified value into your "LocalSettings.php" file below the initialisation of this extension.

Styling

You can also configure the styling of the breadcrumbs by editing MediaWiki:Common.css. For example, if you wanted to shrink the size of the breadcrumbs text from the default 0.8em to 0.5em, you should add this to MediaWiki:Common.css page:

div#breadcrumbs {
  font-size:0.5em;
}

To hide the breadcrumbs from the page's print version add to the MediaWiki:Print.css page:

div#breadcrumbs {
display: none;
}

As the Common.css page warns, you should perform a browser cache-clearing refresh in order to see the changes!

See also

• Extension:BreadCrumbs2
• Extension:JSBreadCrumbs