Mediawiki Bibtex Extension

From Simson Garfinkel
Jump to navigation Jump to search

This extension allows including of Bibtex entries in MediaWiki version 1.16, 1.17 and 1.18.

This file is describing the bibtex mediawiki extension. In itself it has several features :

  • Direct parsing of a bibtex entry placed between <bibtex> and </bibtex> markups,
  • ACM-like popup style to quickly copy-paste a bibtex reference,
  • A limited but usefull emacs-like help mecanism to edit bibtex entries,
  • A div popup demo (not IE compliant nor XHTML transitionnal).

The result of this extension can be seen on our Publications page here.

Install/Files

Downloads

The current release can be downloaded from:

Installation

Just unpack the tarball into the extensions directory of your mediawiki root:

tar -xvzf Bibtex.tar.gz

Then add the appropriate line to your LocalSettings.php file:

require_once( "$IP/extensions/Bibtex/bibtex.php");

Several files are included in the release:

bibtex.php
the main extension file,
bibtex.css
containing css hacks for the divpopup demo,
bibtex.js
a javascript file containing a few functions,
bibstyle.php
a file containing all the configuration variables of the extension,
README.txt
a readme with almost the same instructions as here for install and configuration,
ChangeLogs.txt
change logs (starting from 0.9.1 release).

Setup and configuration

Edit your bibstyle.php file. There are several things you can customize in it, starting with the language you want to use (in this package it is french - don't worry, there are rough translations in english). Some of the other useful variables to know are :

$wbib_usejavascript
enables/disables javascript use in this extension,
$wbib_allowdivpopup
enables/disables the divpopup demo,
$wbib_allowbibpopup
enbales/disables the ACM-like popup,
$wbib_medianamespace
provides the namespace of uploaded pdf or ps files on your mediawiki

There are also two special variables

$wbib_pdficon and $wbib_psicon
Give for them the name of an image file uploaded to your mediawiki server. It allows to change these icons later without having to use something else than a web browser. So do not forget to put an image.

Use and online help mecanism

Put a bibtex reference on the page you're editing, just put it between <bibtex> and </bibtex> markups. For example, this:

<bibtex>
@article{10.1109/CIS.2011.180,
author = {Vrizlynn L.L. Thing and Tong-Wei Chua and Ming-Lee Cheong},
title = {Design of a Digital Forensics Evidence Reconstruction System for Complex and Obscure Fragmented File Carving},
journal ={Computational Intelligence and Security, International Conference on},
volume = {0},
isbn = {978-0-7695-4584-4},
year = {2011},
pages = {793-797},
doi = {http://doi.ieeecomputersociety.org/10.1109/CIS.2011.180},
publisher = {IEEE Computer Society},
address = {Los Alamitos, CA, USA},
}
</bibtex>

Once your entry is edited, you can save it.

The extension will interpret these additional tags:

pdf
you can put in it a pdf file uploaded in your mediawiki server (just the name without namespace - see bibstyle.php ). A link to this pdf will be automatically made using the icon you specified.
url
A link to the article.

On the bottom of the reference, you have a 'bibtex' link. If divpopup is enabled, then a div will appear with quite the same information when you put the mouse over the link. If bibpopup is enabled, then if you click on the link, an ACM-like popup will appear containing the rawtext of the bibtex entry.

Credits and people who provided help

  • this program was originally developed by http://gsc2.cemif.univ-evry.fr/index.php/Jean-Yves_Didier/en Jean-Yves Didier]
  • Dider wished to thank:
    • Vincent Le Ligeour for its divpopup demo,
    • Aurélien Hazan as a beta tester of this extension,
    • Kinh Tieu for developping and distributing the bibtex class without restriction. It was a great help.
    • Louis-Philippe Morency who informed me about the status of the bibtex class developped by Kinh Tieu.

License

Public domain. This code can be shared without any restrictions.This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Maintainer

Simson L. Garfinkel