org-mode notes

• _foo_ will underline the text: foo
• *foo* will make the text bold: foo
• /foo/ will italicise the text: foo
• [[target][label]] will generate links

This configuration is explained in detail in the Summary of In-Buffer Settings. A sensible header for an org-mode file should contain the following:

• #+title:
• #+Time-stamp: <>
• #+startup: overview
• #+options: toc:nil with #+toc: headlines 2
• #+options: num:nil

You might use #+startup: noinlineimages if you do not want images to display in the window by default. This can be very useful if you have figures too big to fit on the screen.

You can also use #+html_head: to add snippets to the head during HTML export. This is particularly helpful if you want to include additional CSS in the exported pages. This is explained in more detail here.

As stated here.

Org 9.5 provides a new library oc.el which provides tooling to handle citations in Org, e.g., activate, follow, insert, and export them, respectively called "activate", "follow", "insert" and "export" capabilities. Libraries responsible for providing some, or all, of these capabilities are called "citation processors".

The manual contains a few pointers to let you start and you may want to check this blog post. If you need help using this new features, please ask on the mailing list.

Thanks to Nicolas Goaziou for implementing this, to Bruce D'Arcus for helping him and to John Kitchin for paving the way with org-ref.el.

Amazingly, you can use latex environments without any issue and they should be handled correctly in both latex and HTML export.

The following table is derived from this documentation.

org-mode has functionality for exporting to HTML. The default maths support is good. If you want to include CSS this can be done by including a HTML_HEAD definition. For example, this page has the following line at the top of the file.

#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="../css/stylesheet.css" />

If you were to use a different CSS file you would need to change the href. For example, on some other pages I use the following:

#+HTML_HEAD: <link rel="icon" type="image/png" href="../../resources/nicemacs-favicon.png">
#+HTML_HEAD: <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/milligram/1.4.1/milligram.css">
#+HTML_HEAD: <link rel="stylesheet" href="../../microgram.css">

If you want to incorporate a small snippet of HTML into the exported HTML use the #+begin_export html snippet to include that elements.

There is the #+attr_html: declaration to specify how things should be exported to HTML. For example

#+attr_html: :width 700px
./path/to/image.png

will export the image with the additional attribute that the width should be 700 pixels.

See Figures.

The code is used to configure the generation of this site looks roughly like the following snippet. For the version of the code actually used, check out my nicemacs.

(require 'ox-publish)

(setq org-publish-project-alist
      '(
        ("org-notes"
         :base-directory "~/public-site/org/"
         :base-extension "org"
         :publishing-directory "~/aezarebski.github.io/"
         :recursive t
         :publishing-function org-html-publish-to-html
         :headline-levels 4
         :auto-preamble t
         )
        ("org-static"
         :base-directory "~/public-site/org/"
         :base-extension "css\\|js\\|png\\|jpg\\|gif\\|pdf\\|mp3\\|ogg\\|swf\\|txt\\|cur\\|svg\\|csv\\|json"
         :publishing-directory "~/aezarebski.github.io/"
         :recursive t
         :publishing-function org-publish-attachment
         )
        ("org"
         :components ("org-notes" "org-static"))))

(org-publish "org")

The org-publish-project-alist is the main variable that needs to be set for publishing. Each element of this list describes one destination of the publishing process. Destinations form a hierarchy as can be seen in the "org" element which takes "org-notes" and "org-static" as components.

The base-directory is where to look for source files and the publishing-directory is destination for the results.

The default behaviour when using noweb syntax is that it will be expanded when tangling and exporting. If you want to keep expansion on tangle but not on export set :noweb no-export as shown in the following example.

{
    "foo": "bar"
}

which is produced by the following orgmode

#+name: foobar
#+begin_src javascript :noweb yes
  {
      "foo": "bar"
  }
\#+end_src

Note that the block gets the name foobar which we can then reference in the following block

{
    "fleeb":
        <<foobar>>
}

This was itself produced by the following

\#+name: mainjs
\#+begin_src javascript :noweb no-export :tangle ../misc/silly-example.json
   {
       "fleeb":
           <<foobar>>
   }
\#+end_src

Tangling this produces the following JSON

{
    "fleeb":
        {
            "foo": "bar"
        }
}

org-toggle-inline-images will toggle the display of figures in an org document. To change the size of the displayed image use the following

#+attr_org: :width 450px
#+attr_html: :width 450px

For export there are other commands you might want to issue. See for example the HTML attributes.

The command org-beamer-export-to-latex produces a TEX file from your ORG file. So, given your presentation is in slides.org use the following to create a PDF

emacs slides.org --batch --eval="(org-beamer-export-to-latex)"
pdflatex slides.tex

There are slightly shorter ways to do this, but having the intermediate TEX is good for fine tuning the resulting slides. NOTE if there are TODO items in the slides, these seem to break the export.

This is achieved with #+begin_quote and #+end_quote

Everything should be made as simple as possible, but not any simpler —Albert Einstein

org-table-create

Define a macro at the top of the file

#+MACRO: name   replacement text $1, $2 are arguments

Use it with {{{name(arg1, arg2)}}}.

The agenda files are used to track TODO items. Use org-agenda-file-to-front to add an org-mode file to the list of agenda files. If you are ever in doubt about which files are in the adgenda, use SPC h d v and request org-agenda-files.

Items in a TODO list can be prioritised by adding an annotation of [#<A|B|C>]. There are only three levels available by default, and if no annotation is used it is assumed to be level B.

To make it easier to schedule items, bind org-schedule to SPC o o s ([o]wner-[o]rg-[s]chedule) which will bring up a calendar to select the date. You can hold S and then use the arrow keys to navigate the calendar. Times can be added in 24-hour format to the end of the date. This will add a SCHEDULED property under that item. If you want to add a time to the task, put it after the date. The +1w in the example below means that you want the task to be repeated each week. There are y,m,w,d for year, month, week and day (see here for details).

SCHEDULED: <2022-09-18 Sun 14:00 +1w>

The following settings ensure that a sensible amount of material is shown in the agenda: items from up to 3 days ago and over a 30 day span in total.

(setq org-agenda-start-day "-3d")
(setq org-agenda-span 30)
(setq org-agenda-start-on-weekday nil)

The org-todo-keywords variable is used to specify the different TODO types. The pipe, |, in the following example is used to designate that "DONE" is the only keyword which indicates that a task is finished. It is probably easiest to use customise to set these variables.

'(org-todo-keywords '((sequence "TODO" "BLOCKED" "DONE")))

On the org-mode website's page on hyperlinks they have the following nice table: