aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/contrib/bibtex.mdwn
blob: e600f39639c073d4bb62c6bb60d6e8e5deac0c39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
[[!template id=plugin name=bibtex author="[[Matthias]]"]]

# bibtex for ikiwiki #

(get me at [github]!)

[github]: https://github.com/ihrke/iki-bibtex

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) and display a 
list of all bibtex-keys used on a key.

[ikiwiki]: http://ikiwiki.info/

Features:

* three different output formats for citations:
  + cite - Author (year)
  + citation - Author1, Author2 (year): **Title.** *Journal*
  vol(num). pp.
  + raw - raw bibtex-entry preformatted
* supports websetup
* bibliography


## 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)"]]
    """]]
    
Add a bibliography that includes all bibtex-directives from that page


    ## Bibliography ##
    [[!bibtex_bibliography ]]

    ----