-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathUsingBibTeXCitationsInSphinx.html
More file actions
364 lines (247 loc) · 16.4 KB
/
UsingBibTeXCitationsInSphinx.html
File metadata and controls
364 lines (247 loc) · 16.4 KB
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Managing bibliographic citations in Sphinx — Wiser 0.1 documentation</title>
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Creating equations in Sphinx" href="UsingMathEquationsInSphinx.html" />
<link rel="prev" title="Creating diagrams in Sphinx" href="UsingGraphicsAndDiagramsInSphinx.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> Wiser
</a>
<div class="version">
0.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../Using_Forum/index.html">Using Forum or Projects</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Using the technical documentation generator</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="index.html#introduction">Introduction</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html#references">References</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="About_Sphinx.html">About Sphinx</a></li>
<li class="toctree-l3"><a class="reference internal" href="OnReStructuredText.html">Sphinx’s reStructuredText primer</a></li>
<li class="toctree-l3"><a class="reference internal" href="ToolsForReStructuredText.html">Tools for reStructuredText</a></li>
<li class="toctree-l3"><a class="reference internal" href="PublishingTheDocsOnline.html">Publishing the documents online</a></li>
<li class="toctree-l3"><a class="reference internal" href="ShowingCodeExamplesInSphinx.html">Showing source code examples in Sphinx</a></li>
<li class="toctree-l3"><a class="reference internal" href="UsingGraphicsAndDiagramsInSphinx.html">Creating diagrams in Sphinx</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Managing bibliographic citations in Sphinx</a></li>
<li class="toctree-l3"><a class="reference internal" href="UsingMathEquationsInSphinx.html">Creating equations in Sphinx</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Using_Git/index.html">Using the version control system</a></li>
<li class="toctree-l1"><a class="reference internal" href="../On_Software/index.html">Commercial-Off-the-Shelf Software Selection Process</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Notebook/index.html">Notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Using_TaskMan/index.html">Using the issue tracking system</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Wiser</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="index.html">Using the technical documentation generator</a> »</li>
<li>Managing bibliographic citations in Sphinx</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/Using_Sphinx/UsingBibTeXCitationsInSphinx.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="managing-bibliographic-citations-in-sphinx">
<span id="rst-biblio-ref"></span><h1>Managing bibliographic citations in Sphinx<a class="headerlink" href="#managing-bibliographic-citations-in-sphinx" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>reStructuredText <a class="reference internal" href="OnReStructuredText.html#rst-citations-ref"><span class="std std-ref">Citations</span></a>
are ill-adapted to parenthetical referencing
(a.k.a. the <a href="#id2"><span class="problematic" id="id3">`Harvard System of Referencing`_</span></a>).</p>
<p>An alternative is to (manually) use the <a href="#id4"><span class="problematic" id="id5">`authorship trigraph`_</span></a>
(common in older computer science texts).</p>
<p>The citation begins with 4 letters:</p>
<ul class="simple">
<li><p>one author: first 4 letters of name</p></li>
<li><p>two authors: first 2 letters of author1, first 2 letters of author2</p></li>
<li><p>three authors: first 2 letters of author1, first letter of author2, first letter of author3</p></li>
<li><p>four authors: first letter of each author</p></li>
<li><p>more than four authors: first letter of first four authors</p></li>
</ul>
<p>The first letter of a name is always upper case.</p>
<p>After the authors’ initials, put the two digits of the year
(century-disambiguation is ignored).</p>
<p>If the symbol is exactly the same for two references, a lower case letter is attached.</p>
<p>To facilitate editing, citation text should be kept at the bottom of the
document after a “References” rubric heading, like this:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">rubric</span><span class="p">::</span> References
<span class="p">..</span> <span class="nt">[BiDB79]</span> Biskup, J.; Dayal, U.; Bernstein, P.A..: Synthesizing independent database schemas. In: ACM SIGMOD 1979 Int. Conf. On Management of Data Proceedings, S. 143-151.
<span class="p">..</span> <span class="nt">[BeBe79a]</span> Beeri, C.; Bernstein, P.A.: Computational problems related to the design of normal relational schemas. ACM Trans. Database Syst., No. 1, 1979, S. 30-59.
<span class="p">..</span> <span class="nt">[BeBe79b]</span> Beeri, C.; Bernstein, P.A.: Computers are stupid. ACM Trans. Database Syst., No. 4, 1979, S. 253-266.
</pre></div>
</div>
<p>A similar option is to use the BibTeX <code class="docutils literal notranslate"><span class="pre">alpha</span></code> style:</p>
<ul class="simple">
<li><p>one author: first 3 letters of the last name</p></li>
<li><p>two to four authors: first letters of last names concatenated</p></li>
<li><p>more than four authors: first letters of last names
of first three authors concatenated and a “+” sign at the end.</p></li>
</ul>
<p>For the examples above, the alpha style citation would be:
[BDB79], [BB79a] and [BB79b], respectively.</p>
</div>
<div class="section" id="using-sphinx-bibtex-extension">
<h2>Using Sphinx BibTeX extension<a class="headerlink" href="#using-sphinx-bibtex-extension" title="Permalink to this headline">¶</a></h2>
<p>Parenthetical referencing can be produced in <a class="reference external" href="http://sphinx-doc.org/">Sphinx</a>
using the <a href="#id6"><span class="problematic" id="id7">sphinxcontrib-bibtex_</span></a> extension.</p>
<p>The <a href="#id8"><span class="problematic" id="id9">sphinxcontrib-bibtex_</span></a> extension
allows <a class="reference external" href="http://www.bibtex.org/">BibTeX</a> citations to be inserted into documentation generated by Sphinx.</p>
<p>The extension defines a new <code class="docutils literal notranslate"><span class="pre">bibliography</span></code> directive and a new <code class="docutils literal notranslate"><span class="pre">cite</span></code> role.</p>
<p>These work similarly to the LaTeX’s <code class="docutils literal notranslate"><span class="pre">thebibliography</span></code> environment and <code class="docutils literal notranslate"><span class="pre">\cite</span></code>
command.</p>
<p>The references are stored in a separate plain text BibTeX format file.
Currently, only the <code class="docutils literal notranslate"><span class="pre">unsrt</span></code> and <code class="docutils literal notranslate"><span class="pre">plain</span></code> BibTeX styles are supported.</p>
<p>Please note that the current <a href="#id10"><span class="problematic" id="id11">sphinxcontrib-bibtex_</span></a> is a <strong>beta</strong> version.</p>
<div class="section" id="installing-the-extension">
<h3>Installing the extension<a class="headerlink" href="#installing-the-extension" title="Permalink to this headline">¶</a></h3>
<p>The module is installed with:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>pip install sphinxcontrib-bibtex
</pre></div>
</div>
<div class="admonition-this-is-a-tip admonition">
<p class="admonition-title">This is a tip.</p>
<p>For Windows users.
To facilitate the installation of 3rd party Python packages,
follow the instructions on how to
<a href="#id12"><span class="problematic" id="id13">`add Distribute and Pip to the Python installation`_</span></a>.</p>
</div>
</div>
<div class="section" id="including-the-extension-in-the-project-configuration-file">
<h3>Including the extension in the project configuration file<a class="headerlink" href="#including-the-extension-in-the-project-configuration-file" title="Permalink to this headline">¶</a></h3>
<p>The Sphinx project <code class="docutils literal notranslate"><span class="pre">conf.py</span></code> file must be altered to include:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">extensions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'sphinxcontrib.bibtex'</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<p>In the document, use the following syntax:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>See <span class="na">:cite:</span><span class="nv">`Strunk1979`</span> for an introduction to stylish blah, blah...
</pre></div>
</div>
<p>And place the directive at the end of the document:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">bibliography</span><span class="p">::</span> references.bib
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">references.bib</span></code> file should contain a <a class="reference external" href="http://www.bibtex.org/">BibTex</a> bibliography,
including an entry for:</p>
<div class="highlight-latex notranslate"><div class="highlight"><pre><span></span>@BOOK<span class="nb">{</span>Strunk1979,
title = <span class="nb">{</span>The Elements of Style<span class="nb">}</span>,
publisher = <span class="nb">{</span>Macmillan<span class="nb">}</span>,
year = <span class="nb">{</span>1979<span class="nb">}</span>,
author = <span class="nb">{</span>Strunk, Jr., William and E. B. White<span class="nb">}</span>,
edition = <span class="nb">{</span>Third<span class="nb">}</span>
<span class="nb">}</span>
</pre></div>
</div>
<div class="topic">
<p class="topic-title">Using the Sphinx Natbib Extension</p>
<p>A more flexible alternative is to use
<a class="reference external" href="http://wnielson.bitbucket.org/projects/sphinx-natbib/">http://wnielson.bitbucket.org/projects/sphinx-natbib/</a></p>
<p>This documentation can be completed
iff required in this specific project.</p>
</div>
<div class="topic">
<p class="topic-title">Using the Sphinx Thesis Resource</p>
<p>See also <a class="reference external" href="http://jterrace.github.io/sphinxtr/html/ch-intro/index.html">http://jterrace.github.io/sphinxtr/html/ch-intro/index.html</a>
for various useful adaptations/extensions of Sphinx.</p>
</div>
</div>
</div>
<div class="section" id="using-latex-directly-in-sphinx">
<h2>Using LaTeX directly in Sphinx<a class="headerlink" href="#using-latex-directly-in-sphinx" title="Permalink to this headline">¶</a></h2>
<p>For advanced users,
LaTeX can also be used directly in Sphinx (when only LaTeX output is required):</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>See <span class="na">:raw-tex:</span><span class="nv">`\cite{Strunk1979}`</span> for an introduction to stylish blah, blah...
</pre></div>
</div>
<p>And insert the bibliography at the end of the document:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">raw</span><span class="p">::</span> latex
\bibliographystyle{plain}
\bibliography{listb.bib}
</pre></div>
</div>
</div>
<div class="section" id="managing-bibtex-bibliographies">
<h2>Managing BibTeX bibliographies<a class="headerlink" href="#managing-bibtex-bibliographies" title="Permalink to this headline">¶</a></h2>
<p>The BibTeX files can be easily managed with <a class="reference external" href="http://www.jabref.org/">JabRef</a>.</p>
<p>JabRef is an open source bibliography reference manager.
The native file format used by JabRef is BibTeX, the standard LaTeX bibliography format.</p>
<p>JabRef runs on the Java (version 1.6 or newer),
and should work equally well on Windows, Linux and Mac OS X.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="UsingMathEquationsInSphinx.html" class="btn btn-neutral float-right" title="Creating equations in Sphinx" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="UsingGraphicsAndDiagramsInSphinx.html" class="btn btn-neutral float-left" title="Creating diagrams in Sphinx" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014, the Nile team | CC BY-SA 3.0 | Exceptions apply! See the sources and metadata for each doc.
<span class="lastupdated">
Last updated on May 19, 2020.
</span>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>