Extension:YAMBE

From MediaWiki.org

Jump to: navigation, search

             

Manual on MediaWiki Extensions
List of MediaWiki Extensions
Crystal Clear action run.png
YAMBE (Yet Another MediaWiki Breadcrumb Extension)

Release status: beta

Implementation  Tag, Hook
Description Hierarchical Breadcrumb for Mediawiki. Builds a structured path for each page.
Author(s)  Ian Coleman (QuantumTigerTalk)
Last Version  0.1.4 (12 Jun 2009)
MediaWiki  1.13.1, 1.14.0 and 1.15.0
License GPL
Download YAMBE Code
About YAMBE
YAMBE Changelog
Example  shadowfax.org.uk

check usage (experimental)

Contents

[edit] What can this extension do?

Creates a hierarchical breadcrumb (navigation path) for a MediaWiki page based on the page that it was created from. Allows users to track back through the wiki more easily and provides a context for the current page.

Whenever a new page is created beneath a page which already uses YAMBE a piece of markup is inserted at the start of the page to set up YAMBE and identify the page's parent. When the page is displayed this is used to build links to the parent page looping through each parent until it gets to the top of the tree.

[edit] Usage

Tags are auto-generated when creating a new page, but may be editted to change the details in the breadcrumb if required.

<yambe:breadcrumb self="Self Text">Parent Page|Parent Text</yambe:breadcrumb>
  • Self Text is the text to display at the end of the breadcrumb for the current page. Defaults to page name if blank
  • Parent Page is the name of the parent page
  • Parent Text is the text to display in the breadcrumb for the parent

[edit] Download instructions

See Getting hold of YAMBE

[edit] Installation

See Getting hold of YAMBE

[edit] Example

Yambe is being used in a number of intranet and private wikis. You can see it in action on shadowfax.org.uk

[edit] Configuration parameters

//Some global config declarations
// where to split the URL to find page name. Usually either /index.php/ or /wiki/
$URLSplit = "/index.php/"; 
$bcDelim = " > "; // Character to mark the stages of the breadcrumb?
$maxCountBack = 5; // Maximum number of links in breadcrumb 
$overflowPre = "[...]"; // Prefix if breadcrumb is longer than $maxCountBack links

The above variables can be changed to customise how YAMBE creates the breadcrumb and the maximum depth it supports.

[edit] See also