example Modern Org Example

tags : Emacs, Org-mode

This example Org file demonstrates the Org elements, which are styled by org-modern.

---

Headlines

Second level

Third level

• Fourth level

  • Fifth level

Task Lists [1/3]

• Write org-modern
• [-] Publish org-modern
• Fix all the bugs

List Bullets

• Dash
• Plus
• Asterisk

Timestamps

SCHEDULED: <2022-02-25 Fri 10:00> DRANGE: [2022-03-01 Tue]–[2022-04-01 Fri] DRANGE: <2022-03-01 Tue>–<2022-04-01 Fri> TRANGE: [2022-03-01 Tue 10:42-11:00] TIMESTAMP: [2022-02-21 Mon 13:00] DREPEATED: <2022-02-26 Sat .+1d/2d> TREPEATED: <2022-02-26 Sat 10:00 .+1d/2d>

Blocks

;; Taken from the well-structured Emacs config by @oantolin.
;; Take a look at https://github.com/oantolin/emacs-config!
(defun command-of-the-day ()
  "Show the documentation for a random command."
  (interactive)
  (let ((commands))
    (mapatoms (lambda (s) (when (commandp s) (push s commands))))
    (describe-function (nth (random (length commands)) commands))))

taylor(sin(x),x=0,3)

printf("a|b\nc|d\n");

Todo Labels and Tags

DONE Write org-modern emacsfosscoding

TODO Publish org-modern

WAIT Fix all the bugs

Priorities

DONE Most important

TODO Less important

CANCEL [#C] Not that important

DONE [100%] [#A] Everything combined tagtest

• First
• Second
• Third

Tables

N	N^2	N^3	N^4	sqrt(n)	sqrt4
2	4	8	16	1.4142	1.1892
3	9	27	81	1.7321	1.3161

N	N^2	N^3	N^4	sqrt(n)	sqrt4
2	4	8	16	1.4142	1.1892
3	9	27	81	1.7321	1.3161

This is the example org-mode file used for the Denver Emacs org-mode introduction talk. Everything in this talk should work without any custom settings or installation with a reasonably recent Emacs version.

Let’s start with a headline, this is kind of like Markdown’s # character:

This is an example headline

Text can be put into the headline. You can create another headline at the same level with another * character

Another headline

Nesting headlines is as easy as adding another start

Nested headline

Another nested headline

Deeper

Another headline

• Deeper…

  • Deeper…

Basic markup

You can really go as deep as you want. This is the general building block for org-mode navigation.

Next, let’s talk about some markup

• underscores let you underline things
• stars add emphasis
• slashes are italics
• pluses are strikethrough
• equal signs are verbatim text
• tildes can also be used

You can generate lists with the - character (seen above), or create numbered ones:

1. Number one thing
2. Number two thing
3. Number three

Showing and hiding headlines

You can hide the contents of a headline by putting the point (cursor) or it and hitting TAB.

You can also toggle hiding and showing of all headlines with SHIFT-TAB.

Tables

Auto expanding tables are one of the coolest features of org-mode, because tables in Markdown just plain suck. In order to create a new table, you can start typing it manually, or press C-c |, which will prompt for the table’s dimensions.

First Name	Last Name	Years using Emacs
Lee	Hinman	5
Mike	Hunsinger	2
Daniel	Glauser	4
Really-long-first-name-guy	long-last-name-pers	1

Org-mode links

:PROPERTIES:…

In an org-mode file, you can press C-c l to store a pointer to wherever you are in the file. Then, with (or without) text highlighted hit C-C C-l to make it into a link. The example file for Magit If you don’t want to store a pointer (ie, link to a website or something), you can just hit C-c C-l and type or paste the link. To manually create a link, do something like:

The Denver Emacs Meetup Group

Writequit site

Google’s web site

(ignore the *_SRC blocks for now, we’ll get there)

[[http://google.com/][Google]]

You can link to files, images, websites, emails, irc, and all kinds of things.

Various things you can add in headers

One of the most common uses for org-mode is a sort of “task list” or TODO list. Org-mode supports this by allowing markers in the headline for the state of a task. Let’s look at an example:

TODO This is a task that needs doing

TODO Another todo task

• sub task one
• sub task two
• sub task three

Learn about org-mode

TODO learn todos

TODO learn other stuff

You can toggle each task in a list with the C-c C-c keyboard shortcut.

DONE I’ve already finished this one

You can change the status of a task by hitting C-c t in the body of a task anywhere, which will prompt for the state to put it in.

You can create as many of these as you’d like, for example (from my own config, use what works best for you, configuring them is a little out of scope right here) here’s what I use:

TODO something that needs doing

DONE something that’s already done

INPROGRESS something I’m currently doing

WAITING waiting for someone else before doing anything

NEEDSREVIEW there’s a PR for this, it needs someone to look at it

HOLD this is in permanent hold until further notice

CANCELLED I don’t need this any more

SOMEDAY I’d like to do this someday in the waaaaay off future

A lot of people just use “TODO” and “DONE” though.

Adding tags and priorities

You can add tags by putting them surrounded in ”:” in the headline. Additionally, priorities

Headline with a tag org

Another tagged headline turingdenver

Headline with multiple tags orgemacs

Tags are just another way of organizing things.

Important task

Medium task

Non-important task

Again you can configure these, or just use the 3 built in ones.

TODO [1/3] Task with sub headlines

• TODO Finish thing

• TODO Finish that other thing

• DONE Done with a thing

[33%] Task with sub headlines (percent cookie)

• TODO Finish thing

• TODO Finish that other thing

• DONE Done with a thing

The TODO-planner payoff

:PROPERTIES:… So TODOs are all well and good, but what is a really neat feature is when you can easily capture new TODOs and display them easily.

In order to do this, let’s configure a couple of Emacs options in your emacs init:

(require 'org)
;; Setup C-c c to capture new TODOs
(global-set-key (kbd "C-c c") 'org-capture)
;; Setup a key bind for the agenda
(global-set-key (kbd "C-c a") 'org-agenda)
;; Set up agenda to know about our file, you can use a list of files or
;; directories here
(setq org-agenda-files '("~/todo.org"))
;; A new template
(setq org-capture-templates
      '(("t" "Todo" entry (file "~/todo.org")
         "* TODO %?\n%U\n")))

Now, hit C-c c to bring up the capture template list, then t to capture a new TODO item.

Once you’ve captured a few TODOs, you can try out the agenda by hitting C-c a, which will prompt for what agenda you’d like to see, for now hit t to see the TODO list agenda.

Exporting an org-mode buffer

Org has a lot of export options, they are all contained behind a C-c C-e export backend, exporting to HTML, markdown, plain text, pdf, etc.

Show off other features of org-mode if we have more time

Maybe not in excruciating detail, but we can show off the power and cover it in more detail at a later time:

• refiling (org-refile)
• source code blocks
• org-babel
• clocking in/out
• table formulas
• custom agenda views
• capturing notes (not just TODOs)
• publishing projects remotely via TRAMP

$a+b$

(defun my/function ()
  "docstring"
  (interactive)
  (progn
    (+ 1 1)
    (message "Hi")))

echo $data > /tmp/foo
for i in `cat /tmp/foo`; do
  echo $i
done

echo "hi"

# do some things
echo "stuff"
echo "more stuff"
echo <<hi>>

To enter and edit a block of text, use C-c C-'