Skip to topic | Skip to bottom
TWiki
TWiki.BibliographyPluginr1.1 - 06 Nov 2006 - 20:04 - Main.guesttopic end

Start of topic | Skip to actions

BibliographyPlugin

BibliographyPlugin manages citations inside a TWiki topic, and can generate an References List at the end of the topic. This should be every usefull for writing conference papers, journal articles, ellaborated 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.
  • %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 type ... ... and you get:
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}%.

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

References

Plugin Settings

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

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

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

  • Default topic to get references from:
    • Set DEFAULTBIBLIOGRAPHYTOPIC = BibliographyReferences?

  • 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 administrator who installs the plugin on the server where TWiki is running.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip BibliographyPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/BibliographyPlugin.txt Plugin topic
    data/TWiki/BibliographyPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/BibliographyPlugin.pm Plugin Perl module
  • Test if the installation was successful: see above at #Example

Plugin Info

Plugin Author: TWiki:Main/AntonioTerceiro
Plugin Version: 23 Aug 2004
Change History:  
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

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/AntonioTerceiro - 17 Jun 2004
to top


You are here: TWiki > BibliographyPlugin

to top

Copyright © 1999-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback