emacs with org-mode - universität münster · emacs with org-mode christoph lehrenfeld...

Emacs with org-mode

Christoph Lehrenfeld([email protected])

November 4, 2015living knowledgeWWU Münster

WESTFÄLISCHEWILHELMS-UNIVERSITÄTMÜNSTER

livin

gkn

owle

dge

WW

UM

ünst

er

WESTFÄLISCHEWILHELMS-UNIVERSITÄTMÜNSTER Emacs with org-mode 2 /31

Outline

Emacs

org-mode

Resources

Christoph Lehrenfeld ([email protected])

livin

gkn

owle

dge

WW

UM

ünst

er


Outline

Emacs

org-mode

Resources


livin

gkn

owle

dge

WW

UM

ünst

er


Emacs - (More than) another editor

I Main developer: Richard Stallman

history

I 1976-1979, Greenberg: Collection of Macros(“Editor MACroS”) with Maclisp

I 1981, Gosling: erster Emacs (in C)with rudimentary scripting language (Mocklisp)

I 1984, Stallman: GNU Emacs(first GNU project) in Emacs Lisp (dialect to lisp)


livin

gkn

owle

dge

WW

UM

ünst

er


Features (a few)

I terminal-basedI keystrokes - independence of mouse (faster/remote access)I support for many programming languagesI lots of included features (games/calendar/shell/. . . )I lots of extensions for special featuresI highly customizableI self-documenting (good manual-structure)


livin

gkn

owle

dge

WW

UM

ünst

er


Getting started

I No how-to-use, rather motivation for emacs (or similar eds.)I nice video tutorials: hack-emacs

help commands:

C-h t start a tutorial for emacsC-h b shows all active key bindingsC-h k displays command of a key bindingC-h f explains functionM-x TAB search/browse available functions (e.g. kill-emacs)

C-h t means pressing Control(C) and the t-key followed by (only) thet-key.


https://www.youtube.com/playlist?list=PLABBCB510477C08DB

livin

gkn

owle

dge

WW

UM

ünst

er


My mostly used features (1)

I standard editor features(fast): (search, mark, replace, . . . )I modes: add functionality and adapt to file-type (buffer-type)I macros (sequence of commands: record and replay)

coding:

I autocompletion, tags (index of key words and ‘jump’ access todefinitions)

I sessions (set of “buffers” for a project)I compilation-mode (error/warnings jump to line)


livin

gkn

owle

dge

WW

UM

ünst

er


My mostly used features (2)

latex:

I flyspell-mode (spell checker)I preview-latex, “compilation”, reftex-mode (list-access to

labels, bib-entries..)

org-mode

I taking notes / preparation of talks / documentationI export to html/latex/beamer/pdf/markdown (/ source code)


livin

gkn

owle

dge

WW

UM

ünst

er


Usage of features

How to use all these features?


livin

gkn

owle

dge

WW

UM

ünst

er


shortcuts/keystrokes for everything

https://xkcd.com/378/



livin

gkn

owle

dge

WW

UM

ünst

er


My emacs

It doesn’t matter what your editor is capable of!

I availability of features (fast/simple)I good documentationI features should help you

How do I get my emacs to do what I want?


livin

gkn

owle

dge

WW

UM

ünst

er


customization

Set Preferences

user interface via “M-x customize-variable”

Extend basic settings with config-files

I Bind your keys to (sequences of) commandsI How do I do that ?


livin

gkn

owle

dge

WW

UM

ünst

er


emacs lisp

I scripting language (dialect to lisp)I emacs is written in emacs lisp (and C)I your configuration files are written in emacs lispI makes emacs highly customizable

key bindings

(global-set-key (kbd "M-r") ’recompile)(global-set-key (kbd "<f5>") ’revert-buffer)


livin

gkn

owle

dge

WW

UM

ünst

er


emacs lisp (more advanced)

(sort of) new functionality

(defun prelude-google ()"Googles a query or region if any."(interactive)(browse-url(concat"http://www.google.com/search?ie=utf-8&oe=utf-8&q="(if mark-active

(buffer-substring (region-beginning) (region-end))(read-string "Google: ")))))


livin

gkn

owle

