-
Notifications
You must be signed in to change notification settings - Fork 14
Typeset Citations
The metadata of each document you like to cite needs to be stored in the
bibliography file usr/subdocuments/bibliography/open_science_paper.bib. The
entries need to be in BibTeX format (see box below). For more detailed
information about the structure of the bibliography file you can read on
here.
There is no need to write and format the entries in the bibliography file manually. You should check if your citation software supports the export of your collections or single entries to the BibTeX format.
@article{cite_key,
author = {Author one and Author two},
title = {The title of the paper},
journal = {The yournal name},
volume = {1},
year = {1981},
pages = {1--5},
}
The Open-Science-Paper comes with a bibliography file used by default which you
can find under usr/subdocuments/bibliography/open_science_paper.bib. You can
use this file to deposit all your BibTeX entries for citations in the document.
If you like to use another bibliography file then the default one you need to
change the path in
\addbibresource{usr/subdocuments/bibliography/open_science_paper.bib} in the
style file under usr/subdocuments/options/open_science_paper.sty to fit your
needs (see box below).
%%%-------------------------------------------------%%%
%%% Additional bib options %%%
%%%-------------------------------------------------%%%
\ExecuteBibliographyOptions{
url=false,
isbn=false,
doi=false,
firstinits=false,
bibencoding=utf8
}
%% add a BibTeX bibliography file %%
\addbibresource{path/to/your/bibfile.bib}
```
#### Maintaining the bibliography
If you write your paper as single author it is no big deal to maintain the
bibliography file. You can simply point the BibTeX export of your citation
manager to the Open-Science-Paper standard bibliography file.
You can also use the very comfortable automatic BibTeX file synchronization
feature of [Mendeley
Desktop](http://www.mendeley.com/download-mendeley-desktop/). Every time you
add an item to your local Mendeley collection it updates a BibTeX file in the
background named like the collection.
There is no support in Mendeley to store the BibTeX files somewhere else than
to a default location. So you need to change the default bibliography file path
of the Open-Science-Paper as explained above to point to the exported
bibliography file.
If you write a paper collaboratively it is a little bit trickier to maintain
the BibTeX file. There are several ways to achieve this and the best way to go
might be a citation management software with social features like Mendeley
Desktop or Zotero. In both you can create groups, invite other researchers to
collaboratively collect, and discuss relevant articles for your paper.
Unfortunately the automatic synchronization to a BibTeX file in Mendeley is
still restricted to local collections only. This means that every author needs
to create a local collection parallel to the online group collection and sync
it manually with the contents. This has to be done, by dragging and dropping
each of the items into the local groups.
This local collection then will be synced to BibTeX automatically as described
above. Each author needs to symlink the synchronized BibTeX file of his local
collection to the default bibliography file of the Open-Science-Paper then.
But this requires the BibTeX file to be excluded from the repository via the
.gitignore file. You can find the file inside the root document folder. There
is an entry that you just need to uncomment to ignore the default bibliography
file.
This manual synchronization can be quite cumbersome but it should work fine.
If you like Mendeley and want to get more comfort in collaborative writing in
combination with the Open-Science-Paper or other LaTeX documents you can go and
visit their feedback page and [vote](http://tinyurl.com/bqflgft) up for the
feature of LaTeX support for collaborative collections.
If you are working with a small group of authors, Mendeley Desktop will be a
good choice as a stand alone solution for your needs. But if you like to extend
your collaborative collections to more than three members you will need to pay
for an unrestricted account. If you can not afford this money another solution
is to use a combination of Zotero and Mendeley Desktop.
Zotero also allows you to [manage groups](http://www.zotero.org/support/groups)
and you can add members as much as you like. The only limitation of Zotero is
web space. This is required for the storage of papers you sync in your
collection (100 Mb free). For informations on how to get items into your Zotero
library you can read on
[here](http://www.zotero.org/support/getting_stuff_into_your_library).
After [installing](http://www.zotero.org/support/installation) Zotero properly
you can open up you Mendeley and enable the continuous Zotero import in the
options. Every time you add a new item in your Zotero group then, it will be
synced to Mendeley Desktop. If you have enabled the BibTeX export (collection
wise) of Mendeley it will then also create a BibTeX file for your Zotero
collaborative collection. The only thing you need to do then is, link this
synced file to the Open-Science-Paper standard library file.
#### Citations
In order to cite something from your BibTex file you will need the citation key
of the entry. You can find it in the beginning of the corresponding BibTeX
entry. Below you see some examples of citation commands available and their
corresponding output. If you use Mendeley Desktop you can simply right click on
a paper you like to cite and chose the option for LaTeX citation. It will give
you the right key to cite which you just need to paste into the document.
- Barker et al. (1990)
`\citet{bar90}`
- Barker et al. (1990, chap. 2)
`\citet[chap.~2]{bar90}`
- (Barker et al., 1990)
`\citep{bar90}`
- (Barker et al., 1990, chap. 2)
`\citep[chap.~2]{bar90}`
- (see Barker et al., 1990)
`\citep[see][]{bar90}`
- (see Barker et al., 1990, chap. 2)
`\citep[see][chap.~2]{bar90}`
- Barker, Franz, and Williams (1990)
`\citet*{bar90}`
- (Barker, Franz, and Williams, 1990)
`\citep*{bar90}`
- If you spot a typo, feel free to edit the wiki directly
- If you don't understand something, please email ctpfaff
- If you have have a longer contribution, please contact me first
Installation
Structure and Files
Typesetting
- The title header
- The footer
- Sectioning
- Lists
- Citations
- Figures
- Tables
- Math
- Code chunks
- Code listings
Workflow