Extension:GeoCrumbs

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
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.0 (2016-07-20)
MediaWiki 1.25+
PHP 5.4+
Database changes No
License GNU General Public License 2.0
Download
README
Hooks used
ParserFirstCallInit
ParserBeforeTidy
OutputPageParserOutput
Translate the GeoCrumbs extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

The GeoCrumbs extension formerly known as BreadCrumbs adds a trail of bread crumbs to the page.

Installation[edit]

Note Note: The CustomData extension was required to be installed for this extension to work for versions before 1.2.0.


  • Download and place the file(s) in a directory called GeoCrumbs in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'GeoCrumbs' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.27 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.27 and earlier), instead of wfLoadExtension( 'GeoCrumbs' );, you need to use:

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

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.