-
Notifications
You must be signed in to change notification settings - Fork 5
/
index.html
106 lines (100 loc) · 7.37 KB
/
index.html
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>DBLP BibTeX</title>
</head>
<body>
<h2>DBLP BibTeX</h2>
<hr />
<h3>What is DBLP BibTeX?</h3>
<p>
DBLP BibTeX is a BibTeX aid program that can automatically download citations and cross references from the <a href="http://www.dblp.org">DBLP Computer Science Bibliography</a> and the <a href="http://eprint.iacr.org">Cryptology ePrint Archive</a>
and add them to your BIB file.
Furthermore, when explicitely enabled it also allows you to search these archives and automatically insert up to 5 matched citations into your .tex file.
DBLP BibTeX acts as a BibTeX replacement that needs to be called from your TeX environment instead of the original BibTeX, after it has finished its work it will call the original BibTeX to proceed as usual.
</p>
<h3>Download DBLP BibTeX for Windows</h3>
<p>
A windows executable can be downloaded <a href="dblpbibtex.exe">here</a>.
</p>
<h3>Building DBLP BibTeX</h3>
<p>
The source file can be downloaded <a href="dblpbibtex.cpp">here</a> and an example Makefile <a href="Makefile">here</a>.
DBLP BibTeX depends on the <a href="http://www.boost.org">Boost C++ Libraries</a>.
If these are properly installed then simply run:<br /><code>make</code><br />or something like:<br /><code>g++ -O2 -pthread -march=native -o dblpbibtex dblpbibtex.cpp -lboost_system -lboost_program_options -lboost_filesystem -lpthread</code><br />
</p>
<h3>Installing DBLP BibTeX</h3>
<ol>
<li>Set your TeX environment to call the DBLP BibTeX executable instead of the original BibTeX executable. Usually this can be achieved by setting the environment variable <code>BIBTEX</code> with the full path to your <code>dblpbibtex</code> executable.
Otherwise, search inside your TeX editor. As a last resort, you can try to rename <code>dblpbibtex</code> to <code>bibtex</code> and setting the DBLP BibTeX directory as the first entry in your <code>PATH</code> environment variable.</li>
<li>DBLP BibTeX needs to find your original BibTeX executable. If <code>bibtex</code> is found directly by the command line shell then you're all set.
Otherwise set the environment variable <code>BIBTEXORG</code> with the full path to your original <code>bibtex</code> executable.</li>
</ol>
<h3>Using DBLP BibTeX</h3>
<p>
Example excerpt from a TeX file:
</p>
<pre>
\cite{DBLP:conf/crypto/StevensSALMOW09,cryptoeprint:2009:111}
\cite{search:chosen+prefix+collisions}
\cite{search-dblp:chosen+prefix+collisions}
\cite{search-cryptoeprint:chosen+prefix+collisions}
\cite{search-bib:chosen+prefix+collisions}
\nocite{dblpbibtex:mainbibfile:dblpbibtex}
\nocite{dblpbibtex:enablesearch}
\nocite{dblpbibtex:addbibtexoption:--min-crossrefs=20}
\bibliography{thesis,dblpbibtex}
</pre>
The above nocites can also be achieved using a dblpbibtex.cfg file with the following contents:
<pre>
mainbibfile=dblpbibtex.bib
enablesearch=1
addbibtexoption=--min-crossrefs=20
</pre>
<p>
Usage:
<ul>
<li><b>Main bib file:</b> The main bib file is the bib file DBLP BibTeX will write its downloaded citations to. It defaults to the first mentioned bib file in your TeX file (in the example this would be <code>thesis.bib</code>). This can be overriden using a <code>\nocite{dblpbibtex:mainbibfile:bibfilename}</code> command
in your TeX file where bibfilename is replaced with the desired filename (in the example this is <code>dblpbibtex.bib</code>). It is advised to use a seperate bib file for DBLP BibTeX as shown in the example.</li>
<li><b>Citations:</b> DBLP BibTeX will automatically read all citations from your AUX file (generated by (La)TeX) and all entries in your BIB files. It will try to download all missing <code>DBLP:conf/crypto/StevensSALMOW09</code> style and <code>cryptoeprint:2009:111</code> style bibtex entries from DBLP and Crypto ePrint Archive, respectively.
These citations will be prepended to the main bib file. Any missing cross reference citations will also be downloaded and appended to the main bib file.</li>
<li><b>Searching for citations:</b> DBLP BibTeX is capable of searching the DBLP and Crypto ePrint archives and your included BIB files through <code>search:keyword1+keyword2+keyword3+etc</code> style citation keys. It will replace this citation key in your TeX file with up to 5 found results.
Since it edits your TeX file, searches must be explicitly enabled in your TeX file through a <code>\nocite{dblpbibtex:enablesearch}</code> command. Using <code>search-dblp:</code>, <code>search-cryptoeprint:</code> or <code>search-bib:</code> instead of <code>search:</code> will search only DBLP, Crypto ePrint Archive or processed BIB files, respectively.
The general <code>search:</code> command will first perform a <code>search-dblp</code> search and when unsuccesful will do a <code>search-cryptoeprint</code> search. If both are unsuccesful it will search your BIB files.</li>
<li><b>Adding BibTeX options:</b> Passing extra command parameters to BibTeX can be difficult depending on your TeX environment. You can let DBLP BibTeX pass extra parameters to BibTeX specified in your TeX file through a <code>\nocite{dblpbibtex:addbibtexoption:--min-crossrefs=20}</code> command.
In this example, it will pass the <code>--min-crossrefs=20</code> parameter that tells BibTeX to seperately citate crossrefs in your bibliography when it has been crossref'd at least 20 times (instead of the default 2 times).
<li><b>Cleaning up the main bib file:</b> As an extra feature, DBLP BibTeX can clean up the main bib file from all entries that are not citated or crossreferenced using the <code>\nocite{dblpbibtex:cleanupmainbibfile}</code> command. Make sure you do this only when the main bib file is only used for DBLP BibTeX, so it doesn't delete any manually added bibtex entries.
</ul>
</p>
<hr />
<h4>Copyright and Licence</h4>
Copyright Marc Stevens 2010 - 2011. Distributed under the Boost Software License, Version 1.0, copy available <a href="LICENSE_1_0.txt">here</a>.
<h4>Feedback</h4>
Any comments, requests, improvements, etc. can be send to: marc(replacebyAT)marc(replacebyDASH)stevens(replacebyDOT)nl.
<h4>Thanks</h4>
Thanks go out to Peter van Liesdonk for providing patches and feedback.
<h4>Version History</h4>
<ul>
<li><b>1.08 (19-may-2016):</b> Fixed DBLP website change (www.dblp.org => dblp.org).</li>
<li><b>1.07 (10-feb-2015):</b> Fixed DBLP download of citations.</li>
<li><b>1.06 (8-jan-2013):</b> Fixed IACR ePrint search.</li>
<li><b>1.05 (22-okt-2011):</b> Run bibtex even in the case of exceptions. More graceful offline handling.</li>
<li><b>1.04 (19-sept-2011):</b> Fixed configurationfile parser bugs.</li>
<li><b>1.03 (19-sept-2011):</b> Updated DBLP server to www.dblp.org.</li>
<li><b>1.02:</b> More bug fixes. Beta release.</li>
<li><b>1.01:</b> Bug fixes.</li>
<li><b>1.00:</b> First alpha release.</li>
</ul>
<hr />
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-9278204-1");
pageTracker._trackPageview();
} catch(err) {}</script>
</body>
</html>