CommunityData:Build papers: Difference between revisions
From CommunityData
No edit summary |
|||
| Line 10: | Line 10: | ||
== Style notes and more details (add as needed) == | == Style notes and more details (add as needed) == | ||
* For sanity, it's good to create sub-directories within the paper directory to store things like | * For sanity, it's good to create sub-directories within the paper directory to store things like knitr data and figures. For most of our existing projects these sub-directories have informative names like <code>knitter_data</code> and <code>figures</code>. | ||
* Don't edit <code>refs-processed.bib</code> by hand. This is a file that the Makefile builds every time it compiles the paper. If you have some reason to edit the bibliography by hand, edits <code>refs.bib</code>, but do so at your own risk since collaborators and other Community Data folks may come by your repository and try to build the paper by downloading a new bib file from Zotero unless you tell them otherwise! | * Don't edit <code>refs-processed.bib</code> by hand. This is a file that the Makefile builds every time it compiles the paper. If you have some reason to edit the bibliography by hand, edits <code>refs.bib</code>, but do so at your own risk since collaborators and other Community Data folks may come by your repository and try to build the paper by downloading a new bib file from Zotero unless you tell them otherwise! | ||
Revision as of 19:20, 25 August 2016
Basic steps (quick and dirty version)
- Export a bib file from Zotero into the directory where you're building your paper. Call the file
refs.bib - The first time you're building the paper, you can just run
makeormake all. After that, you probably want to runmake clean; make all. This should work whether you're using an .Rnw (knitter) or .tex (LaTeX) file.
If you're using ShareLatex for your papers, that's great. The Best Practice is still to update the bibliography in Zotero, then export from there. Ideally, export into refs.bib and then upload that to ShareLatex so that the paper directory in our shared git repositories are up-to-date!
Style notes and more details (add as needed)
- For sanity, it's good to create sub-directories within the paper directory to store things like knitr data and figures. For most of our existing projects these sub-directories have informative names like
knitter_dataandfigures. - Don't edit
refs-processed.bibby hand. This is a file that the Makefile builds every time it compiles the paper. If you have some reason to edit the bibliography by hand, editsrefs.bib, but do so at your own risk since collaborators and other Community Data folks may come by your repository and try to build the paper by downloading a new bib file from Zotero unless you tell them otherwise!
