Yet Another Org-Mode Configuration
Configure org-mode and publish websites.

Org-Mode Configuration
Export
Publishing the Websites
Org File Template
CANCELED Cancelled or Incomplete Configuration
References

This page is about managing todo lists and publishing website using emacs and org-mode (tutorial, manual, example). A few hints are given for managing an agenda and publishing to LaTeX, but I am not using it for myself. The generated org-mode configuration file is here.

Org-Mode Configuration

The Emacs and Org-mode version are given in the postamble (footer).

Activation

This will make sure org gets loaded, some basic global key combinations are defined, and some common options are set.

(provide 'emacs-orgmode-config)
(require 'ox)

(add-to-list 'auto-mode-alist '("\\.org$" . org-mode))

(define-key global-map "\C-cl" 'org-store-link)
(define-key global-map "\C-ca" 'org-agenda)

;; ;; GLOBAL Keybindings that can be added to .emacs
;; (global-set-key [f4] 'org-capture)
;; (global-set-key [f5] '(lambda () (interactive)(find-file "~/org/mygtd.org")))
;; (global-set-key [f6] 'org-todo-list)
;; ;; (global-set-key [f7] 'org-agenda)

(setq org-log-done nil)
(setq org-startup-truncated nil)

Default Directories

it’s best to set aside a separate directory where your org files will be kept. The agenda directories are not visited recursivly.

(setq org-directory (expand-file-name "~/org"))
(setq org-default-notes-file (concat org-directory "/mygtd.org"))
(setq org-agenda-files '("~/org" "~/www/org" "~/www/_org"))

Todo and Tags

Definitions

Define TODO and TAG keywords with smooth colors.

(setq org-todo-keywords
      '(
        (sequence "IDEA(i)" "TODO(t)" "STARTED(s)" "NEXT(n)" "WAITING(w)" "|" "DONE(d)")
        (sequence "|" "CANCELED(c)" "DELEGATED(l)" "SOMEDAY(f)")
        ))

(setq org-todo-keyword-faces
      '(("IDEA" . (:foreground "GoldenRod" :weight bold))
        ("NEXT" . (:foreground "IndianRed1" :weight bold))
        ("STARTED" . (:foreground "OrangeRed" :weight bold))
        ("WAITING" . (:foreground "coral" :weight bold))
        ("CANCELED" . (:foreground "LimeGreen" :weight bold))
        ("DELEGATED" . (:foreground "LimeGreen" :weight bold))
        ("SOMEDAY" . (:foreground "LimeGreen" :weight bold))
        ))

(setq org-tag-persistent-alist
      '((:startgroup . nil)
        ("HOME" . ?h)
        ("RESEARCH" . ?r)
        ("TEACHING" . ?t)
        (:endgroup . nil)
        (:startgroup . nil)
        ("OS" . ?o)
        ("DEV" . ?d)
        ("WWW" . ?w)
        (:endgroup . nil)
        (:startgroup . nil)
        ("EASY" . ?e)
        ("MEDIUM" . ?m)
        ("HARD" . ?a)
        (:endgroup . nil)
        ("UCANCODE" . ?c)
        ("URGENT" . ?u)
        ("KEY" . ?k)
        ("BONUS" . ?b)
        ("noexport" . ?x)
        )
      )

(setq org-tag-faces
      '(
        ("HOME" . (:foreground "GoldenRod" :weight bold))
        ("RESEARCH" . (:foreground "GoldenRod" :weight bold))
        ("TEACHING" . (:foreground "GoldenRod" :weight bold))
        ("OS" . (:foreground "IndianRed1" :weight bold))
        ("DEV" . (:foreground "IndianRed1" :weight bold))
        ("WWW" . (:foreground "IndianRed1" :weight bold))
        ("URGENT" . (:foreground "Red" :weight bold))
        ("KEY" . (:foreground "Red" :weight bold))
        ("EASY" . (:foreground "OrangeRed" :weight bold))
        ("MEDIUM" . (:foreground "OrangeRed" :weight bold))
        ("HARD" . (:foreground "OrangeRed" :weight bold))
        ("BONUS" . (:foreground "GoldenRod" :weight bold))
        ("UCANCODE" . (:foreground "GoldenRod" :weight bold))
        ("noexport" . (:foreground "LimeGreen" :weight bold))
        )
)

Selection

(setq org-fast-tag-selection-single-key t)
(setq org-use-fast-todo-selection t)

Capture

Add new notes at the beginning of the file or entry.

(setq org-reverse-note-order t)

(setq org-capture-templates
      '(("t" "Todo" entry (file+headline "~/org/mygtd.org" "Tasks")
         "* TODO %?\nAdded: %U\n" :prepend t :kill-buffer t)
        ("i" "Idea" entry (file+headline "~/org/mygtd.org" "Someday/Maybe")
         "* IDEA %?\nAdded: %U\n" :prepend t :kill-buffer t)
        )
      )

Speed Commands

Speed commands enable single-letter commands in Org-mode files when the point is at the beginning of a headline, or at the beginning of a code block. See the org-speed-commands-default variable for a list of the keys and commands enabled at the beginning of headlines.

(setq org-use-speed-commands t)

Babel Code blocks

This activates a number of widely used languages. You can to activate more languages using the customize interface for the org-babel-load-languages variable, or with an elisp form like the one below.

(org-babel-do-load-languages
 'org-babel-load-languages
 '(
   (emacs-lisp . t)
   (org . t)
   (shell . t)
   (C . t)
   (python . t)
   (gnuplot . t)
   (octave . t)
   (R . t)
   (dot . t)
   (awk . t)
   ))

Fontification

The following displays the contents of code blocks in Org-mode files using the major-mode of the code. It also changes the behavior of TAB to as if it were used in the appropriate major mode.

(setq org-src-fontify-natively t)
(setq org-src-tab-acts-natively t)

Evaluation

It is possible to inhibit the evaluation of code blocks during export. Based on the documentation one can set the header arguments system wide using these variables:

org-babel-default-header-args (for all)
org-babel-default-header-args:<lang>   (language specific)

So, let stop Org from evaluating code blocks to speed exports.

(setq org-babel-default-header-args '((:eval . "never-export")))

File wide using PROPERTY

#+PROPERTY: header-args :eval never-export

Org heading wide using a local property setting:

* sample header
  :PROPERTIES:
  :header-args:    :eval never-export
  :END:

Tangle a single code block

Define a function to tangle a single code block.

(defun org-babel-tangle-block()
  (interactive)
  (let ((current-prefix-arg '(4)))
    (call-interactively 'org-babel-tangle)
))

Spell Checking

From stackexchange, ispell can be configured to skip over regions that match regexes. For example, to skip over :PROPERTIES: and :LOGBOOK: drawers as well as SRC AND EXAMPLE blocks:

(add-to-list 'ispell-skip-region-alist '(":\\(PROPERTIES\\|LOGBOOK\\):" . ":END:"))
(add-to-list 'ispell-skip-region-alist '("#\\+BEGIN_SRC" . "#\\+END_SRC"))
(add-to-list 'ispell-skip-region-alist '("#\\+BEGIN_EXAMPLE" . "#\\+END_EXAMPLE"))

TODO Org Tree Slide

TODO Structure Templates

https://orgmode.org/manual/Structure-Templates.html#Structure-Templates

Export

With Smart quotes

(setq org-export-with-smart-quotes t)

To Text

Fix missing links in ASCII export

(setq org-ascii-links-to-notes nil)

Adjust the number of blank lines inserted around headlines

(setq org-ascii-headline-spacing (quote (1 . 1)))

To Github Flavored Markdown

(eval-after-load "org"
  '(require 'ox-gfm nil t))

To HTML

(setq org-html-coding-system 'utf-8-unix)

Remove validation link

:html-validation-link was not available as a projects setting in Org-mode 8.2.

(setq org-html-validation-link nil)

MathJax CDN

The defaults use an old MathJax version

(setf org-html-mathjax-options
      '((path "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML")
        (scale "100")
        (align "center")
        (indent "2em")
        (mathml nil))
      )
(setf org-html-mathjax-template
      "<script type=\"text/javascript\" src=\"%PATH\"></script>")

Table

For the defaults, I prefer to rely on CSS style rather than on HTML attributes that are not supported anymore in HTML5.

(setq org-html-table-default-attributes
      '(:border "0" :cellspacing "0" :cellpadding "6" :rules "none" :frame "none"))

CSS Support

My CSS file for the projects is a fork from orgcss written by Zhitao Gong. Some other themes are nice too.

Fix Literals Formatting

An extra line is added when exporting literals, i.e. line prefixed by :. The following modified org-export function trims the content before the export

(require 'subr-x)

(defun org-html-fixed-width (fixed-width _contents _info)
  "Transcode a FIXED-WIDTH element from Org to HTML.
CONTENTS is nil.  INFO is a plist holding contextual information."
  (format "<pre class=\"example\">\n%s</pre>"
          (string-trim
           (org-html-do-format-code
           (org-remove-indentation
            (org-element-property :value fixed-width))))))

Publishing the Websites

Activation

(eval-after-load "org"
  '(require 'ox-publish nil t))

Configure Projects

Hure, two projects with very similar structures are configured.

(
 setq org-publish-project-alist
      '(
        ;; First Project
        ("org-notes"
         :base-directory "~/www/org/"
         :base-extension "org"
         :publishing-directory "~/www/build/"
         :recursive t
         :exclude ".*-template\.org\\|README\.org"        ; exclude org-reveal slides and other files
         :publishing-function org-html-publish-to-html
         :headline-levels 2               ; Just the default for this project.
         :auto-sitemap t                  ; Generate sitemap.org automagically...
         :sitemap-filename "org-sitemap.org"  ; ... call it sitemap.org (it's the default)...
         :sitemap-title "Plan du site"         ; ... with title 'Sitemap'.
         :with-creator nil    ; Disable the inclusion of "Created by Org" in the postamble.
         :with-email nil      ; Disable the inclusion of "(your email)" in the postamble.
         :with-author nil       ; Enable the inclusion of "Author: Your Name" in the postamble.
         :auto-preamble t;         ; Enable auto preamble
         :auto-postamble t         ; Enable auto postamble
         :table-of-contents t        ; Set this to "t" if you want a table of contents, set to "nil" disables TOC.
         :toc-levels 1               ; Just the default for this project.
         :section-numbers nil        ; Set this to "t" if you want headings to have numbers.
         :html-head-include-default-style nil ;Enable the default css style
         :html-head-include-scripts nil ;Disable the default javascript snippet
         :html-head "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n<link rel=\"stylesheet\" type=\"text/css\" href=\"css/org.css\"/>" ;Enable custom css style and other tags
         :html-link-home "index.html"    ; Just the default for this project.
         :html-link-up "misc.html"    ; Just the default for this project.
         )

        ("org-static"
         :base-directory "~/www/org/"
         :base-extension "html\\|xml\\|css\\|js\\|png\\|jpg\\|jpeg\\|gif\\|pdf\\|mp3\\|ogg\\|swf\\|zip\\|gz\\|csv\\|m\\|R\\|el"
         :include (".htaccess")
         :publishing-directory "~/www/build/"
         :recursive t
         :publishing-function org-publish-attachment
         :exclude "Rplots.pdf\\|README\\|LICENSE\\|\\.gitignore"
         )

        ("org"
         :components ("org-notes" "org-static")
         )


        ;; Second Project
        ("org-r-notes"
         :base-directory "~/teaching/algo-prog-R/org/"
         :base-extension "org"
         :publishing-directory "~/teaching/algo-prog-R/build/"
         :recursive t
         :exclude ".*-template\.org\\|README\.org"        ; exclude org-reveal slides and other files
         :publishing-function org-html-publish-to-html
         :headline-levels 2               ; Just the default for this project.
         :auto-sitemap t                  ; Generate sitemap.org automagically...
         :sitemap-filename "sitemap.org"  ; ... call it sitemap.org (it's the default)...
         :sitemap-title "Sitemap"         ; ... with title 'Sitemap'.
         :with-creator nil    ; Disable the inclusion of "Created by Org" in the postamble.
         :with-email nil      ; Disable the inclusion of "(your email)" in the postamble.
         :with-author nil       ; Enable the inclusion of "Author: Your Name" in the postamble.
         :auto-preamble t;         ; Enable auto preamble
         :auto-postamble t         ; Enable auto postamble
         :table-of-contents t        ; Set this to "t" if you want a table of contents, set to "nil" disables TOC.
         :toc-levels 2               ; Just the default for this project.
         :section-numbers t        ; Set this to "t" if you want headings to have numbers.
         :html-head-include-default-style nil ;Enable the default css style
         :html-head-include-scripts nil ;Disable the default javascript snippet
         :html-head "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n<link rel=\"stylesheet\" type=\"text/css\" href=\"css/org.css\"/>\n<link rel=\"stylesheet\" type=\"text/css\" href=\"css/logo_uns.min.css\" />" ;Enable custom css style and other tags
         :html-link-home "index.html"    ; Just the default for this project.
         :html-link-up "sitemap.html"    ; Just the default for this project.
         )

        ("org-r-static"
         :base-directory "~/teaching/algo-prog-R/org/"
         :base-extension "html\\|xml\\|css\\|js\\|png\\|jpg\\|jpeg\\|gif\\|pdf\\|mp3\\|ogg\\|swf\\|zip\\|gz\\|csv\\|m\\|R"
         :publishing-directory "~/teaching/algo-prog-R/build/"
         :recursive t
         :publishing-function org-publish-attachment
         :exclude "Rplots.pdf\\|README\\|LICENSE\\|\\.gitignore"
         )

        ("org-r"
         :components ("org-r-notes" "org-r-static")
         )
        )
      )

Publish a project

You can publish the project directly from emacs or from a terminal.

emacs --eval '(progn (org-publish-project "org-notes") (kill-emacs))'

Org File Template

#+STARTUP: overview hidestars
#+OPTIONS: tags:t timestamp:t todo:t p:t
#+OPTIONS: TeX:t LaTeX:t
#+OPTIONS: skip:t @:t ::t |:t ^:t f:t

CANCELED Cancelled or Incomplete Configuration

CANCELED Disable Priorities

(setq org-enable-priority-commands nil)

CANCELED Lists

(setq org-list-demote-modify-bullet (quote (
                                            ("+" . "-")
                                            ("*" . "-")
                                            ("1." . "-"))))

CANCELED Agenda

Honestly, I am do not use much org-agenda.

(setq org-agenda-ndays 7)
(setq org-agenda-show-all-dates t)
(setq org-agenda-skip-deadline-if-done t)
(setq org-agenda-skip-scheduled-if-done t)
(setq org-agenda-start-on-weekday nil)
(setq org-deadline-warning-days 14)
(setq org-agenda-custom-commands
      '(("g" . "GTD contexts")
        ("gh" "Home" tags-todo "HOME")
        ("gu" "Urgent" tags-todo "URGENT")
        ("G" "GTD Block Agenda"
         ((todo "STARTED")
          (tags-todo "URGENT")
          (todo "NEXT"))
         ((org-agenda-prefix-format "[ ] %T: ")
          (org-agenda-with-colors nil)
          (org-agenda-compact-blocks t)
          (org-agenda-remove-tags t)
          (ps-number-of-columns 2)
          (ps-landscape-mode t))
         ;;nil                      ;; i.e., no local settings
         ("~/next-actions.txt"))
        ))

CANCELED Export to LaTeX

I very rarely use org-mode to generate LaTeX files, I simply prefer auctex.

(require 'ox-latex)

(add-to-list 'org-latex-packages-alist '(\"\" \"listings\"))
(add-to-list 'org-latex-packages-alist '(\"\" \"color\"))

(setq org-format-latex-options (quote (:foreground default :background default :scale 2.0 :html-foreground "Black" :html-background "Transparent" :html-scale 2.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))))

CANCELED Export to HTML

Globally remove HTML style and scripts

style and scripts are configured via project settings.

(setq org-html-head-include-default-style nil)
(setq org-html-head-include-scripts nil)

Force relative links

(setq org-link-file-path-type "relative")

CANCELED Export to reveal.js

Activation

(eval-after-load "org"
  '(require 'ox-reveal nil t))

Org Reveal Template

#+STARTUP: overview hidestars
#+OPTIONS: tags:t timestamp:t todo:t p:t
#+OPTIONS: TeX:t LaTeX:t
#+OPTIONS: skip:t @:t ::t |:t ^:t f:t
#+REVEAL_ROOT: http://cdn.jsdelivr.net/reveal.js/3.0.0/
#+OPTIONS: reveal_center:t reveal_progress:t reveal_history:nil reveal_control:t
#+OPTIONS: reveal_rolling_links:t reveal_keyboard:t reveal_overview:t num:nil
#+OPTIONS: reveal_width:1200 reveal_height:800
#+REVEAL_MARGIN: 0.1
#+REVEAL_MIN_SCALE: 0.5
#+REVEAL_MAX_SCALE: 2.5
#+REVEAL_TRANS: slide
#+REVEAL_THEME: league
#+REVEAL_PLUGINS: (markdown notes)
#+REVEAL_EXTRA_CSS: ./local-reveal.css
#+REVEAL_PLUGINS: (highlight)
#+PROPERTY: header-args :results output
#+PROPERTY: header-args :exports both

Local Reveal CSS File

.reveal p {text-align: left;}

Yet Another Org-Mode ConfigurationConfigure org-mode and publish websites.

Table of Contents

Org-Mode Configuration

Activation

Default Directories

Todo and Tags

Definitions

Selection

Capture

Speed Commands

Babel Code blocks

Fontification

Evaluation

Tangle a single code block

Spell Checking

TODO Org Tree Slide

TODO Structure Templates

Export

With Smart quotes

To Text

To Github Flavored Markdown

To HTML

Remove validation link

MathJax CDN

Table

CSS Support

Fix Literals Formatting

Publishing the Websites

Activation

Configure Projects

Publish a project

Org File Template

CANCELED Cancelled or Incomplete Configuration

CANCELED Disable Priorities

CANCELED Lists

CANCELED Agenda

CANCELED Export to LaTeX

CANCELED Export to HTML

Globally remove HTML style and scripts

Force relative links

CANCELED Export to reveal.js

Activation

Org Reveal Template

Local Reveal CSS File

References

Yet Another Org-Mode Configuration
Configure org-mode and publish websites.