Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Documentation update
- Loading branch information
Klaus Thoden
committed
Sep 12, 2018
1 parent
f201205
commit e55f6da
Showing
7 changed files
with
667 additions
and
0 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# How the bibliography is made | ||
|
||
References are stored in a bibtex file. The XML file contains | ||
citations that are similar to a LaTeX citation command. | ||
|
||
During processing, the bibtex file and the bibliography and citation | ||
type (anthology or monograph, numeric or author/year) are read out of | ||
the XML source file. | ||
|
||
`pandoc-citeproc` is used to construct a JSON file out of the bibtex | ||
database. This is helpful during the next parts of processing. | ||
|
||
<!-- | ||
!-- What exactly is it used for? Just for putting the title in the popover element? | ||
--> | ||
|
||
The next step formats the bibliography, depending on the bibliography | ||
type, as a complete list or as per-chapter-list. In the second case, | ||
several markdown and html files are created, one for each chapter. | ||
They are named after the `xml:id` of the chapter. | ||
|
||
The function `format_citations` then creates two outputs: the list of | ||
references, formatted in html and a dictionary with the citekey as | ||
headword and three manifestations of the data (author-year-citation, | ||
year-citation and title). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Create temporary bibliography | ||
|
||
In cases where authors hand in a formatted version of the bibliography | ||
(rather than a reference database), this tool can help creating a | ||
database in BibTeX format. | ||
|
||
Required argument is a textfile with a formatted bibliography (one | ||
entry per line). The option `k` is there to supply an entry with a | ||
keyword, for example the name of the chapter author. | ||
|
||
We require authors to use shortcuts in their docx manuscript when | ||
citing, including the use of a citekey (`LASTNAME_YEAR`), there should | ||
already be citekeys in the manuscript. When running `fix_tei.py`, | ||
these citekeys are gathered together and can be used as an input to | ||
this tool. | ||
|
||
The tool creates temporary citekeys out of the formatted bibliography | ||
and in an interactive session, the user selects the most likely entry. | ||
With this, rudimentary entries can be created. |
Oops, something went wrong.