|
1 | 1 | <?xml version="1.0" encoding="utf-8"?> |
2 | | -<feed xmlns="http://www.w3.org/2005/Atom"><title>Generic Surname</title><link href="https://jrsmith3.github.io/" rel="alternate"></link><link href="https://jrsmith3.github.io/feeds/all-en.atom.xml" rel="self"></link><id>https://jrsmith3.github.io/</id><updated>2015-03-22T00:00:00-04:00</updated><entry><title>Naming data files revisited</title><link href="https://jrsmith3.github.io/naming-data-files-revisited.html" rel="alternate"></link><updated>2015-03-22T00:00:00-04:00</updated><author><name>Joshua Ryan Smith</name></author><id>tag:jrsmith3.github.io,2015-03-22:naming-data-files-revisited.html</id><summary type="html"><p>I wrote a <a href="http://jrsmith3.github.io/naming-data-files.html">post about naming data files</a> awhile back. Also, yesterday I found that <a href="http://conda.pydata.org/docs/intro.html#package-naming-conventions">conda canonical filenames</a> <a href="https://github.com/conda/conda/issues/974#issuecomment-61172554">cannot support semver version strings</a> because the dash ("-") character is disallowed in the string.</p> |
| 2 | +<feed xmlns="http://www.w3.org/2005/Atom"><title>Generic Surname</title><link href="https://jrsmith3.github.io/" rel="alternate"></link><link href="https://jrsmith3.github.io/feeds/all-en.atom.xml" rel="self"></link><id>https://jrsmith3.github.io/</id><updated>2015-06-12T00:00:00-04:00</updated><entry><title>Handling citations in an early draft of a document</title><link href="https://jrsmith3.github.io/handling-citations-in-an-early-draft-of-a-document.html" rel="alternate"></link><updated>2015-06-12T00:00:00-04:00</updated><author><name>Joshua Ryan Smith</name></author><id>tag:jrsmith3.github.io,2015-06-12:handling-citations-in-an-early-draft-of-a-document.html</id><summary type="html"><h1>The problem: handling citations is a pain</h1> |
| 3 | +<p>Dealing with citations in a document can be tedious, especially when done by hand. From my experience, the tedium falls into one of two categories:</p> |
| 4 | +<ol> |
| 5 | +<li><strong>Formatting</strong> -- There are many different ways to format a citation appearing in a bibliography (MLA, Chicago, etc.). Formatting by hand usually requires tedious copy/pasting or re-keying data that's already available.</li> |
| 6 | +<li><strong>Organization</strong> -- Oftentimes citations appear in the bibliography in the order in which they appeared in the text. Managing such a list by hand becomes extremely difficult as the number of citations increases, particularly if a citation needs to be inserted in the middle of the list and the subsequent citation numbers need to be incremented.</li> |
| 7 | +</ol> |
| 8 | +<p>During the initial drafts of a document, this tedium can be especially disrupting. My suggestion is to put a unique identifier for each citation in the body of the text instead of trying to wrangle the order and formatting of the citations during the early stages. Many books and academic papers already feature an "official" unique identifier: the DOI or ISBN.</p> |
| 9 | +<h1>The solution: unique identifiers</h1> |
| 10 | +<p>Your first thought might be, "The solution is to use <a href="https://en.wikipedia.org/wiki/Comparison_of_reference_management_software">reference management software</a>." This approach is on the right track, but the real secret sauce is to use unique identifiers to cite works within the document. Using unique identifiers to cite works within the document renders the choice of reference management software arbitrary.</p> |
| 11 | +<h2>Where to find a source's unique identifier</h2> |
| 12 | +<p>Conveniently, most papers found in the peer-reviewed literature are uniquely identified by a number called a "<a href="https://en.wikipedia.org/wiki/Digital_object_identifier">digital object identifier</a>" or DOI. An example of a DOI is <a href="http://dx.doi.org/10.1063/1.4826202">10.1063/1.4826202</a>; the DOI is usually printed somewhere on the paper as shown in the following image (click to enlarge):</p> |
| 13 | +<p><a href="images/10.1063__1.4826202_p1.png"><img alt="Front cover of lab notebook" src="images/10.1063__1.4826202_p1_small.png" title="Front cover of lab notebook" /></a></p> |
| 14 | +<p><a href="http://search.crossref.org">Crossref's metadata search</a> is an incredibly useful tool for resolving a paper's website or DOI from an item in a bibliography. Typing in a paper's title and a few other identifying bits of information (author, year, journal) is usually enough for Crossref's metadata search to return the correct result with the DOI.</p> |
| 15 | +<p>You might have noticed that the DOI in the above example image is part of a URL. Conveniently, there is a DOI resolver on the web. Simply typing the URL <code>http://dx.doi.org/</code> and pasting the DOI after the final <code>/</code> into your web browser will resolve to the page on which any particular paper is hosted.</p> |
| 16 | +<p>Similarly, books are identified by a number called an "<a href="https://en.wikipedia.org/wiki/International_Standard_Book_Number">international standard book number</a>" or ISBN. Nowadays, books are issued with 13 digit ISBNs, but in the past ISBNs had 10 digits. The ISBN can almost always be found as the numerical part of the bar code located on the back cover, or on the first page or two inside the book. I generally use <a href="http://www.amazon.com">Amazon.com</a> to find the ISBN corresponding to a book.</p> |
| 17 | +<h2>How to use the DOI or ISBN in your document</h2> |
| 18 | +<p>Now that you know where to find unique identifiers for papers and books, my suggestion is to just paste or type in the unique ID anywhere you want to cite something. For example:</p> |
| 19 | +<blockquote> |
| 20 | +<p>Using Smith's model [<strong>10.1063/1.4826202</strong>] we estimated the output power density of the device to be...</p> |
| 21 | +</blockquote> |
| 22 | +<p>Where the bolded number (10.1063/1.4826202) is the DOI for the paper being cited. Another example separating multiple citations with commas:</p> |
| 23 | +<blockquote> |
| 24 | +<p>Goano has presented a similar derivation for the complete and incomplete Fermi-Dirac integrals [<strong>10.1016/0038-1101(93)90143-e</strong>, <strong>10.1145/210089.210090</strong>].</p> |
| 25 | +</blockquote> |
| 26 | +<p>Again, the DOIs in the above example are 10.1016/0038-1101(93)90143-e and 10.1145/210089.210090.</p> |
| 27 | +<p>Eventually the manuscript will reach a point where you are ready to build the bibliography. If you are using reference management software, the DOI or ISBN can be used to identify each reference in the bibliographic database. If you've been using unique IDs in the body of the manuscript, it is trivial to apply your reference manager to build the bibliography with minimal tedium.</p></summary></entry><entry><title>Naming data files revisited</title><link href="https://jrsmith3.github.io/naming-data-files-revisited.html" rel="alternate"></link><updated>2015-03-22T00:00:00-04:00</updated><author><name>Joshua Ryan Smith</name></author><id>tag:jrsmith3.github.io,2015-03-22:naming-data-files-revisited.html</id><summary type="html"><p>I wrote a <a href="http://jrsmith3.github.io/naming-data-files.html">post about naming data files</a> awhile back. Also, yesterday I found that <a href="http://conda.pydata.org/docs/intro.html#package-naming-conventions">conda canonical filenames</a> <a href="https://github.com/conda/conda/issues/974#issuecomment-61172554">cannot support semver version strings</a> because the dash ("-") character is disallowed in the string.</p> |
3 | 28 | <p>This issue is perennial: everybody reinvents the wheel of coming up with a file naming scheme for their system. Look, the goal of a file naming convention is to balance a few competing requirements:</p> |
4 | 29 | <ul> |
5 | 30 | <li>Human legibility. People should have a fighting chance of understanding the file contents by reading the filename.</li> |
|
0 commit comments