doc/plugins/contrib/bibtex.mdwn

   1 [[!template id=plugin name=bibtex author="[[Matthias]]"]]
   2
   3 # bibtex for ikiwiki #
   4
   5 (get me at [github]!)
   6
   7 [github]: https://github.com/ihrke/iki-bibtex
   8
   9 This [ikiwiki]-plugin provides a
  10
  11     [[!bibtex ]]
  12
  13 directive for [ikiwiki].
  14
  15 So far, it can display a raw or formatted bibtex-entry from a
  16 bibtex-file (either checked into ikiwiki, or not) and display a
  17 list of all bibtex-keys used on a key.
  18
  19 [ikiwiki]: http://ikiwiki.info/
  20
  21 Features:
  22
  23 * three different output formats for citations:
  24   + cite - Author (year)
  25   + citation - Author1, Author2 (year): **Title.** *Journal*
  26   vol(num). pp.
  27   + raw - raw bibtex-entry preformatted
  28 * supports websetup
  29 * bibliography
  30
  31
  32 ## Requirements ##
  33
  34 * [Text::BibTeX] - available from CPAN
  35
  36 [Text::BibTeX]: http://search.cpan.org/~ambs/Text-BibTeX-0.61/lib/Text/BibTeX.pm
  37
  38 ## Examples ##
  39
  40 Output from file mybib.bib, bibtex key 'key1' in a citation-like
  41 format (authors (year): journal. volume (number), pages.).
  42
  43     [[!bibtex file="mybib.bib" key="key1" format="citation"]]
  44
  45 Combine with toggle-plugin to optionally display the raw bibtex
  46
  47     [[!bibtex key="Ihrke2011"]] \[[!toggle id="bibtexentry" text="(entry)"]]
  48     \[[!toggleable  id="bibtexentry" text="""
  49     [[!bibtex key="Ihrke2011" format="raw"]]
  50     \[[!toggle id="bibtexentry" text="(hide)"]]
  51     """]]
  52
  53 Add a bibliography that includes all bibtex-directives from that page
  54
  55
  56     ## Bibliography ##
  57     [[!bibtex_bibliography ]]
  58
  59     ----