aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/contrib/bibtex.mdwn42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/plugins/contrib/bibtex.mdwn b/doc/plugins/contrib/bibtex.mdwn
new file mode 100644
index 000000000..33770377d
--- /dev/null
+++ b/doc/plugins/contrib/bibtex.mdwn
@@ -0,0 +1,42 @@
+# bibtex for ikiwiki #
+
+This [ikiwiki]-plugin provides a
+
+ [[!bibtex ]]
+
+directive for [ikiwiki].
+
+So far, it can display a raw or formatted bibtex-entry from a
+bibtex-file (either checked into ikiwiki, or not).
+
+[ikiwiki]: http://ikiwiki.info/
+
+Get it at [github].
+
+[github]: https://github.com/ihrke/iki-bibtex
+
+Features:
+
+* supports websetup
+
+## 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"]]
+
+Combine with toggle-plugin to optionally display the raw bibtex
+
+ [[!bibtex key="Ihrke2011"]] [[!toggle id="bibtexentry" text="(entry)"]]
+ [[!toggleable id="bibtexentry" text="""
+ [[!bibtex key="Ihrke2011" format="raw"]]
+ [[!toggle id="bibtexentry" text="(hide)"]]
+ """]]
+