From fa3ebdb04f6c76527deaafbfd1ee2b51df9936b2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 21 Jun 2024 16:53:39 +0000 Subject: [PATCH] Render bookdown --- docs/01-intro.md | 6 +- docs/02-latex.md | 14 +- docs/03-overleaf.md | 34 ++--- docs/04-writing.md | 26 ++-- docs/05-elements.md | 46 +++---- docs/06-troubleshooting.md | 12 +- docs/07-collaborating.md | 18 +-- docs/08-github-sync.md | 24 ++-- docs/404.html | 13 +- docs/About.md | 113 ++++++++------- docs/about-the-authors.html | 130 ++++++++++-------- docs/collaborating.html | 67 ++++----- docs/connecting-to-github.html | 53 +++---- docs/elements.html | 83 +++++------ docs/index.html | 19 +-- docs/index.md | 2 +- docs/introduction.html | 39 +++--- docs/latex.html | 69 +++++----- .../anchor-sections-1.0.1/anchor-sections.js | 33 ----- .../anchor-sections-hash.css | 2 + .../anchor-sections.css | 1 - .../anchor-sections-1.1.0/anchor-sections.js | 11 ++ .../gitbook-2.6.7/css/plugin-highlight.css | 2 +- docs/libs/gitbook-2.6.7/css/style.css | 10 +- .../libs/gitbook-2.6.7/js/plugin-clipboard.js | 6 +- docs/libs/header-attrs-2.10/header-attrs.js | 12 -- docs/overleaf.html | 75 +++++----- docs/references-1.html | 17 ++- docs/search_index.json | 2 +- docs/troubleshooting.html | 61 ++++---- docs/writing-with-overleaf.html | 87 ++++++------ 31 files changed, 553 insertions(+), 534 deletions(-) delete mode 100644 docs/libs/anchor-sections-1.0.1/anchor-sections.js create mode 100644 docs/libs/anchor-sections-1.1.0/anchor-sections-hash.css rename docs/libs/{anchor-sections-1.0.1 => anchor-sections-1.1.0}/anchor-sections.css (83%) create mode 100644 docs/libs/anchor-sections-1.1.0/anchor-sections.js delete mode 100644 docs/libs/header-attrs-2.10/header-attrs.js 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. -for indiviudals who: Are unfamiliar with what LaTeX is, but like the idea of more customizable and reproducible formatting of text in documents. Have heard of LaTeX but don’t know how to use it in practice. Want guidance on collaborating with Overleaf. +for indiviudals who: Are unfamiliar with what LaTeX is, but like the idea of more customizable and reproducible formatting of text in documents. Have heard of LaTeX but don’t know how to use it in practice. Want guidance on collaborating with Overleaf. ## 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. -Concepts covered in this course are: 1. What typsetting is, 2. What LaTeX is and how it came to be, 3. How Overleaf makes writing LaTeX documents easier, 4. How to work with a template for a scientific article intended for arXiv, 5. How to collaborate on Overleaf, 6. How to get help if you run into issues +Concepts covered in this course are: 1. What typsetting is, 2. What LaTeX is and how it came to be, 3. How Overleaf makes writing LaTeX documents easier, 4. How to work with a template for a scientific article intended for arXiv, 5. How to collaborate on Overleaf, 6. How to get help if you run into issues ## Objectives -This course will demonstrate how to: 1.Be familiar with what LaTeX is and understand the origins of how it came to be, 2. Understand the benefits of using LaTeX and Overleaf, 3. Get started writing in Overleaf with a template for a scientific manuscript, 4. Add references to a document in Overleaf, 5. Get help if you encounter challenges, 6. Work collaboratively on Overleaf +This course will demonstrate how to: 1.Be familiar with what LaTeX is and understand the origins of how it came to be, 2. Understand the benefits of using LaTeX and Overleaf, 3. Get started writing in Overleaf with a template for a scientific manuscript, 4. Add references to a document in Overleaf, 5. Get help if you encounter challenges, 6. Work collaboratively on Overleaf 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. -LaTex is not latex (the material used for protective gloves and other items). +LaTex is not latex (the material used for protective gloves and other items). ## Learning Objectives -Learning Objectives: 1. Explain what LaTeX is and how it came to be 2. Understand that writing a document involves two distinct steps 1) writing the content and 2) determining how the content should be displayed, 3. Recognize that applications like microsoft word interactively show you the formatting/arrangement of the document as you write, while markup languages embed how a file should display using specific tags within the text that are later manifested, 4.Begin to understand how markup language tags result in changes in how text is displayed +Learning Objectives: 1. Explain what LaTeX is and how it came to be 2. Understand that writing a document involves two distinct steps 1) writing the content and 2) determining how the content should be displayed, 3. Recognize that applications like microsoft word interactively show you the formatting/arrangement of the document as you write, while markup languages embed how a file should display using specific tags within the text that are later manifested, 4.Begin to understand how markup language tags result in changes in how text is displayed ## 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. -LaTeX allows for fancy document typesetting (meaning formatting and text layout), where as traditional text editors like Microsoft Word requires manual formatting and layout, which often leads to typical looking documents. +LaTeX allows for fancy document typesetting (meaning formatting and text layout), where as traditional text editors like Microsoft Word requires manual formatting and layout, which often leads to typical looking documents. @@ -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. -Historically making printed documents required two steps: 1. Writing the content by hand, 2. Determine the layout and font and arrangement of the text with stamps. +Historically making printed documents required two steps: 1. Writing the content by hand, 2. Determine the layout and font and arrangement of the text with stamps. 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. -WYSIWYG - What you see is what you get - the document is displayed like the final product as you write it. +WYSIWYG - What you see is what you get - the document is displayed like the final product as you write it. 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}`. -A table of the methods just described to bold text to indicate that text around the plain text is used to format the text itself within markup languages. +A table of the methods just described to bold text to indicate that text around the plain text is used to format the text itself within markup languages. 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 -Benefits of Using LaTeX: Using a template allows you to focus on the content and not the formatting/layout, Can create very complex documents, Can reproduce style/typesetting of a document easily again, Can easily change the typesetting of an entire document, Can add languages with other alphabets or mathematical notation easily, If you know LaTeX you can collaborate with others who use it! +Benefits of Using LaTeX: Using a template allows you to focus on the content and not the formatting/layout, Can create very complex documents, Can reproduce style/typesetting of a document easily again, Can easily change the typesetting of an entire document, Can add languages with other alphabets or mathematical notation easily, If you know LaTeX you can collaborate with others who use it! ## 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. -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 +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. +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. @@ -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). -Summary of the benefits of Overleaf. +Summary of the benefits of Overleaf. ## 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. -There are several ways to register an account on Overleaf. +There are several ways to register an account on Overleaf. ## 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. +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. +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. @@ -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. -The official tag for some templates indicates that the publisher recoginizes and approves of the template as the official tempalte to use for submissions. +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. @@ -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. -Click the open as template button to get started with a template. +Click the open as template button to get started with a template. ## Viewing documents @@ -98,30 +98,30 @@ Overleaf easily shows you what the rendered version of your text will look like, -The default view in Overleaf is to have raw text shown on the left, while the compiled text is shown 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. +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. +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. +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. +To update rendered file with your changes, press the recompile button. ## Making changes @@ -131,20 +131,20 @@ First we will change the title, which is currently "Predict future sale". We can -We can search the source text by click on the editor pane and typing the shortcut keys for find functions (control F). +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. +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. +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. +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. 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. -Learning Objectives: 1.Recognize that there are packages for LaTex, 2. Understand that a command can either change the text within the brackets or cause a change to the overall document or section, 3. Be familiar with some common commands and notations for using LaTex to perform tasks such as: creating headings, creating comments, starting and ending elements within the text +Learning Objectives: 1.Recognize that there are packages for LaTex, 2. Understand that a command can either change the text within the brackets or cause a change to the overall document or section, 3. Be familiar with some common commands and notations for using LaTex to perform tasks such as: creating headings, creating comments, starting and ending elements within the text ## 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}`. -Documentclass command +Documentclass command 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: -The top of the template shows usepackage several times. +The top of the template shows usepackage several times. 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. -Recap of the title command +Recap of the title command 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. -Double backslash ends a line. +Double backslash ends a line. We also see another command `\textttt{}` used within the `\author{}` command to change the text to typewriter font. -The texttt command changes the font within the brackets to typewriter font. +The texttt command changes the font within the brackets 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. -The double percent sign %% creates a comment that will not show up in the final document. +The double percent sign %% creates a comment that will not show up in the final document. In the author section, the `\And` allows for additional authors to be added. It must be used between each author listing. -In the author section, the And tag allows for additional authors to be added and needs to be used between each other. +In the author section, the And tag allows for additional authors to be added and needs to be used between each other. Finally, the author section needs to be completed by closing the brackets. -In the author section, the brackets for the original author command need to be closed. +In the author section, the brackets for the original author command need to be closed. ### 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. -The begin and maketitle commands specify where certian formatting should occur. +The begin and maketitle commands specify where certian formatting should occur. ### 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: -Example of sections in the template showing how it creates a number and bold text +Example of sections in the template showing how it creates a number and bold text -Example of a subsection with dummy text. +Example of a subsection with dummy text. 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. -A paragraph section will not be numbered but whatever text is within the brackets will be in bold. +A paragraph section will not be numbered but whatever text is within the brackets will be in bold. 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. -Learning Objectives: 1. Add figures and images to documents, 2. Add references and citations to documents, 3. Add tables to documents, 4. Create internal links back to a figure, table, reference or section +Learning Objectives: 1. Add figures and images to documents, 2. Add references and citations to documents, 3. Add tables to documents, 4. Create internal links back to a figure, table, reference or section 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. -Example of the code for a figure when you have a png file to use. +Example of the code for a figure when you have a png file to use.
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. -The template.tex file is the file we have been working in. You can see it in the left menu. +The template.tex file is the file we have been working in. You can see it in the left menu. If you click on the name of the image file you will see a preview of the image. -Location of the image file called test.png in the left menu. +Location of the image file called test.png in the left menu.
**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. -New file button +New file button Then select the upload button to drag and drop a new image file from your computer. -Menu for uploading a file.. +Menu for uploading a file.. 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. -All the code for the table. +All the code for the table. -The resulting table +The resulting 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. -The caption command adds the table title. +The caption command adds the table title. @@ -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 caption command adds the table title. +The caption command adds the table title. - 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 toprule command adds a line to the top of the table after the title. +The toprule command adds a line to the top of the table after the title. - 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 multicolumn command allows you to create text that spans across multiple columns. +The multicolumn command allows you to create text that spans across multiple columns. 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. -The cmidrule command adds the line or rule under the multicolumn that says Part. +The cmidrule command adds the line or rule under the multicolumn that says Part. 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 `$`. -Adding text within the tables requires an & to indicate different cells within the table. +Adding text within the tables requires an & to indicate different cells within the table. To add a line under these values, we can use the `\midrule` command. -Adding lines to specific parts of the middle of the table requires the midrule command. +Adding lines to specific parts of the middle of the table requires 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. -The contents of the table for these rows can be added similar to the one above where the & creates column divisions and the $ creates mathematical notations. The double backslash is need for each row to end the row. +The contents of the table for these rows can be added similar to the one above where the & creates column divisions and the $ creates mathematical notations. The double backslash is need for each row to end the row. To add the line at the bottom, we need to use a command that is similar to `toprule{}` and `midrule{}` which is `bottomrule{}`. -The contents of the table for these rows can be added similar to the one above where the & creates column divisions and the $ creates mathematical notations. The double backslash is need for each row to end the row. +The contents of the table for these rows can be added similar to the one above where the & creates column divisions and the $ creates mathematical notations. The double backslash is need for each row to end the row. 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. -The contents of the table for these rows can be added similar to the one above where the & creates column divisions and the $ creates mathematical notations. The double backslash is need for each row to end the row. +The contents of the table for these rows can be added similar to the one above where the & creates column divisions and the $ creates mathematical notations. The double backslash is need for each row to end the row. To add the line at the bottom, we again use `\bottomrule{}`. -The end function is used to stop the tabular mode and to finish the table. +The end function is used to stop the tabular mode and to finish the table. ## 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 -The end function is used to stop the tabular mode and to finish the table. +The end function is used to stop the tabular mode and to finish the table. 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. -To create a link to the introduction, which is section 1, we can apply the same method using the sec tag. +To create a link to the introduction, which is section 1, we can apply the same method using the sec tag. ## 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 create a citation, use the cite command and be sure that you update your bib file. +To create a citation, use the cite command and be sure that you update your bib file. 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. -To add a bibliography, we can just undo the comment infront of the bibliography command. This is sufficient to create the bibliography if we have a .bib file. +To add a bibliography, we can just undo the comment infront of the bibliography command. This is sufficient to create the bibliography if we have a .bib file. ## 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. -Learning Objectives:1. Recognize how Overleaf offers extra support, 2. Identify when there is an Issue, 3.Know how to get help +Learning Objectives:1. Recognize how Overleaf offers extra support, 2. Identify when there is an Issue, 3.Know how to get help ## 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. -Overleaf makes code suggestions based on what you have already typed. You can click the suggestion to autocomplete your code. +Overleaf makes code suggestions based on what you have already typed. You can click the suggestion to autocomplete your code. ## 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. -The symbol palette can be very helpful. It can be accessed at the top of the source editor. +The symbol palette can be very helpful. It can be accessed 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. -The History Tab shows you changes when in comparison mode. Changes are highlighted in color. +The History Tab shows you changes when in comparison mode. Changes are highlighted in color. 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. -Log errors can take you to the line that is problematic +Log errors can take you to the line that is problematic ## 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. -An image of code with an error circle at the next line and a warning triangle at the previous line. +An image of code with an error circle at the next line and a warning triangle at the previous line.
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 -Learning Objectives: 1. Be familiar with tools available for collaboration, 2. Share projects for others to view or edit, 3. Open reviewing mode, 4. Add comments to content +Learning Objectives: 1. Be familiar with tools available for collaboration, 2. Share projects for others to view or edit, 3. Open reviewing mode, 4. Add comments to content ## Seeing collaborators @@ -13,26 +13,26 @@ Different users will show up as a square with the first initial of their usernam -Image of the user icon +Image of the user icon ## 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. -The share button allows you to share your project similar to a Google doc. +The share button allows you to share your project similar to a Google doc. ## 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. -The submit button helps you submit documents directly to publishers. +The submit button helps you submit documents directly to publishers. ## Messages You can send general messages using the "Chat" button. -The submit button helps you submit documents directly to publishers. +The submit button helps you submit documents directly to publishers. ## 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. -Image of where to turn track changes on and off once the Review button has been pressed. +Image of where to turn track changes on and off once the Review button has been pressed. ### 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". -Example of highlighting text to add a comment. +Example of highlighting text to add a comment. Comments need to be verified to be posted. They can then be edited, resolved, or responded to. -Image of verifying an example comment and then the result of creating a comment that can be edited, responded to, or resolved. +Image of verifying an example comment and then the result of creating a comment that can be edited, responded to, or resolved. Resolved comments can be found at the top left button in the review panel when in review mode. -Image of the resolved comment button. +Image of the resolved comment button. ## 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 -Learning Objectives: 1. Connect your GitHub and Overleaf accounts, 2. Set up a project to sync with GitHub, 3. Sync changes to and from GitHub +Learning Objectives: 1. Connect your GitHub and Overleaf accounts, 2. Set up a project to sync with GitHub, 3. Sync changes to and from GitHub 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). -The home button to go to the main menu if you are in a project. +The home button to go to the main menu if you are in 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. -Account button on the upper right corner. +Account button on the upper right corner. @@ -34,7 +34,7 @@ On the far upper right click on the "Account" button. Then click on "Account Settings". -Account settings button under the account button. +Account settings button under the account button. 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. -Link button to sync with GitHub. +Link button to sync with GitHub. 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. -The Overleaf menu button to go to the main menu if you are in a project. +The Overleaf menu button to go to the main menu if you are in a project. Then scroll down to the "Sync" section. -The Sync section fo the Overleaf Menu. +The Sync section fo the Overleaf Menu. 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. -Popup when exporting a project to GitHub. +Popup when exporting a project to GitHub. ## 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. -Overleaf menu button on the upper far left. +Overleaf menu button on the upper far left. Scroll back down to the sync section for GitHub. -The Sync section fo the Overleaf Menu. +The Sync section fo the Overleaf Menu. You will see a window with buttons to sync changes back and forth from GitHub and Overleaf. -GitHub Sync menu +GitHub Sync menu 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 @@ - - + + + +