Welcome to CiteBib’s documentation!¶
| Authors: | François Boulogne |
|---|---|
| Download: | Stable version |
| Developer’s corner: | |
| github.com project | |
| Generated: | Sep 27, 2017 |
| License: | GPL v3 |
| Version: | 0.4.3 |
Contents:
What is Citebib?¶
The best description is my usage. I have several bibtex managed with jabref. When I write an article, I pick up some references from these bibtex files. The point is that I do not want to use the big bibtex files for my article because:
- they contain unused entries
- they contain custom fields/notes
citebib reads your tex files, track cite{} calls, and select useful fields. Then, it generates:
- a clean bibtex file,
- or a bibliography in a latex format (because some journals do not support bibtex)
The behavior is customisable from the configuration.
Given a key, citekey returns a formatted reference. (Might be useful for emails, presentations...)
How to install¶
See How to install?.
Configuration¶
The default location is ~/.config/citebib
To initialize the configuration, you must citebib or citekey one time. Then, the following tree will be created:
.
├── bibtex
│ └── default.conf
├── latex
│ └── default.conf
└── raw
└── default.conf
Each subdirectory (bibtex, latex and raw) corresponds to a printing mode. The configuration file give you the possibility to activate or desactivate fields (like author, title...).
TODO...
Usage¶
citekey¶
To print the syntax:
citekey -h
To print the reference foo2010 in a raw style:
citekey foo2010
To print the reference foo2010 in a latex style:
citekey --latex foo2010
To print the bibtex entry foo2010:
citekey --bibtex foo2010