BibliographyPlugin < TWiki

Tags: , view all tags
---+ <nop/>%TOPIC%
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/BibliographyPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/BibliographyPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

---++ 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 <nop/>BibTex [[http://shelah.logic.at/eindex.html][example]] found with [[http://www.google.com][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:

   * =%<nop/>CITE{<em>theKey</em>}%= to reference the entry with key _theKey_.
   * =%<nop/>CITEINLINE{<em>theKey</em>}%= 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. %BR%
     __Warning:__ be sure to not use keys present in bibliography with
     <code>%<nop/>CITEINLINE{}%</code>: this can have unpredicted results.
   * =%<nop/>BIBLIOGRAPHY{...}%= to get a list of references. =%<nop/>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:* |||
     | =%<nop/>BIBLIOGRAPHY{header="---++ Refer�ncias" referencesTopic="<nop/>MinhaBibliografia" order="citation"}%= %BR% 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 <nop/>MinhaBibliografia and to list the references in citation order.  |||

---++ Example

<table border='1'>
  <tr>
    <th> You type ...
    </th>
    <th> ... and you get:
    </th>
  </tr>
  <tr>
    <td>
<!-- you type: -->
<pre>
You start writing, and then cite a
small paper %<nop/>CITE{small}%. Further,
you reference a big paper %<nop/>CITE{big}%.
You can even reference the small
paper again %<nop/>CITE{small}%.

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

%<nop/>BIBLIOGRAPHY{}%
</pre>
    </td>
    <td>
<!-- 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}%.

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

%BIBLIOGRAPHY{}%
    </td>
  </tr>
</table>

---++ Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>BIBLIOGRAPHYPLUGIN_SHORTDESCRIPTION%==

   * One line description, is shown in the %SYSTEMWEB%.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 = TWiki.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 [[%SCRIPTURL{configure}%][configure]] script and follow "Find More Extensions" 
in the in the __Extensions__ section.

   * Or, follow these __manual installation__ steps:
      * Download the ZIP file from the Plugins home (see below).
      * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
        | *File:* | *Description:* |
        | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
        | ==lib/TWiki/Plugins/%TOPIC%.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 [[%SCRIPTURL{configure}%][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: | &copy; 2004-2005 TWiki:Main.AntonioTerceiro <br /> &copy; 2008-2011 TWiki:TWiki.TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 2011-03-09  |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  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 <code>%<nop/>CITEINLINE{...}%</code>. |
|  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: | %SYSTEMWEB%.GoodStyle 97%, %SYSTEMWEB%.FormattedSearch 99%, %TOPIC% 97% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.AdminDocumentationCategory
Topic revision: r1 - 2011-03-10 - TWikiContributor
Account
- Log In
Edit
Attach
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.BibliographyPlugin.
antalya escort bursa escort eskisehir escort istanbul escort izmir escort