mediawiki / semantic-breadcrumb-links
An extension to Semantic MediaWiki allowing to build breadcrumb links from an attributive property filter
Fund package maintenance!
Open Collective
www.semantic-mediawiki.org/wiki/Sponsorship
Installs: 21 447
Dependents: 0
Suggesters: 0
Security: 0
Stars: 15
Watchers: 9
Forks: 7
Open Issues: 12
Type:mediawiki-extension
Requires
- php: >=5.6
- composer/installers: 1.*,>=1.0.12
- mediawiki/semantic-media-wiki: ~2.5|~3.0
- onoi/shared-resources: ~0.2
Requires (Dev)
README
Semantic Breadcrumb Links (a.k.a. SBL) is a Semantic Mediawiki extension to aid in-page navigation by building breadcrumb links from an attributive property filter.
SBL uses a pattern match strategy to filter property usage (e.g. Has parent page)
that ascribe the location of a page relative to its parent and provides navigational help by
generating a breadcrumb trail.
This video demonstrates the functionality of the Semantic Breadcrumb Links extension.
Requirements
- PHP 5.6 or later
- MediaWiki 1.27 or later
- Semantic MediaWiki 2.5 or later
Installation
The recommended way to install Semantic Breadcrumb Links is using Composer with MediaWiki's built-in support for Composer.
Note that the required extension Semantic MediaWiki must be installed first according to the installation instructions provided.
Step 1
Change to the base directory of your MediaWiki installation. If you do not have a "composer.local.json" file yet, create one and add the following content to it:
{
"require": {
"mediawiki/semantic-breadcrumb-links": "~2.0"
}
}
If you already have a "composer.local.json" file add the following line to the end of the "require" section in your file:
"mediawiki/semantic-breadcrumb-links": "~2.0"
Remember to add a comma to the end of the preceding line in this section.
Step 2
Run the following command in your shell:
php composer.phar update --no-dev
Note if you have Git installed on your system add the --prefer-source flag to the above command.
Step 3
Add the following line to the end of your "LocalSettings.php" file:
wfLoadExtension( 'SemanticBreadcrumbLinks' );
Usage
This document decribes available settings and features of this extension.
Contribution and support
If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guideline.
- File an issue
- Submit a pull request
- Ask a question on the mailing list
Tests
This extension provides unit and integration tests that are run by a continues integration platform
but can also be executed using composer phpunit from the extension base directory.