Overleaf instruction

From Hall A Wiki
Revision as of 15:53, 30 October 2018 by Zwzhao (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

(note as 2018/10, overleaf is moving from v1 to v2, all instruction below is for v1 type document)

overleaf.com is an online collaborating tool for latex. Several persons can edit at the same time, everyone can see all changes in real time. All edits are auto saved, there is labeling and git version control ability built in

To edit or make comments in the latex source, signup and signin at https://www.overleaf.com with a good browser (latest firefox or Chrome is recommended), then email Zhiwen Zhao zwzhao@jlab.org with your overleaf account email.

After Zhiwen Zhao give you access, you should have a link in a email for each document, click on it and it will be added into your projects in overleaf and you can start to edit

  • general rule for our document
    • We use pdflatex, so don't use any eps for figures, use pdf instead or png,jpg if you have to.
  • instructions for web editing and commenting
    • click "project" to see file panel, then choose a tex file to edit or comment, choose a dir to upload file into it, drag and drop to move files and dirs around
    • click "+" to make comment at the current location in tex file, you can also delete comments once it's fixed
    • Use "Source" in editing instead of "Rich text"
    • "copy,cut,paste" in "Edit" editor menu and right-click menu don't work yet, use browser edit menu or keyboard short Ctrl-C,Ctrl-X,Ctrl-V (win) Command-C,Command-X,Command-V (mac) instead
    • clicking on some texts of the preview panel will bring up the matching latex in the edit panel. right click on some texts of the edit panel and choose "position in preview" will bring up the matching place in the preview panel
    • If the project is big, let "preview" stay at "manual", NOT at "auto", then click "refresh preview" to compile, any error will show up for you to debug.
    • If "refresh preview" gives no error, you can click "pdf" to download a pdf of the current version. This is better way to view the doc instead of preview if the document is very large.
    • add a label after you have some major edit by "history & revisions"
    • check out its help page
  • instructions for using git
    • click "share" on the project web page to get its git link, then clone,edit,push just like any git repository.
    • for protected project which needs overleaf useremail and password to access, git version >= 1.8.3 is needed. The default version in centos7 git-1.8.3 will work, but the default version in centos6 git-1.7.1 will fail with a 401 Unauthorized error, you can use the higher version at /apps/bin/git if your computer is in jlab network
    • it only has the master branch, no other branch is allowed
    • a labeled web edit will show up as a commit in git history, many unlabeled web edit will be combined into one commit in git history once someone did a git fetch
    • you can also use github linked to overleaf [1], but you lose privacy this way

Ask Zhiwen Zhao zwzhao@jlab.org for any question