Skip to content

Installation

Johannes Schackniß edited this page Jul 6, 2021 · 2 revisions

Setup Writing Enviroment

Setup VS Code

Required settings:

  1. Download and install Perl
    Uncheck Read README file. and click Finish.
    image
  2. Download and install MiKTeX
    Follow the installation steps.
    Select Yes for Install missing packages on-the-fly.
    Screenshot 2021-07-06 143520
    Uncheck Tell me more and click Close.
    Screenshot 2021-07-06 144023
    Double-click the MiKTeX icon in the toolbar.
    Screenshot 2021-07-06 144457
    Open the Update tab and click on Update now.
    image
    Click OK and MiKTeX will be closed.
    image
  3. Download and install Visual Studio Code.
  4. Open VSCode and install extensions.
    Open the Extensions tab.
    image
    Search for LaTeX Workshop and click Install on the package as shown in the screenshot below.
    image

Optional settings

  1. Open the Extensions tab and click on the Settings-gear-wheel to open the settings.
    image
  2. Add output in the searchbar and add %DIR%/build-files in Out Dir-Settings.
    image
  3. Add build in the searchbar and select never in Auto Build: Run-Settings.
    image

Optional extensions

  1. Bracket Pair Colorizer 2
    image
  2. Todo Tree
    Setup for Latex
    image
    Open extension settings and search for
Todo Tree: Regex: Regex:

and insert

((//|#|<!--|;|/\*|^|%|\\)\s*($TAGS)\{*|^\s*- \[ \])

Search for

Todo Tree: General: Tags:

and click Add Item. Add todo to show todo's from the todonotes-package (LaTeX).
3. WIP (Spell checker).

Setup Atom (not recommended)

Required settings:

  1. Download and install Perl

  2. Download and install MiKTeX

  3. Download and install Atom

  4. Open Atom

  5. Press 'ctrl + ,' to open settings

  6. Open the install tab

  7. Install the following packages by writing the names in the search bar

    required:

    • latex - (required, ability to compile latex)

    optional (but highly recommended):

    • language-latex (syntax highlighting, makes the tex file much easier to read)
    • latex-autocomplete (helps you to create figures, items, etc.)
    • autocomplete-latex (helps you to create figures, items, etc.)
    • pdf-view - (shows the compiled pdf file in the editor)

Optional settings:

'latex' package settings:

latex-image

  • Ouput Directory: saves the meta files in the defined directory, this helps to keep your root directory clean
  • Move Result to Source Directory: saves the pdf file in the same folder as the producing tex document
  • Build on Save: starts a build when the file is safed ('ctrl + s' or by clicking 'File>Save..')
  • Open Result after Successful Build: opens the pdf in the 'pdf-view' after the build finished

To edit the settings:

  1. Open packages tab in the settings window
  2. Search for the package latex and open the package settings

'spell-check' package settings:

spell-check-image

  • Grammars: the file types that will be spell checked
  • Use Locales: if locals should be used for the spell check
  • Locales: what locals should be used for the spell check (example: en-US, de-DE)

To edit the settings:

  1. Open packages tab in the settings window
  2. Search for the package 'spell-check' and open the package settings
  3. Add 'text.tex.latex' and the end of the field 'Grammars'
  4. Enable 'Use Locals'
  5. Add desired language to 'Locales' (for german add: 'de-DE')

To add support for more languages in 'Locales', check here in the 'Changing the dictionary' section

Clone this wiki locally