diff --git a/docs/01-intro.md b/docs/01-intro.md
index 19ad24d0..82567308 100644
--- a/docs/01-intro.md
+++ b/docs/01-intro.md
@@ -14,20 +14,20 @@ Overleaf is a very useful tool for collaborative scientific writing. It has an a
The course is intended for scientific writers who might be interested in learning how to automate some of their writing formatting/layouts.
-
+
## Curriculum
The course covers basic information about why LaTeX can be useful, how to get started in Overleaf using LaTeX with a template, how to work with a team on Overleaf, and what to do when you encounter problems.
-
+
## Objectives
-
+
diff --git a/docs/02-latex.md b/docs/02-latex.md
index e7f86942..0c59e30f 100644
--- a/docs/02-latex.md
+++ b/docs/02-latex.md
@@ -3,11 +3,11 @@
You may or may not have heard people talking about [LaTeX](https://www.latex-project.org/about/) (pronounced '/ˈlɑːtɛx/' LAH-tekh or '/ˈleɪtɛx/' LAY-tekh), which is not to be confused with the the material latex (pronounced '/ˈleɪtɛks/' LAY-tekhs). In this course we will explain what LaTeX is and how it came to be.
-
+
## Learning Objectives
-
+
## Document Preparation System
@@ -20,7 +20,7 @@ Typesetting determines how text looks and where it is located in a document when
Although LaTeX has a reputation for being quite tricky, it is very powerful in enabling users to create documents with complex and customized text formatting and layouts much more easily than doing so with systems like Microsoft Word.
-
+
@@ -53,13 +53,13 @@ Tex is named as an abbreviation for the Greek word [τέχνη (ΤΕΧΝΗ techn
Typesetting has origins in how documents used to be printed using manual stamping mechanisms, where someone would provide the contents of the text in writing by hand that would be translated to a version with the intended layout and style for printing.
-
+
Overtime this process got replaced by digital options and eventually resulted in the concept of WYSIWYG (What you see is what you get), where programs like Microsoft Word let you interactively work with the typesetting of a document as you write the content.
-
+
When you use a program like Microsoft Word, you are essentially giving it two sets of directions simultaneously, one which is the content of the text, and one which is the style and layout of the text.
@@ -81,7 +81,7 @@ In HTML we could instead use `` at the beginning of the text we want to bold,
**LaTeX:**
Just like in HTML, LaTeX also uses text around the actual content text to describe how to produce the final product. In this case, we would indicate that we want bold text using a tag `\textbf` with brackets around the text we want to change like so: `\textbf{bold text}`.
-
+
As you can see, LaTeX will feel a bit different from writing in Microsoft Word, as we will be using text tags to define how we want the content text to look.
@@ -96,7 +96,7 @@ Now that you are a little more clear about what LaTeX is, it might be easier to
5) You can add languages with different alphabets or mathematical notation with much more ease than with traditional text editors
6) You can collaborate with people who use LaTeX more easily
-
+
## Conclusion
diff --git a/docs/03-overleaf.md b/docs/03-overleaf.md
index ea9334a0..26ef4d9b 100644
--- a/docs/03-overleaf.md
+++ b/docs/03-overleaf.md
@@ -4,13 +4,13 @@
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.
-
+
Since LaTeX can be pretty tricky, Overleaf can be super helpful!
-
+
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.
@@ -27,7 +27,7 @@ There are other LaTeX editors, but Overleaf is a really nice option for a number
1) It can sync with GitHub or Dropbox (if you pay for a paid plan).
-
+
## Getting Started
@@ -49,19 +49,19 @@ The free version only allows you to have one collaborator on a project, so colla
If possible, it may be worth seeing if your institute would get an organizational license.
-
+
## Working with Templates
Overleaf is organized with projects. When you create a project, you can start from scratch or start from a template.
-
+
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.
-
+
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.
@@ -77,7 +77,7 @@ Let's search for a term, such as "preprint" to see if the templates for preprint
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.
-
+
We will use a template for arXiv.
@@ -88,7 +88,7 @@ You can go to this [link](https://www.overleaf.com/latex/templates/style-and-tem
Click the "Open as Template" button to get started.
-
+
## Viewing documents
@@ -98,30 +98,30 @@ Overleaf easily shows you what the rendered version of your text will look like,
-
+
You can also change the view to several other options:
-
+
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.
-
+
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.
-
+
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.
-
+
## Making changes
@@ -131,20 +131,20 @@ First we will change the title, which is currently "Predict future sale". We can
-
+
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."
-
+
Now we can click the "Recompile button" to see the results.
-
+
After overleaf has finished compiling, you can see that the title has been changed.
-
+
Congratulations! You just made your first edit in Overleaf.
In the next chapter, we will take a deeper dive into editing documents.
diff --git a/docs/04-writing.md b/docs/04-writing.md
index fedabc2a..53140f08 100644
--- a/docs/04-writing.md
+++ b/docs/04-writing.md
@@ -3,7 +3,7 @@
Now that you know the advantages of using Overleaf and have started working with a template, we will now discuss more about how to make additional modifications to your document.
-
+
## LaTeX Basics
@@ -13,7 +13,7 @@ Since we are working with a template, it isn't necessary to learn everything the
At the top of the template you will notice `\documentclass{article}`.
-
+
This specifies general typesetting information about the type of document that we intend to make. For example, it often specifies font size, the overall layout of the text, and alignment of various features of the text. Since we are writing a scientific article, the specification here is `article`.
@@ -25,7 +25,7 @@ To learn more about document classes see this [documentation link](https://libgu
Next you will see that `\usepackage{}` is repeated several times with different information in the brackets:
-
+
We will refer to these tags with brackets such as `\usepackage{}` as **commands** from now on (as this is what the are generally referred to) and they cause a change to either the text within the brackets or the overall document.
@@ -46,30 +46,30 @@ If you do not close a set of brackets you will get an error, so be careful about
As we scroll down the template, we next see the `\title` command that we previously worked with when we modified the text within the brackets to change the title.
-
+
Then we see the `\author` command, which adds authors to the paper. These will be formatted in the way that is shown on the template. When you see `\\` two backslashes, this indicates that the line is finished and a new one is to be made. For tables or formatting like the authors, it should work well, but it is best to **[avoid](https://tex.stackexchange.com/questions/225893/what-does-double-backslash-in-latex-mean)** using this for line breaks within the paragraphs that you might include in the paper.
-
+
We also see another command `\textttt{}` used within the `\author{}` command to change the text to typewriter font.
-
+
You may also notice `%% examples of other authors` is in green and does not show up in the rendered document. This is what is called a **comment** and it can be used to write notes about the material.
-
+
In the author section, the `\And` allows for additional authors to be added. It must be used between each author listing.
-
+
Finally, the author section needs to be completed by closing the brackets.
-
+
### Formatting the Document Body
@@ -79,7 +79,7 @@ The command `\begin{document}` enables us to format text for the body of the art
The `\maketitle` will add the title the page where the `begin{document}` command was used. If it is placed before `begin{document}`, the title and authors will show up on a separate page. You can test moving this command around to see how the document changes.
-
+
### Abstract
@@ -100,16 +100,16 @@ You may notice `\lipsum[]` is used to create random chunks of text. The number w
In the template you can see how these are formatted:
-
+
-
+
You can specify if you want sections to be not be numbered when using an asterisks `*` between the command name and the brackets `section*{}`.
The `\paragraph{}` command works similarly, but without numbering. The text within the brackets is an optional word or phrase that will have bold font to start the paragraph. You can also leave it empty.
-
+
diff --git a/docs/05-elements.md b/docs/05-elements.md
index caa6f84d..04035e03 100644
--- a/docs/05-elements.md
+++ b/docs/05-elements.md
@@ -5,7 +5,7 @@ Figures & tables & citations, oh my!
Now that you know some of the basics about how to add text to a template, let's look at adding other elements that are important for scientific communication, like adding figures and images, adding tables, and adding references/citations. In this next chapter, we will introduce how to do this in LaTeX/Overleaf.
-
+
You will notice that the template has a few examples of each of these elements that we will walk through now.
@@ -17,7 +17,7 @@ Like you did while creating the body of the document, you will use the `\begin{}
The first figure in the template is a box created in LaTeX, so we will instead focus on the second figure. You might notice that in addition to the `\begin{figure}` and `\end{figure}` commands, there is a `\centering{}`command, which will align the figure to the center of the page. The `includegraphics{text.png}` portion of the code actually adds the figure into the document.
-
+
Note that comments with one percent sign can be used after code - thus the `% picture` is just telling you that this part of the code is adding a picture. People use different numbers of percent signs based on preference and convention, but just one percent sign is sufficient to turn anything following that into a comment.
@@ -25,11 +25,11 @@ Note that comments with one percent sign can be used after code - thus the `% pi
You may notice on the left side of the template in Overleaf that there are a few files listed, including the name of the image file used in the code for the figure: `test.png`. The `template.tex` file is the file we have been working in.
-
+
If you click on the name of the image file you will see a preview of the image.
-
+
**What are these other files?**
@@ -43,11 +43,11 @@ The **`arxiv.sty`** file is a style file that contains code more specifically st
To upload an image file to add a new figure, you can click on the new file button, which is the icon that looks like a piece of paper with the right upper corner folded.
-
+
Then select the upload button to drag and drop a new image file from your computer.
-
+
The next step to add this new figure to your document, is to add the code above but modified so that the name of the image file matches the name of the file you uploaded.
@@ -63,16 +63,16 @@ As when adding figures, you need the `\begin{}` and `\end{}` commands in your fi
Here is all of the code to create the following table. We will go through each command and explore what it does to create the table.
-
+
-
+
We can add a caption using the `\caption{}` command. The table number will automatically be determined by the order of the tables. As before with the figure, the `\centering` command will then align the resulting table to be centered.
-
+
@@ -80,50 +80,50 @@ We can add a caption using the `\caption{}` command. The table number will autom
To create the table in the template, we will first indicate how we want the table arranged using the `tabular` environment. The command `\begin{tabular}{lll}` indicates that we will have three columns that are left aligned.
-
+
- The `\toprule` command adds a solid line at the top of the table. If you add this command again you will see two lines - test it out to see how it works!
-
+
- The command `\multicolumn{2}{c}{Part}\\` indicates that will will merge some columns together to create a "multicolumn" in this case the `{2}` means we will merge together 2 columns, the `{c}` indicates that it will be center aligned and the `{Part}` is the text we want for this. We need the `\\` to finish that row, otherwise "Part" will end up on the next row.
-
+
The `\cmidrule` command adds the line or "rule" under the multicolumn that says "Part". This command creates lines that are not the full width of the table. The `(r) {1-2}` indicates that the line should be trimmed on the right side to leave a gap after the span of 2 column widths.
-
+
Now we are ready to put some text within our table cells. We can simply type the words with an `&` in between the text for each cell to indicate where the column breaks are. The `\\` indicates when we are done with that row. Since we have a special character to represent mu, we can use mathematical notation by using a dollar sign `$`.
-
+
To add a line under these values, we can use the `\midrule` command.
-
+
To add more text within the rows after this line, we simply type words, using an `&` to indicate column breaks and the `\\` to indicate the end of the row. The `$` is also used to create mathematical notations.
-
+
To add the line at the bottom, we need to use a command that is similar to `toprule{}` and `midrule{}` which is `bottomrule{}`.
-
+
Now we just need to finish off our table.
First we need to get out of the tabular mode, so we will use our trusty `\end{}` function. In this case, we end with `\end{tabular}`. To end the table overall, we use `\end{table}`. We will discuss what the `\label{}` function does soon.
-
+
To add the line at the bottom, we again use `\bottomrule{}`.
-
+
## Creating internal links
@@ -139,13 +139,13 @@ You also need to have the same notation for each type:
- `fig:` for figures
- `sec:` for section headers
-
+
Here we will create a new link for the introduction. We first need to add a label to the introduction using the `label{}` function. We will call it `intro` and we need to specify that this is a section header with `sec` , like so: `label{sec:intro}`.
We then need to refer to this in the same way somewhere else using the `ref{}` function, like so: `ref{sec:intro}`. This will create a link to that section.
-
+
## References
@@ -161,13 +161,13 @@ The first part of the bib item will indicate what to refer to it in the text to
This results in a citation number and a link to the reference.
-
+
To add a bibliography, we can just undo the comment in front of the bibliography command. This is sufficient to create the bibliography. The code after this in the template to create each reference individually is not needed.
-
+
## Conclusion
diff --git a/docs/06-troubleshooting.md b/docs/06-troubleshooting.md
index d2a0ea0a..cd73314f 100644
--- a/docs/06-troubleshooting.md
+++ b/docs/06-troubleshooting.md
@@ -3,20 +3,20 @@
Overleaf has lots of ways to make writing in LaTeX easier. In this chapter we will cover several of these ways, as well as how to identify and fix a problem if you encounter one.
-
+
## Code Suggestions
As you type code, Overleaf makes code suggestions based on what you have already typed. You can click on a suggestion to use it. Overleaf will also offer suggestions on what to put within command brackets. This can be great if you can't quite remember what a command is or if you are trying to write a document faster.
-
+
## Symbol Palette
If you need to use many symbols or mathematical notations in your work, the symbol palette can be very helpful. You can access it by pressing the button that looks like an omega symbol at the top of the source editor.
-
+
## History
@@ -27,7 +27,7 @@ Here you will see the most recent changes as slices of changes overtime. Changes
If you are using the comparison mode you will see the changes and who made them. However, you can also just look at the files from a specific point in time without seeing changes by clicking on the "view single version" button.
-
+
For more information about using the history features of Overleaf, see this [documentation](https://www.overleaf.com/learn/latex/Using_the_History_feature) @overleaf_history.
@@ -39,7 +39,7 @@ The link button at the top of each message will take you to the line of the file
Hovering on the red circle right next to the line number will show you information about what might be wrong with that line.
-
+
## Trouble Compiling
@@ -54,7 +54,7 @@ Keep in mind that sometimes an error happens earlier than where a red circle is
Here is an example of brackets that were not closed on line 76 where the yellow triangle is, but the red circle shows up on the next line because Overleaf expects you to close it here.
-
+
Remember, 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.
diff --git a/docs/07-collaborating.md b/docs/07-collaborating.md
index 238588eb..590b0dcb 100644
--- a/docs/07-collaborating.md
+++ b/docs/07-collaborating.md
@@ -5,7 +5,7 @@ Collaborating on Overleaf is much more doable if you have access to a [paid plan
## Learning Objectives
-
+
## Seeing collaborators
@@ -13,26 +13,26 @@ Different users will show up as a square with the first initial of their usernam
-
+
## Sharing
You can share a project with a collaborator (or with the world) similarly to a Google document. Just click on the share button and specify how you want people to access your project.
-
+
## Submitting
When you are ready to submit a document to a publisher, like a preprint to arXiv, you can do so using the `submit` button.
-
+
## Messages
You can send general messages using the "Chat" button.
-
+
## Review mode
@@ -41,22 +41,22 @@ If you press the "review" button, which is to the right of the "share" button, y
You will see a gray column open to the right of the source editor. Here you can add comments and toggle on and off the tracking of changes.
-
+
### Adding comments
You can also write comments about specific text by highlighting the text in review mode (by first pressing the review button) and then clicking "add comment".
-
+
Comments need to be verified to be posted. They can then be edited, resolved, or responded to.
-
+
Resolved comments can be found at the top left button in the review panel when in review mode.
-
+
## Conclusion
diff --git a/docs/08-github-sync.md b/docs/08-github-sync.md
index c1cfb266..d38ed467 100644
--- a/docs/08-github-sync.md
+++ b/docs/08-github-sync.md
@@ -12,21 +12,21 @@ We will not cover what GitHub is and how to use it in this chapter, but this [re
## Learning Objectives
-
+
To do so, you need to first click on the home button (looks like an icon of a house on the upper left) to go to the main menu (if you are not already there, this will be the case if you working on a project).
-
+
-Here you should see a list of any projects you have created or collabroated on.
+Here you should see a list of any projects you have created or collaborated on.
On the far upper right click on the "Account" button.
-
+
@@ -34,7 +34,7 @@ On the far upper right click on the "Account" button.
Then click on "Account Settings".
-
+
Next, scroll down to where you see the heading for "Project Synchronisation."
@@ -42,7 +42,7 @@ Next, scroll down to where you see the heading for "Project Synchronisation."
Click on the blue "Link" button next to the GitHub section.
-
+
If you already have a GitHub account, you will be asked to grant access.
@@ -54,15 +54,15 @@ To do so, first open the project that you would like to sync with GitHub from th
Next click the Overleaf menu button the far left upper corner.
-
+
Then scroll down to the "Sync" section.
-
+
The window that pops up about exporting the project to GitHub will then show up. This will create a new repository on GitHub with the files from your project.
-
+
## Syncing files
@@ -71,15 +71,15 @@ If you then make a change on GitHub and merge it with the main branch, you can p
To do so, navigate back to the Overleaf Menu in the project on the far left side.
-
+
Scroll back down to the sync section for GitHub.
-
+
You will see a window with buttons to sync changes back and forth from GitHub and Overleaf.
-
+
Now to get the change from GitHub you can press the "Pull GitHub changes into Overleaf" button.
diff --git a/docs/404.html b/docs/404.html
index 154daf33..7d060651 100644
--- a/docs/404.html
+++ b/docs/404.html
@@ -6,12 +6,11 @@
Page not found | Write Smarter with Overleaf and LaTeX
-
+
-
@@ -31,7 +30,6 @@
-
@@ -49,11 +47,16 @@
-
-
+
+
+
+