]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/commitdiff
initial
authorhttps://www.google.com/accounts/o8/id?id=AItOawnptdo_29LsbUxftV55P932hRZccivCtl0 <Matthias@web>
Tue, 1 Nov 2011 22:16:33 +0000 (18:16 -0400)
committeradmin <admin@branchable.com>
Tue, 1 Nov 2011 22:16:33 +0000 (18:16 -0400)
doc/plugins/contrib/bibtex.mdwn [new file with mode: 0644]

diff --git a/doc/plugins/contrib/bibtex.mdwn b/doc/plugins/contrib/bibtex.mdwn
new file mode 100644 (file)
index 0000000..3377037
--- /dev/null
@@ -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)"]]
+    """]]
+