Updated the README
This commit is contained in:
parent
adc6716fd8
commit
c75ab3fd79
55
README.md
55
README.md
|
@ -1,3 +1,56 @@
|
|||
# lektor-citation
|
||||
|
||||
An APA-style citation plugin for the lektor static content management system (https://getlektor.com).
|
||||
An APA-styled citation plugin for the lektor static content management system (https://getlektor.com).
|
||||
|
||||
## Preparations
|
||||
|
||||
Install the plugin by
|
||||
```
|
||||
lektor plugin add lektor-citation
|
||||
```
|
||||
|
||||
or by copying this repository into the _packages_-folder of your lektor-project.
|
||||
|
||||
Create an _citation.ini_ in its _configs_-folder:
|
||||
```
|
||||
[Bibtex]
|
||||
file = Literature.bib
|
||||
```
|
||||
|
||||
And put a _Literature.bib_ BibTex-file into the project's _assets_-folder respectively.
|
||||
|
||||
## Jinja_env
|
||||
|
||||
To get a formated output of your whole BibTex library you can either
|
||||
1. Use method citation\_short\_output in the template of your literature page. It creates an unordered list of entries.
|
||||
```
|
||||
<ul id="literatur">
|
||||
{% for entry in citation_entries() %}
|
||||
{{ citation_short_output(entry)|decode|safe }}
|
||||
{% endfor %}
|
||||
|
||||
</ul>
|
||||
```
|
||||
2. Use method citation\_full\_output instead. This creates a more complete html-output for every entry.
|
||||
```
|
||||
{% for entry in citation_entries() %}
|
||||
{{ citation_full_output(entry)|decode|safe }}
|
||||
{% endfor %}
|
||||
```
|
||||
produces
|
||||
```
|
||||
<h2>{title}</h2><h3>{authors} ({pubYear})</h3>
|
||||
<p>{note}</p>
|
||||
<dl class="literature">
|
||||
<dt class="edition"></dt>
|
||||
<dd>{edition}</dd>
|
||||
<dt class="editors"></dt>
|
||||
<dd>{editors}</dd>
|
||||
<dt class="pages"></dt>
|
||||
<dd>{pages}</dd>
|
||||
<dt class="issbn"></dt>
|
||||
<dd>{issbn}</dd>
|
||||
<dt class="publisher"></dt>
|
||||
<dd>{publisher}</dd>
|
||||
</dl>
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue