doc/plugins/contrib/bibtex.mdwn

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