Difference between revisions of "Overleaf instruction"

From Hall A Wiki
Jump to: navigation, search
Line 1: Line 1:
To edit or make comments in the latex source, '''signup and signin''' at https://www.overleaf.com, then go to site with a good browser (latest firefox or Chrome is recommended)
+
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
  
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.
+
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)
  
all edits are auto saved, there is labeling and version control ability built in
+
You should have a link in email once you are given access to a project, click on it to add it into your projects
  
* detailed instructions for editing and commenting
+
* 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.
 
** We use pdflatex, so don't use any eps for figures, use pdf instead or png,jpg if you have to.
 +
 +
* edit using git
 +
** click "share" on the project webpage to get its git link, then clone,edit,push just like any git repository.
 +
** 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
 +
 +
* 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 "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
 
** click "+" to make comment at the current location in tex file, you can also delete comments once it's fixed
Line 16: Line 23:
 
** check out its help page
 
** check out its help page
  
ask Zhiwen Zhao zwzhao@jlab.org for any question
+
Ask Zhiwen Zhao zwzhao@jlab.org for any question

Revision as of 23:45, 22 March 2017

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)

You should have a link in email once you are given access to a project, click on it to add it into your projects

  • 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.
  • edit using git
    • click "share" on the project webpage to get its git link, then clone,edit,push just like any git repository.
    • 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
  • 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
    • 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 long.
    • add a label after you have some major edit by "history & revisions"
    • check out its help page

Ask Zhiwen Zhao zwzhao@jlab.org for any question