doc/plugins/contrib/bibtex.mdwn

   1 # bibtex for ikiwiki #
   2
   3 This [ikiwiki]-plugin provides a
   4
   5     [[!bibtex ]]
   6
   7 directive for [ikiwiki].
   8
   9 So far, it can display a raw or formatted bibtex-entry from a
  10 bibtex-file (either checked into ikiwiki, or not).
  11
  12 [ikiwiki]: http://ikiwiki.info/
  13
  14 Get it at [github].
  15
  16 [github]: https://github.com/ihrke/iki-bibtex
  17
  18 Features:
  19
  20 * supports websetup
  21
  22 ## Requirements ##
  23
  24 * [Text::BibTeX] - available from CPAN
  25
  26 [Text::BibTeX]: http://search.cpan.org/~ambs/Text-BibTeX-0.61/lib/Text/BibTeX.pm
  27
  28 ## Examples ##
  29
  30 Output from file mybib.bib, bibtex key 'key1' in a citation-like
  31 format (authors (year): journal. volume (number), pages.).
  32
  33     [[!bibtex file="mybib.bib" key="key1" format="citation"]]
  34
  35 Combine with toggle-plugin to optionally display the raw bibtex
  36
  37     [[!bibtex key="Ihrke2011"]] [[!toggle id="bibtexentry" text="(entry)"]]
  38     [[!toggleable  id="bibtexentry" text="""
  39     [[!bibtex key="Ihrke2011" format="raw"]]
  40     [[!toggle id="bibtexentry" text="(hide)"]]
  41     """]]
  42