Extension:BibManager

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
BibManager

Release status: stable

Extension BibManager Logo.svg
Implementation Tag, Special page, Database
Description Enables MediaWiki to store and manage bibliographic data and to use it within an article.
Author(s) Robert Vogel (Talk),Tobias Weichart (Talk)
Latest version 1.22
MediaWiki 1.22+
Database changes Yes
License GPL
Download
Tags
<bib />, <biblist />, <bibprint />
Added rights

bibmanageredit, bibmanagerdelete, bibmanagercreate

Hooks used
ParserFirstCallInit

BeforePageDisplay
LoadExtensionSchemaUpdates

Translate the BibManager extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

The BibManager extension enables MediaWiki to store BibTeX data and to use these entries within an article. It offers forms to create edit and otherwise manage bibliograpic data and allows import and export of BibTeX format. It has been developed in 2011 for the SaltWiki-Project of the Hornemann Institute by Hallo Welt! Medienwerkstatt GmbH.

Download[edit | edit source]

You can download the extension directly from the MediaWiki source code repository (browse code). You can get:

One of the extensions tags

Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag

  • Go to the tags list
  • Click the name of the tag you want to download
  • Click "snapshot"
The latest version of one of the extensions branches

Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.

  • Go to the branches list
  • Click the branch name
  • Click "snapshot"
A snapshot made during the release of a MediaWiki version.

This might be unstable and is not guaranteed to work with the associated MediaWiki version.

After you've got the code, save it into the extensions/BibManager directory of your wiki.

If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:

cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/BibManager.git

Installation[edit | edit source]

  • Download and extract the file(s) in a directory called BibManager in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/BibManager/BibManager.php";
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit | edit source]

$wgBibManagerUseJS
Wether or not to use JS for better user experience. Default is true.
$wgBibManagerRepoClass
This is for future development. Default is 'BibManagerLocalMWDatabaseRepo'. You may implement your own repo by extending the abstract BibManagerRepository class in includes/BibManagerRepository.php.
$wgBibManagerCitationFormats
An associative array that defines the output format of the various entry types. Please take a look ah the BibManager.php for an example.
$wgBibManagerCitationArticleNamespace
The namespace citation links point to. Default is NS_MAIN.
$wgBibManagerScholarLink
The link to which the 'Google Scholar' link points. Default is 'http://scholar.google.com/scholar?q=%title%'.

User rights[edit | edit source]

bibmanageredit
User can access the edit special page. Edit links are shown.
bibmanagerdelete
User can delete entries. Delete links are shown.
bibmanagercreate
User can add or import entries. Creation and import SpecialPages can be accessed.

Tags[edit | edit source]

To use one of the three BibManager-Tags proceed as follows:

<bib id="citation" />
Get a link to the citation you have set up before (e.g. <bib id='testing:2010' /> points to the article Testing:2010)
<biblist />
List all the <bib /> tags embedded in the articles text (list in alphabetical order)
<bibprint />
Render list of citations. You can use the filter attribute to influence the result. I.e. <bibprint filter="year:2011|2010, author:hawkins" /> will show all entries from the repository that are from the year 2011 OR 2010 AND have hawkins as author.

Further documentation[edit | edit source]

Ideas for futher development / TODOs[edit | edit source]

  • Add additional fields like on uni-bremen.de on section Other fields.
  • Implement API for remote access and shared repos
  • Add a article <-> entry relationship table for automatic purging at entry change and sophisticated querys like Other pages using this entry

Licensing[edit | edit source]

© GPL, see subfolder "docs/"

Icons from famfamfam are used within this extension.