Skip to content

Collaboration Spaces

ito-ra1 edited this page Jan 10, 2022 · 37 revisions

Diagram shows how Overleaf is synced with a Zotero library and a GitHub repository Figure 1: Overleaf is linked with a GitHub account where changes can be pushed and stored. Bibliographic metadata is pulled from a dedicated Zotero user library (hmets).

Zoom

Room: HMetS Writing Group

  • Meeting ID: 833 6965 6006
  • Password: 588758

Overleaf

Using Overleaf with the HMetS Writing Group: Go to Overleaf paper

Before you can edit the document, Overleaf requires you to sign up with or login with a (free) account. Once you're registered, you'll be able to see and edit the file immediately--it's a "secret editing link": anyone who has it may edit.

LaTeX Cheat Sheet (PDF, Overleaf) with the basic markup (= all you'll need) to use LaTeX on Overleaf.

Overleaf and LaTeX User Manual (at Overleaf.com)

1. The text editing interface

Screenshot shows the Overleaf editing interface Figure 2: The Overleaf editing interface is split into three sections. From left to right: The left-hand navigation panel, the editing window, and the PDF viewer. Changes to the text will be reflected in the PDF after recompiling the document.

Screenshot with arrows and text shows interface functionality: Find code passage in PDF text and vice-versa Figure 3: To find a code passage in PDF text, and to find a PDF passage in the code, use the arrows located in the divisor between both screens.

Screenshot of Overleaf editor's left-hand panel: Files in project (top); Document outline (bottom)

Figure 4: Overleaf editor's left-hand panel: The top half has a menu of all files in the project (top). The bottom half shows an outline of the document's section headers.

Screenshot of Overleaf editor shows how to toggle between code view and rich text format view Figure 5: It is possible to toggle between the source code view and a rich-text editing mode. Please note that code is commented out with '%'. For this reason, in common usage, the percent sign must be preceded by an escape character '\'

2. Adding Comments

Overleaf screenshot with explanatory text: How to add Google Docs-like comments into text (code view only) Figure 6: Highlight a section of the text to add comments. This function is only available in code-view.

3. Saving Changes

Screenshot showing Overleaf text editing interface and change history Figure 7: All changes are saved automatically to Overleaf (like Google Docs). To view named versions and all previous changes, select 'History' on the top right corner of the interface.

Diagram with screenshots showing how to save changes in GitHub Figure 8: If you also would like to save a version to GitHub, you can do so through the Menu on the top left corner of the interface. Under 'Sync', select GitHub, 'Push Overleaf changes to GitHub' and then commit your changes.

Zotero

Screenshot shows how Overleaf syncs from Zotero library Figure 9: Overleaf and Zotero are synced: Overleaf grabs the project's bibliographic metadata from our dedicated Zotero account, hmets. The resulting .bib file is built into the LaTeX (.tex) file via BibLaTeX, and it can be updated with new changes to the library with one click.

Bibliography management

To add citations to the text, you have a few options:

  1. Log in to the Zotero account directly and add the records you need to the user library "My Library" (not the group library). After that, update the references.bib file in Overleaf for your references to appear in the \cite{} drop-down menu.
  2. If you prefer, you can leave a placeholder in the text where the citation should go, highlight it, and add a note with the reference. Someone else (most likely Alicia) will add the reference and format the citation as soon as they see it.
  3. Otherwise, you can just email your text (in any format) to Alicia at 'ito-ra1' at 'oceannetworks' dot 'ca' and she'll format and add it to the section where it belongs, including references/citations.

If you do create any new records in Zotero, please try to add as much information as possible to each record you create. For best results, you can import records using the “Add By Identifier” function. Zotero can use various identifiers to harvest the metadata from library databases (see Screenshot 1). At a minimum, please enter a year, author and title so that Alicia can look up the reference and complete the record.

: Browser view of the “Add By Identifier” function in Zotero (browser view) pops up an input field for any of the following identifiers: URL, DOI, PMID, arXiv ID or ISBN Figure 10: Browser view of the “Add By Identifier” function in Zotero (browser view). The 'magic wand' button pops up an input field for any of the following identifiers: URL, DOI, PMID, arXiv ID or ISBN.

GitHub

Overleaf is synced with the Harvestable Metadata Services Development repository on GitHub. Every commit from Overleaf is saved here (view history to find older versions).

SharePoint

Sharepoint Folder containing: