Jump to content

Extension:GeoCrumbs

From mediawiki.org
MediaWiki extensions manual
GeoCrumbs
Release status: stable
Implementation API
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.42
PHP 5.4+
Database changes No
License GNU General Public License 2.0 or later
Download
README
Quarterly downloads 5 (Ranked 131st)
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[edit]

  • 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' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage[edit]

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.

Use of the isin keyword adds a breadcrumb trail under the title. Here shows the Vector 2022 skin.

Example:

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