ikiwiki/doc/plugins/contrib/bibtex.mdwn

60 lines
1.4 KiB
Plaintext
Raw Normal View History

2011-11-01 23:22:47 +01:00
[[!template id=plugin name=bibtex author="[[Matthias]]"]]
2011-11-01 23:16:33 +01:00
# bibtex for ikiwiki #
2011-11-02 23:06:04 +01:00
(get me at [github]!)
[github]: https://github.com/ihrke/iki-bibtex
2011-11-01 23:16:33 +01:00
This [ikiwiki]-plugin provides a
[[!bibtex ]]
directive for [ikiwiki].
So far, it can display a raw or formatted bibtex-entry from a
2011-11-02 23:06:04 +01:00
bibtex-file (either checked into ikiwiki, or not) and display a
list of all bibtex-keys used on a key.
2011-11-01 23:16:33 +01:00
[ikiwiki]: http://ikiwiki.info/
Features:
2011-11-02 23:06:04 +01:00
* three different output formats for citations:
+ cite - Author (year)
+ citation - Author1, Author2 (year): **Title.** *Journal*
vol(num). pp.
+ raw - raw bibtex-entry preformatted
2011-11-01 23:16:33 +01:00
* supports websetup
2011-11-02 23:06:04 +01:00
* bibliography
2011-11-01 23:16:33 +01:00
## Requirements ##
* [Text::BibTeX] - available from CPAN
[Text::BibTeX]: http://search.cpan.org/~ambs/Text-BibTeX-0.61/lib/Text/BibTeX.pm
## Examples ##
Output from file mybib.bib, bibtex key 'key1' in a citation-like
format (authors (year): journal. volume (number), pages.).
[[!bibtex file="mybib.bib" key="key1" format="citation"]]
2011-11-02 23:06:04 +01:00
Combine with toggle-plugin to optionally display the raw bibtex
2011-11-01 23:16:33 +01:00
2011-11-02 23:06:46 +01:00
[[!bibtex key="Ihrke2011"]] \[[!toggle id="bibtexentry" text="(entry)"]]
\[[!toggleable id="bibtexentry" text="""
2011-11-01 23:16:33 +01:00
[[!bibtex key="Ihrke2011" format="raw"]]
2011-11-02 23:06:46 +01:00
\[[!toggle id="bibtexentry" text="(hide)"]]
2011-11-01 23:16:33 +01:00
"""]]
2011-11-02 23:06:04 +01:00
Add a bibliography that includes all bibtex-directives from that page
## Bibliography ##
[[!bibtex_bibliography ]]
----