Orgmode syntax

Documentation

syntax docs	https://orgmode.org/quickstart.html
syntax: external links	https://orgmode.org/manual/External-Links.html
syntax: internal links	https://orgmode.org/manual/Internal-Links.html
export-options	https://orgmode.org/manual/Export-Settings.html
recurring tasks, and habit reports	https://orgmode.org/worg/org-tutorials/tracking-habits.html

Components

Export Options

Headers

Tasks

Overview

** WAITING [#B] Clean Kitchen             :kitchen:irl:

 DEADLINE: <2023-01-29 Sun> SCHEDULED: <2023-01-29 Sun>
 :LOGBOOK:
 CLOCK: [2023-01-31 Tue 00:12]--[2023-01-31 Tue 00:13] => 0:01
 CLOCK: [2023-01-30 Mon 23:54]--[2023-01-30 Mon 23:54] => 0:00
 CLOCK: [2023-01-30 Mon 23:53]--[2023-01-30 Mon 23:54] => 0:01
 - State "TODO"       from "DONE"       [2023-01-29 Sun 18:27]
 - State "DONE"       from "TODO"       [2023-01-29 Sun 18:27]

**             # indicates the task nest-depth
[#B]           # is the priority
:kitchen:irl:  # are both tags assigned to this task
DEADLINE       # is when task must be done
SCHEDULED      # when task will show up in agenda (to be done)
:LOGBOOK:      # includes information about state transitions, and clocked time

Dates

• deadlines
• scheduled
• (no key -- will show up in agenda at date/time)

** TODO Clean Kitchen
   DEADLINE: <2022-01-01 Sat> SCHEDULED: <2021-01-15 Wed>   # due sat, scheduled to show in agenda 15
   <2022-01-01 12:00>                                       # will appear in agenda at 12pm

Recurring Dates

You can also schedule recurring tasks, by adding a +2d or +1w. Each time this task is completed, it will be scheduled for it's next date.

** TODO Clean Bathroom
   SCHEDULED: <2023-01-07 Sat +1w>

https://www.gnu.org/software/emacs/manual/html_node/org/Repeated-tasks.html

.+1d     # marking done re-schedules 1 day from now
++1d     # marking done re-schedules at least one day from now, retaining the day of week
+1d      # repeat in exactly 1 day, stacking if missed
.+1d/4d  # marking done re-schedules 1 day from now, habits expects it done at least once every 4 days
+1m -3d  # repeat every month, 3 days before it ends

Tags

Markup

# export-options at top of file
#+title: My Paper
#+author: Darth Vader

# headers
* Heading 1
** Heading 2

# markup
*bold*
/italic/
_underline_
+strikethrough+
~code~
=verbatim=

# lists
1. Foo
  - item a
  - item b
2. Bar
  - item a
  - item b

- [ ] check me
- [x] checked


# code-blocks

#+begin_src python
def foo():
    print('hi')
#+end_src

Links

# external links
[[http://google.com]]          # link
[[http://google.com][google]]  # link with name

# filesystem links
[[file:~/Pictures/foo.png]]    # link to local file

# same-file links
[[*Some Org Mode Header]]      # link to an org-mode header within same file

Tags

https://orgmode.org/manual/Tags.html

• tags support inheritance
• you may pre-define tags globally, and complete them
• you may pre-define tags for a specific file, and complete them

#                         +---+---- these are both tags
#                        /   /
** My Heading     :testing:heading: