MediaWiki extensions manual

GeoCrumbs Release status: stableCategory:Stable extensions
Implementation	API Category:API extensions
Description	Adds a trail of bread crumbs to the page
Author(s)	Roland Unger, Hans Musil, and Matthias Mullie
Latest version	2.0.1
MediaWiki	>= 1.44
PHP	5.4+
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (Phabricator · GitHub) Gerrit code review Git commit log Download source tarball Category:Extensions in Wikimedia version control README
Parameters $wgGeoCrumbsUseParserOutputFallback
Hooks used OutputPageParserOutput Category:OutputPageParserOutput extensions ParserFirstCallInit Category:ParserFirstCallInit extensions
Quarterly downloads	1 (Ranked 95th)
Translate the GeoCrumbs extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The GeoCrumbs extension, formerly known as BreadCrumbs adds a trail of bread crumbs to the page. See https://en.wikivoyage.org/wiki/Wikivoyage:Breadcrumb_navigation or other Wikivoyage sites for more information.

Installation

• Download and move the extracted GeoCrumbs folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/GeoCrumbs
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'GeoCrumbs' );
  

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

Usage

This extension provides a new MediaWiki parser function named "isin". It expects one argument, the name of the article where the current article "is in".

During parsing of the wiki markup, some few data related to the isin function's argument are generated and stored in the parser cache.

When the article is displayed, its HTML code has to be built from the parser cache. The BreadCrumbs extension has a method triggered by the 'OutputPageParserOutput' hook. Here, the complete bread crumb trail is build up by starting with the article's own isin and retrieving subsequently higher level isin data from the corresponding parser caches. The HTML code of the bread crumb trail is added to the page's subtitle.

Example:

{{#isin:Europe}}
The country of Spain is part of Europe.

This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.

This extension is included in the following wiki farms/hosts and/or packages: Miraheze Category:Extensions included in Miraheze WikiForgeCategory:Extensions included in WikiForge 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.