Chapter 3 Overleaf

Overleaf is a free online LaTeX editor, meaning it helps you write text using LaTeX to determine how your document will look. In this chapter we will introduce you to Overleaf and get you set up to create a document.

Learning Objectives: 1. Explain what Overleaf is, 2. Understand the Benefits of using Overleaf, 3. Create an account with Overleaf. 4. Search through the templates available on Overleaf, 5. Start working on a template for a scientific  preprint for arXiv

Since LaTeX can be pretty tricky, Overleaf can be super helpful!

LaTeX on it’s own can be quite a challenge, Overleaf makes LaTeX much more approachable.

As a LaTeX editor, Overleaf shows you what the result of your LaTeX tags will be, suggests possible LaTeX tags, and provides you with helpful guidance. We will learn more about each of these in this overview.

3.1 Benefits of Overleaf

There are other LaTeX editors, but Overleaf is a really nice option for a number of reasons:

  1. It is free!
  2. It’s online and requires no installations.
  3. It makes it much easier to write using LaTeX.
  4. It can continually show you a preview of your final document.
  5. It makes it easy to collaborate with others.
  6. There is lots of online support.
  7. It can sync with GitHub or Dropbox (if you pay for a paid plan).

Summary of the benefits of Overleaf.

3.2 Getting Started

To start, you need to make an account on Overleaf.

To do so, you can go to https://www.overleaf.com/register in your browser.

There are several ways to register:

  1. Register with an IEEE account
  2. Register with your Google account
  3. Register with your ORCID account
  4. Register with a different email address
  5. Log in with an institution. This is worth checking in case your university has a license, as this may provide you with more features.

The free version only allows you to have one collaborator on a project, so collaboration is more limited. However, you can still benefit from many of the other features. Note that students can receive a discount as well.

If possible, it may be worth seeing if your institute would get an organizational license.

There are several ways to register an account on Overleaf.

3.3 Working with Templates

Overleaf is organized with projects. When you create a project, you can start from scratch or start from a template.

New Project Button.

Let’s start with a template to help us better understand the features of Overleaf. We can search through all the templates by clicking on “View All” button of the project menu. We can also click on the “templates” tab to get to the same template search page.

Templates tab shows many differnt kinds of templates possible including calenders, letters, CVs, books, and more.

You can see that there are many templates to choose from! There are templates for writing a letter, writing a thesis, writing a CV, writing a book and more.

Tip! - If you need to write a thesis or you have a student that needs to write one, check to see if your university or department has a LaTeX template that you can use to help everyone save time on formatting and spend more time writing the content.

Let’s search for a term, such as “preprint” to see if the templates for preprints.

You will see that a few of the templates have a blue “official” tag. This is the best option if you find one for the publisher that you are interested in.

The official tag for some templates indicates that the publisher recoginizes and approves of the template as the official tempalte to use for submissions.

We will use a template for arXiv.

You can go to this link to start with the same particular template to create a manuscript for arXiv.

Click the “Open as Template” button to get started.

Click the open as template button to get started with a template.

3.4 Viewing documents

Now that we have opened a template, we will start by understanding how we can view our work on Overleaf.

Overleaf easily shows you what the rendered version of your text will look like, taking into account the LaTeX tags that indicate how the text should be arranged and styled. The default view is to see the raw text (aka source text) on the left and the rendered/compiled version on the right.

The default view in Overleaf is to have raw text shown on the left, while the compiled text is shown on the right.

You can also change the view to several other options:

The layout tab alows you to change the view.

If you are using the default view and you want to see what the file looks like in the rendered form for the same location as that of the source text of the editor, you can click on the arrow (with the arrowhead facing to the right) in between.

The layout tab alows you to change the view.

To do the opposite and go to the location in the source text where you are currently viewing in the rendered text, click the arrow button facing the source text editor.

To update the location of the source text to that of the rendered view, press the arrow facing left towards the source editor. If you make a change in the source and want to see how it changes the look of the file, you need to press the “Recompile” button.

It is a good idea to press the “Recompile” button frequently, so that you can identify any errors more easily. If you wait too long to check, then you will have more new changes to look through to try to understand the error.

To update rendered file with your changes, press the recompile button.

3.5 Making changes

Now let’s try a simple change to start getting used to writing with LaTeX.

First we will change the title, which is currently “Predict future sale”. We can search the source editor text by clicking on the editor pane and using the search and find keyboard shortcut (control and the F key). If we type “Predict future sale” in the text box, we find it on line 19 following \title.

We can search the source text by click on the editor pane and typing the shortcut keys for find functions (control F).

We can now replace the text with our own title. Be careful to make sure that the brackets are closed around the replacement text. Here we replace it with “New Title.”

Changing the title to New Title.

Now we can click the “Recompile button” to see the results.

To update rendered file with your changes, press the recompile button.

After overleaf has finished compiling, you can see that the title has been changed.

The resulting new title within the document.

Congratulations! You just made your first edit in Overleaf. In the next chapter, we will take a deeper dive into editing documents.

3.6 Conclusion

We hope that this chapter has given you some more knowledge about what Overleaf is and how it can help you write documents, as well as the benefits of using it.

Here are some of the major take-home messages:

  1. Overleaf is a collaborative LaTeX editor, that helps you write documents using LaTeX.
  2. Benefits of Overleaf include: it’s free (although you can pay for more features), it’s online and requires no installations, it shows you a preview of how your document will look, it makes it easier to collaborate with others.
  3. To use Overleaf you need to make an account first, which takes just a few minutes.
  4. There are many templates that you can use to write many different types of documents, including journal articles, CVs, graphics, and more!
  5. Some journals have even vetted templates to be their official template, look for the blue “official” tag.
  6. It’s a good idea to keep pressing the “recompile” button often as you make changes so that you can more easily see what might be causing an error if something goes wrong.