dge

WW

UM

ünst

er


high level of customization




livin

gkn

owle

dge

WW

UM

ünst

er


some remarks on emacs

I There are other nice text editors out there (Sublime, vi(m), ..)I cedet is an IDE for emacs (. . . )I REPL (Read-eval-print loop) for script languages (python, lisp,

..) can nicely be done with emacsI Not everybody loves emacs: “a great operating system, lacking

only a decent editor”


livin

gkn

owle

dge

WW

UM

ünst

er


There are other good editors


livin

gkn

owle

dge

WW

UM

ünst

er


Outline

Emacs

org-mode

Resources


livin

gkn

owle

dge

WW

UM

ünst

er


Origin and goals

I Original developer: Carsten DominikI Created 2003 to organize his life and work as a scientistI slogan: “org-mode: Your life in plain text”I aims:

I note takingI project planningI authoring (e.g. this talk!)I documentation (source code, literate programming)


livin

gkn

owle

dge

WW

UM

ünst

er


Main features

I everything in plain text (version control)(similar to Wiki-world but better!)

I outliningI note-takingI hyperlinksI spreadsheet featuresI TODO listsI literate programming (org-babel)

I documentation contains source code which can be extracted

I an emacs-mode


livin

gkn

owle

dge

WW

UM

ünst

er


org-mode as an emacs-mode

Emacs-mode

I highly customizableI integrates into other modes (latex/c++/..)I is bound to emacs :(


livin

gkn

owle

dge

WW

UM

ünst

er


org-mode files as documents

Similar to Wikis

I listsI tablesI formulas (full latex!)I imagesI hyperlinksI . . .

Exports to HTML/latex/beamer/pdf/markdown/ . . .


livin

gkn

owle

dge

WW

UM

ünst

er


Note-taking example


livin

gkn

owle

dge

WW

UM

ünst

er


Literate programming

Write documentation around your source code.

I Extensive documentation of your source codeI Extract source code from the same file as the documentation!

1 double myf(double x)2 {3 return sqrt(x)+sqrt(1-x)+1-2.0*x;4 }


livin

gkn

owle

dge

WW

UM

ünst

er


Working with source code (org-babel) (octave)


livin

gkn

owle

dge

WW

UM

ünst

er


Working with source code (org-babel) (octave)

Octave code

A = [1,3;9,26];

[eigvec,eigval]=eig(A)

The output

eigvec =

-0.94513 -0.114460.32670 -0.99343

eigval =

Diagonal Matrix

-0.036986 00 27.036986


livin

gkn

owle

dge

WW

UM

ünst

er


Working with source code (org-babel) (python)

Python code

a = ["apfel","gurken","elefanten"]b = ["baum","truppe","parkschein"]c = [ c+d for [c,d] in zip(a,b)]print(c)

The output

[’apfelbaum’, ’gurkentruppe’, ’elefantenparkschein’]


livin

gkn

owle

dge

WW

UM

ünst

er


Working with source code (org-babel) (shell)

Shell code

uname -o -n -remacs --version | head -n 1grep "model name" /proc/cpuinfo | head -n 1

The output

schrustux 4.1.4-1-ARCH GNU/LinuxGNU Emacs 24.5.1model name : Intel(R) Core(TM) i5-4300U CPU @ 1.90GHz


livin

gkn

owle

dge

WW

UM

ünst

er


Working with source code (remarks)

I result-regions are created in org-mode onI demand (C-c C-c)I export

I export of documentation into several filesI well-suited for tutorials or lectures

(source code is exactly the same as in the documentation!)


livin

gkn

owle

dge

WW

UM

ünst

er


Outline

Emacs

org-mode

Resources


livin

gkn

owle

dge

WW

UM

ünst

er


links/references

I emacsI https://www.gnu.org/software/emacs/

I org-modeI http://orgmode.org/manual/

I both:I hack-emacs (youtube tutorials for emacs/org-mode)


https://www.gnu.org/software/emacs/

http://orgmode.org/manual/

https://www.youtube.com/playlist?list=PLABBCB510477C08DB

emacs with org-mode - universität münster · emacs with org-mode christoph lehrenfeld...

Documents