BibliographyPlugin

Overview

The BibliographyPlugin manages citations inside a TWiki topic, and can generate a References List at the end of the topic. This should be every useful for writing conference papers, journal articles, elaborated news, etc.

Syntax Rules

First of all, you must have a topic with a list of bibliography entries. Each entry must consist of a table rows with two columns: the first one contains a key, that will identify that entry (and must be unique). The second column contains the bibliography reference for that entry.

The bibliography list should look like this (from a BibTex example found with Google):

Key	Description
big	Jass, Hugh. A big paper. The journal of big papers, 7991, volume MCMXCVII.
small	Freely, I.P. A small paper. The journal of small papers, 1997. (to appear).

Then, in the topic where you want to reference and get a references list, you can use:

• %CITE{theKey}% to reference the entry with key theKey.
• %CITEINLINE{theKey}% to reference samething that is not in the references. Useful to cite URL's, for example. theKey will be used both as key and text dislayed in references listing.
  Warning: be sure to not use keys present in bibliography with %CITEINLINE{}%: this can have unpredicted results.
• %BIBLIOGRAPHY{...}% to get a list of references. %BIBLIOGRAPHY{...}% accepts the following arguments:

  Argument	Description	Default value
  header	the header for the references list (like "References", "Refer�ncias" (in portuguese), and so on.	DEFAULTHEADER setting (see below).
  referencesTopic	indicates the topic bibliography must be taken from. Can be a comma-separated list of topics.	DEFAULTBIBLIOGRAPHYTOPIC setting (see below).
  order	in which order the references should appear. Accepted values are citation (references appear in citation order) and alpha (references appear in alphabetical order).	DEFAULTSORTING setting (see below).
  Usage example:
  %BIBLIOGRAPHY{header="---++ Refer�ncias" referencesTopic="MinhaBibliografia" order="citation"}% The above usage tells BibliographyPlugin to use "Refer�ncias" (in portuguese) as the title of the references list, to take bibliography from a topic names MinhaBibliografia and to list the references in citation order.

Example

You start writing, and then cite a
small paper %CITE{small}%. Further,
you reference a big paper %CITE{big}%.
You can even reference the small
paper again %CITE{small}%.

With %CITEINLINE% you can reference things
that are not in your bibliography
%CITEINLINE{http://TWiki.org/cgi-bin/view/Plugins/BibliographyPlugin}%.

%BIBLIOGRAPHY{}%

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %BIBLIOGRAPHYPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Cite bibliography in one topic and get an automatically created references list

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• Default topic to get references from:
  • Set DEFAULTBIBLIOGRAPHYTOPIC = BibliographyPlugin

• Default sorting for references:
  • Set DEFAULTSORTING = alpha

• Default header for the references list:
  • Set DEFAULTHEADER = ---++ References

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the adminis trator who installs the plugin on the TWiki server.

• For an automated installation, run the configure script and follow "Find More Extensions"

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins home (see below).
  • Unzip BibliographyPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/BibliographyPlugin.txt	Plugin topic
    lib/TWiki/Plugins/BibliographyPlugin.pm	Plugin Perl module

  • Set the ownership of the extracted directories and files to the webserver user.
  • Install the dependencies (if any).

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Configure additional plugin settings in the Extensions section if needed.
  • Test if the installation was successful: see above at #Example

Plugin Info

Plugin Author:	TWiki:Main/AntonioTerceiro
Copyright:	© 2004-2005 TWiki:Main.AntonioTerceiro © 2008-2011 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2011-03-09
Change History:
2011-03-09:	TWikibug:Item6638: Doc fixes; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
28 Aug 2005:	1.020: Adhering to official handlers in TWiki:Codev/DakarRelease. Added %CITEINLINE{...}%.
23 Aug 2004:	Added multiple references sources support
17 Jun 2004:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
TWiki:Plugins/Benchmark:	GoodStyle 97%, FormattedSearch 99%, BibliographyPlugin 97%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/BibliographyPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/BibliographyPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/BibliographyPluginAppraisal

Related Topics: TWikiPlugins, AdminDocumentationCategory