Emacs

The vast majority of configuration help and troublshooting should be in the literate configuration file Emacs.org. The purpose of this document is help with usage of the configuration.

Packages

org-latex

Straightforward Emacs guide. The following is copied from that guide.

Firstly create a setup file,

A SETUPFILE is simply a file that contains some sort of org mode configuration. For example, the #+LATEX_CLASS: we saw earlier. Or, maybe #+LATEX_HEADER:. It could even be as simple as #+TITLE:. In this SETUPFILE we can place all of our lines of LaTeX code we want included in the final generated document. This is a very powerful and easy method of perfectly customizing our export.

Linking the SETUPFILE:

Secondly, structure the SETUPFILE,

Now, in that SETUPFILE, we place the LaTeX lines we normally would put in a .tex file. For example, \usepackage{amsmath}. Hopefully you have your own favorite .tex file setup, but if not I suggest learning LaTeX and/or finding a template online.

I suggest using a macro to add #+LATEX_CLASS: to each line, rather than typing it manually of course! Notice the LaTeX_CLASS: - the custom one we just created.

#+LaTeX_CLASS: org-plain-latex
#+LaTeX_CLASS_OPTIONS: [letter]
#+LATEX_HEADER: \usepackage{lmodern} % Ensures we have the right font

#+LATEX_HEADER: \usepackage[AUTO]{inputenc}
#+LATEX_HEADER: \usepackage{graphicx}
#+LATEX_HEADER: \usepackage{amsmath, amsthm, amssymb}
#+LATEX_HEADER: \usepackage[table, xcdraw]{xcolor}

% and so on...

Some extra notes,

Some notes not covered in the video.

Enable using listings for code highlighting

  (setq org-latex-listings 't)

In your SETUPFILE:

#+LATEX_HEADER: \usepackage{listings}

If you enable org-latex-listings but don’t include the listings package in your TeX file, it will likely not compile (if you are exporting an org file with code blocks).

Some useful commands,

org-latex-preview: Toggles preview LaTeX math at point

Useful Commands

These commands consists of third-party and native commands. Since it is my configuration it is adapted to suit my needs.

Native Emacs

Code Formatting

C-x C-; (comment), comment or uncomment the current line (comment-line). If the region is active, comment or uncomment the lines in the region instead.

C-x TAB (indent), Use the arrow keys (← or →) to indent interactively and then press esc three times to finish indenting.

Navigation

C-x d (dired-mode), enter dired mode.

C-x C-q(write dired-mode), enter Wdired mode (write dired). In this mode, you can edit file names just like you would any file. However, when you have completed the edits of the dired, make sure to run the command C-c C-c to finish.

C-c C-o (open link), when the cursor is over a link, this command will open the link

C-c C-l(edit link), when the cursor is over a link, this command will open the link in a minibuffer for editing.

Writing

C-x 8 RET (special symbols), to access special symbols.

`org-todo.el` and `org-agenda.el`

To create a percentage completion rate simply add [/][%] and then do the command C-c C-c.