LaTeX with Overleaf

See the Overleaf Guide on Sharing a Project for step-by-step instructions on 

• How to share a link to view or edit a project
• How to share a project with collaborators

There may be occasions where users are collaborating across different LaTeX platforms due to preference or accessibility reasons.

In this case, LaTeX file sharing can be facilitated through the Overleaf Git-Bridge, an Overleaf integration with GitHub.com.

See the Overleaf guide on Using Git and GitHub for more details.

 

Requirements on the collaborator using Overleaf.com:

• Subscription Overleaf.com account

• Free GitHub.com account

 

Requirements on the collaborator using local LaTeX or text editor:

• Free GitHub.com account

• LaTeX editor that meets accessibility requirements, or any accessible text editor if LaTeX is not required to be compiled (e.g. Student O could compile the LaTeX code and share the pdf via GitHub repository.)

Workflow for Collaboration between Overleaf and another LaTeX platform

Collaborator on Overleaf.com:

1. Go to Overleaf.com > Account > Account Settings

 

 

2. Select “Link to your GitHub account”

3. Authorize Overleaf GitHub Sync by clicking “Authorize overleaf”

4.  Confirm access with GitHub password 

5. Establish a private repository on GitHub.com with LaTeX files (e.g. project or assignment files provided by an instructor)  This example repository is named gitbridge

6. On Overleaf.com > New Project > Import from GitHub

 

7. Select the repository to Import to Overleaf

8.  Work on LaTeX files in Overleaf.com.

9. When ready to share work with collaborators, go to Menu > Sync - GitHub.  

10. Push Overleaf changes to GitHub

11. 

 

11. Go to GitHub.com repository Settings > Manage access > Invite a collaborator to share your files with a collaborator

 

Collaborater using another LaTeX platform:

1. A collaborator using a different platform can accept the emailed invitation to collaborate on their free GitHub.com account.

2. The collaborator can click Code > Download ZIP files from GitHub, or Open them with GitHub Desktop (free) without knowledge of Git version control commands or bash shell.

 

3. Extracting the downloaded zip file is a commonplace practice.  The student can unzip and edit LaTeX files with an accessible LaTeX editor or text editor.  Alternatively, the student could use GitHub Desktop.

4. On GitHub.com gitbridge repository, Add file > Upload files > Choose your files to upload files (with same filenames).  Now, the files are ready for your collaborator!

Accessible LaTeX Editors

• https://services.szs.kit.edu/szslatex/ -  a graphical interface for MikTeX https://miktex.org/ 

• Linux: SZS LaTeX Editor https://services.szs.kit.edu/szslatex/ -  a graphical interface for PDFLaTeX tool

• Suggestion instructions for installing PDFLaTeX on Ubuntu:

  • Install the TexLive base sudo apt-get install texlive-latex-base

  • Also install the recommended and extra fonts when trying to use pdflatex on latex files with more fonts.

    • sudo apt-get install texlive-fonts-recommended

    • sudo apt-get install texlive-fonts-extra

  • Install the extra packages, sudo apt-get install texlive-latex-extra

  • Once installed as above, you may be able to create PDF files from latex sources using pdflatex latex_source_name.tex

Collaboration tools

• One version of your project accessible to collaborators via a shared link or email invitation
• Easily select the level of access for collaborators (view, edit, or owner access)
• Real-time commenting speeds up the review process
• Tracked changes and full history view help to see contributions from collaborators
• Labels help to organize and compare different versions
• Chat in real time with collaborators right within the project