Editing CommunityData:Zotero

We use Zotero for citation management!

== Install Zotero ==

You should register for a free Zotero account if you don't already have one. We recommend [https://www.zotero.org/download/ installing Zotero] on your desktop as well as the [https://www.zotero.org/download/connectors "connector" for your browser]. The browser plugin is used to quickly add citations from websites instead of manually entering all of the information.

If you were using Zotero before, you should upgrade to Zotero 5.0. You will need to download this from https://www.zotero.org because it was released recently and its not in the distributions yet. It's important to be running the new version. This will break support for BetterBibLaTeX but is also fixes most of the bugs that required this in the first place.

== Group Directory ==

We have a group directory that we use to collect citations for all shared projects: [https://www.zotero.org/groups/163394/community_data_science_collective the Community Data Science Collective Zotero repository]. The directory is private, so ask a member of the collective to invite you.

The directory is organized by ''collections'' (visualized), with each folder aggregating citations for a particular project or topic.

In addition to the folders for individual researchers, there are 2 general folders:
* CDSC Publications: For publications by all CDSC members.
* Duplicate Items: Identifies any duplicates across the group directory. When deciding which duplicate to keep and which to merge, simply choose whichever option contains more information.

== Adding and Organizing References ==

The process to add something cleanly is complicated but should always include the following steps: 

===Before you add a source===
# '''Sync your local Zotero repository''' (by clicking the little green symbol that looks like a recycle sign in the top right). This may not be necessary all the time, but it's better to do it!
# '''Check to see if the thing you're about to add is already in the CDSC shared folder''' by clicking on the top level of the shared group and searching. If it is already there, just drag it into your new subfolder for your project. If it's not, click back on your sub-folder and add it.

===Once you've added a source===
# '''Once you've added a source, change the title to sentence case.''' You can do this by: (a) ''Right clicking on Title → Transform Text → Sentence Case'' (b) you will then need to capitalize any proper nouns (e.g., Scratch, Wikipedia) as well as anything immediately following a ":". This is important because software like BibTeX/BibLaTeX can change from "Sentence case" to "Title Case" automatically, but not the other way around. APA 6 requires sentence case. 
#* Do make sure that any proper nouns are still capitalized after converting the title to sentence case. (EX: places like "United States," websites like "Wikipedia," apps like "Airbnb")
# '''Review and revise bibliographic record as-needed.''' This varies a bit by publication type and by the data source you've imported the bibliographic metadata from, but here's a minimal set of details that you should check to make sure have imported correctly:
#* Item Type: This should match the sort of thing you're importing, such as a book, journal article, magazine article, blog post, etc.
#* Title: The title of the piece itself.
#* Authors, editors, translators: Imported metadata is often pretty messy for these. Do your best to make them right. Wherever possible, defer to the apparent preferences/conventions adopted by authors (e.g., capitalization, spellings, name changes, etc.). When names include characters or diacritics that are not part of the English language, do what you can to incorporate the correct, original characters (copy/paste is your friend here).
#* Publication: For journals, magazines, newspapers, etc.
#* Volume + Issue: Usually only applies to periodicals.
#* Pages: For periodicals, book chapters, or other selections.
#* Date: This is also often a little weird in the metadata. Should match the publication date used by the publication. For books and journals, year alone is enough. For everything else, there should be a ''yy/mm/dd'' (or whatever format) entry.
#* DOI: (Digital Object Identifier): Ensure that there's a DOI for your entry if it's available. In general, this applies to journals and conference proceedings. Some publishers and conferences (like AAAI publications which publishes ICWSM) do not have DOIs but these are extremely rare. If your publication does not have a DOI, it needs to have a URL because APA 6 requires one or the other... which brings us to:
#* URL: Web addresses should reflect canonical sources (publisher websites, institutional repositories, pre-print servers, etc.) to the extent possible. Personal websites are fine if that seems like the best option (i.e., there's not an archival version anywhere else). Sometimes URLs include DOI information and, if DOI metadata was missing otherwise, you should extract DOIs in this way.
#* Publisher: According to [http://blog.apastyle.org/apastyle/2010/01/the-generic-reference-where.html APA 6 style] we should drop common words like "Press," "Publisher," "Inc." as well as first names (i.e., just Wiley, not John Wiley Inc.)
#* Place: [http://blog.apastyle.org/apastyle/2010/01/the-generic-reference-where.html APA 6 style] requires "City, State" within the USA and "City, Country" outside. So, it's "New York, New York" for the ACM and "Cambridge, UK" for University of Cambridge Press.
# '''Remove anything in the "Extra" field''' unless it's something you want to be printed every time. Sometimes things like "ⓒ JSTOR" sneaks in.
# '''Make sure that there's a clearly named PDF attached.''' You can attach PDFs by: ''Right-click on the item → Add attachment → Attach Stored Copy of File.'' One the PDF is uploaded, you should rename the PDF to ''Name-YYYY-Short_title.pdf''. After your bibliographic record is cleaned up and accurate, you can do this by: ''Right click on PDF → Rename File from Parent Metadata''
# '''Ensure that there aren't extraneous files attached.''' Just delete anything that doesn't look critical or useful. For example, when using the browser plugin, sometimes a 'Snapshot' will be attached which is just a link to the website you sourced from (which should be in the URL field anyways). Anything left attached will show up in fulltext searches, which can be a reason to either leave something or remove it depending on what it is.

== Tips and Tricks ==

* In Zotero, folders are not like traditional folders. They are like tags. Do not add things if they are already there!
* Holding down <tt>Alt</tt> is extremely useful! It will show you which folders the selected item is in!
* When you're done adding a bunch of things, look at the ''Duplicate'' pseudo-folder underneath the ''Community Data Science Collective'' folder.
* Do not download the [https://github.com/beloglazov/zotero-scholar-citations Google Scholar add-on]. This adds citation data to the "extra" column for all papers in Zotero which shows up in some types of reference lists and is a huge pain to undo.
** If you had already imported something from Google Scholar, it is usually easier to find the publication online again and re-import the information using the browser connector than to find and input the missing information manually.
* Note that every time you import a new publication, you will automatically scroll to the newly-added citation. If you are updating information for many citations, keep track of the order so that you don't miss any as you add new citations!

== Exporting ==

If you want to create a BibTex file from the citations in your folder, right-click your folder in the desktop application, and click "Export Collection". Select BibLaTeX as the format and save to a location of your choice. Be sure to rename the file <code>refs.bib</code> so that it works with the [[CommunityData:Build papers|paper-building workflow]]. 

You'll need make, our [[CommunityData:TeX|TeX]] setup to make this work. 

If you are using the latest versions of mako's templates[http://projects.mako.cc/source/?p=latex_mako] you should be using BibLaTeX.

You should see these lines: 

<code>
\usepackage[natbib=true,style=apa,backend=biber]{biblatex}                                                                                                                                                       

\addbibresource{refs.bib}   
</code>

That should be it! You should be ready to go! Test it out by running.
<code> make refs.bib </code> and <code> make pdf </code>