114 lines
4.5 KiB
Markdown
114 lines
4.5 KiB
Markdown
@slide(layout=chapter-slide)
|
|
|
|
@title
|
|
First steps with L<sup style="font-weight: bold; font-size: 73%; margin-left: -.25em; margin-right: -.05em; position: relative; top: .2em">A</sup>T<sub style="font-size: 100%; margin-left: -.1em">E</sub>X
|
|
|
|
@content
|
|
In order to compile the script for this tutorial, a few steps have to be followed, which are explained in the next slides.
|
|
|
|
@slide(layout=content-only)
|
|
|
|
@title
|
|
Installing the compiler
|
|
|
|
@content
|
|
* The compiler translates our L<sup style="font-weight: bold; font-size: 73%; margin-left: -.25em; margin-right: -.05em; position: relative; top: .2em">A</sup>T<sub style="font-size: 100%; margin-left: -.1em">E</sub>X code into a PDF
|
|
* Depending on your operating system, different compilers are available
|
|
* Windows: <a href="https://miktex.org/download">MikT<sub style="font-size: 100%; margin-left: -.1em">E</sub>X</a>
|
|
* macOS: <a href="https://tug.org/mactex/">MacT<sub style="font-size: 100%; margin-left: -.1em">E</sub>X</a>
|
|
* Linux distributions: T<sub style="font-size: 100%; margin-left: -.1em">E</sub>XLive
|
|
* Debian-based distributions: run `sudo apt install texlive-full`
|
|
* other distributions: see the <a href="https://tug.org/texlive/doc/texlive-en/texlive-en.html#installation">website</a>
|
|
|
|
<div class="box warning">
|
|
Make sure to install the full version with all packages, if you can!
|
|
</div>
|
|
|
|
@slide(layout=content-only)
|
|
|
|
@title
|
|
Installing the editor
|
|
|
|
@content
|
|
* An editor can downloaded once the compiler has been installed
|
|
* For editing LaTeX documents, any text editor works fine, e.g., <a href="https://notepad-plus-plus.org/downloads/">Notepad++</a>, <a href="https://code.visualstudio.com/download">VSCode</a>
|
|
* For beginners, <a href="https://www.texstudio.org/">T<sub style="font-size: 100%; margin-left: -.1em">E</sub>Xstudio</a> is recommended due to its LaTex-specific features
|
|
* Download and install T<sub style="font-size: 100%; margin-left: -.1em">E</sub>Xstudio
|
|
|
|
@slide(layout=content-only)
|
|
@title
|
|
Compile the script for the first time
|
|
|
|
@content
|
|
* Download the project archive from the VC.
|
|
* Unzip the archive.
|
|
* Open the file `main.tex` in T<sub style="font-size: 100%; margin-left: -.1em">E</sub>Xstudio. It is located in the root directory of the archive.
|
|
* Compile `main.tex` by pressing <span class="emoji">⏩</span>
|
|
* A few new files will be generated by the compilation.
|
|
* **WINDOWS FILE ENDINGS**
|
|
|
|
@slide(layout=content-and-preview)
|
|
@title
|
|
Listings
|
|
|
|
@content
|
|
We have multiple examples of LaTeX source code in the script. As a default setting, we use the package **listings** for displaying them.
|
|
|
|
* However, the package **minted** generates more appealing listings.
|
|
* Minted requires additional configuration, like the installation of the programming language **Python 3** and the package **Pygments**
|
|
* The following slides explain how to use `minted` for this LaTeX project
|
|
|
|
@preview
|
|
{ .thin-padding}
|
|
|
|
@slide(layout=content-only)
|
|
@title
|
|
Installation of Python 3
|
|
|
|
@content
|
|
* Check if Python is already installed on your operating system using a command prompt:
|
|
``` {.lang-sh .hljs}
|
|
python --version
|
|
```
|
|
* If installed, the output should look similar to this:
|
|
``` {.lang-sh .hljs}
|
|
Python 3.8.5
|
|
```
|
|
* If not installed, follow the instructions for your operating sytem on the **[website](https://www.python.org/)**
|
|
* Make sure to enable the option to add Python to your PATH, if possible
|
|
* Run the above-mentioned command to ensure the installation was successful
|
|
|
|
|
|
@slide(layout=content-only)
|
|
@title
|
|
`Pygments` and compiler command settings
|
|
|
|
@content
|
|
* Install the **Pygments** by executing the following command in a command prompt:
|
|
<code>pip install Pygments</code>
|
|
|
|
* In TeXstudio, navigate to Options → Configure TeXstudio → Commands
|
|
* Next to the PdfLaTeX label, add the ``shell-escape`` flag to the compiler command:
|
|
|
|
<code>pdflatex -synctex=1 -interaction=nonstopmode **\-\-shell-escape** %.tex</code>
|
|
|
|
<div class="box warning">
|
|
Passing the flag ``--shell-escape`` to your compiler can be a potential security risk. **Only do it for documents you trust!**
|
|
</div>
|
|
|
|
@slide(layout=content-only)
|
|
@title
|
|
Change the listings mode
|
|
|
|
@content
|
|
In order to compile the script using `minted`, the listings mode has to be changed.
|
|
|
|
* Create a new file in the root directory of the project archive, named `listings-mode.tex`
|
|
* Insert the following command into the newly created file
|
|
|
|
``` {.lang-tex .tex .hljs}
|
|
\newcommand\listingsmode{minted}
|
|
```
|
|
|
|
* Compile `main.tex` again by pressing <span class="emoji">⏩</span>
|
|
|