Org Mode

https://orgmode.org/
Admin
Org Mode is a GNU Emacs major mode for keeping notes, authoring documents, computational notebooks,...
Tokens:1,902,853
Snippets:16,586
Trust Score:10
Update:6 days ago
Show doc for...
Tokens:
Raw
### Minimal Org mode setup file (minimal-org.el)

Source: https://orgmode.org/manual/Feedback.html

Example contents for a minimal-org.el setup file. It enables debugging and adds the latest Org mode to the load path.

```emacs-lisp
;;; Minimal setup to load latest `org-mode'.

;; Activate debugging.
(setq debug-on-error t
      debug-on-signal nil
      debug-on-quit nil)

;; Add latest Org mode to load path.
(add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))

```

--------------------------------

### Start minimal Emacs session with emacs -Q -l

Source: https://orgmode.org/manual/Feedback.html

Start Emacs with minimal customizations to reproduce a problem. Replace the path with your minimal setup file.

```shell
$ emacs -Q -l /path/to/minimal-org.el

```

--------------------------------

### Start Minimal Emacs Session

Source: https://orgmode.org/elpa.html

Starts Emacs with minimal customizations using a specified setup file, useful for reproducing bugs without interference from user configuration.

```shell
$ emacs -Q -l /path/to/minimal-org.el
```

--------------------------------

### Minimal Org Mode Setup File

Source: https://orgmode.org/elpa.html

Example contents for a minimal-org.el file that activates debugging and adds the latest Org mode to the load path.

```emacs-lisp
;;; Minimal setup to load latest `org-mode'.

;; Activate debugging.
(setq debug-on-error t
      debug-on-signal nil
      debug-on-quit nil)

;; Add latest Org mode to load path.
(add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
```

--------------------------------

### Example of a headline that looks like a source block

Source: https://orgmode.org/worg/org-faq

This example shows a line that looks like a source block start but is actually a headline because it starts with '*'. It illustrates why '*' inside source blocks creates a heading.

```org
* Heading
```

--------------------------------

### STARTUP keyword example

Source: https://orgmode.org/guide/Visibility-Cycling.html

Example of a per-file STARTUP keyword that sets the initial visibility state to 'content'.

```org
#+STARTUP: content

```

--------------------------------

### Colon-prefixed literal example

Source: https://orgmode.org/guide/Literal-examples.html

For small examples, start each line with a colon followed by a space. Additional whitespace before the colon is allowed.

```org
Here is an example
   : Some example from a text file.
```

--------------------------------

### Set up external setup file with #+SETUPFILE

Source: https://orgmode.org/worg/org-release-notes.html

Use this in an Org buffer to load in-buffer options from an external file. The file is scanned for options like #+STARTUP, #+TITLE, or #+OPTIONS.

```org
#+SETUPFILE: "path/to/setup.org"

```

--------------------------------

### Complete setup with all components placeholder

Source: https://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.html

Final Lisp setup with all components enclosed. Evaluate the first line with C-x C-e to load org-publish, then evaluate the last line after every change to org-publish-project-alist.

```emacs-lisp
(require 'ox-publish)
(setq org-publish-project-alist
      '(

       ;; ... all the components ...

      ))

```

--------------------------------

### TODO headline example

Source: https://orgmode.org/org.html

A headline becomes a TODO item when it starts with the word 'TODO'. This example shows a simple TODO entry.

```org
*** TODO Write letter to Sam Fortune

```

--------------------------------

### Setup org-publish-project-alist with placeholder for components

Source: https://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.html

Initial Lisp setup for org-publish-project-alist. Place all component definitions where the comment line is. Evaluate with C-x C-e after adding components.

```emacs-lisp
(require 'ox-publish)
(setq org-publish-project-alist
      '(

       ;; ... add all the components here (see below)...

      ))

```

--------------------------------

### ChangeLog entry example

Source: https://orgmode.org/worg/org-contribute.html

Line 3 of the commit message starts the ChangeLog entry, with entries for every file changed. This example shows entries for org-timer.el functions.

```text
* org-timer.el (org-timer-cancel-timer, org-timer-stop): Enhance
message.
(org-timer-set-timer): Use the number of minutes in the Effort
property as the default timer value.  Three prefix arguments will
ignore the Effort value property.

```

--------------------------------

### Start webserver through screen

Source: https://orgmode.org/worg/blorgit.html

Start the Blorgit webserver using the `run.ru` rackup file with Thin, optionally run inside a screen window.

```bash
./run.ru -sthin

```

--------------------------------

### Use org-info.js with default settings

Source: https://orgmode.org/worg/code/org-info-js/index.html

Include org-info.js and call setup() without any configuration to use the script with its default settings.

```HTML
<script type="text/javascript" src="org-info.js"></script>
<script type="text/javascript">
/* <![CDATA[ */
org_html_manager.setup ();
/* ]]> */
</script>
```

--------------------------------

### Example of an Org table with columns and a horizontal separator

Source: https://orgmode.org/guide/Tables.html

Example Org table with a header, a horizontal separator line, and two data rows. Lines starting with '|' are treated as table parts; '|' separates columns, and lines starting with '|-' are horizontal separators expanded to span the table width on realignment.

```plaintext
| Name  | Phone | Age |
|-------+-------+-----|
| Peter |  1234 |  17 |
| Anna  |  4321 |  25 |

```

--------------------------------

### Call org_html_manager.setup()

Source: https://orgmode.org/worg/code/org-info-js/index.html

Call setup() after configuring options with set(). This initializes the script.

```JavaScript
org_html_manager.setup ();
```

--------------------------------

### Commit message first line example

Source: https://orgmode.org/worg/org-contribute.html

Line 1 of a commit message should be a short description starting with the changed filename followed by a colon. It does not end with a dot or start with a star.

```text
lisp/ol-man.el: Restore file

```

--------------------------------

### Original table for field rearrangement examples

Source: https://orgmode.org/worg/org-hacks.html

Original table used as starting point for the examples that follow, including moving fields, rotating rest of row, and opening fields.

```org
| a | b | c  | d  |
| e | 9 | 10 | 11 |
| f | g | h  | i  |

```

--------------------------------

### Test the package build and installation

Source: https://orgmode.org/worg/org-tutorials/melpa-github.html

Build the package with make and install it manually using Emacs. Replace the recipe name with your own.

```bash
make recipes/orgtbl-ascii-plot
emacs & M-x package-install-file recipes/orgtbl-ascii-plot

```

--------------------------------

### Org File Setup with Front Matter in Export Block

Source: https://orgmode.org/worg/org-tutorials/org-jekyll.html

Shows how to wrap YAML Front Matter in #+BEGIN_EXPORT html so it is exported literally. Includes org startup options and an example excerpt key.

```org
#+STARTUP: showall indent
#+STARTUP: hidestars
#+BEGIN_EXPORT html
---
layout: default
title: Benighted on the Ben.
excerpt: An unplanned bivouac on Ben Nevis.
---
#+END_EXPORT
It was early January when six of us travelled up to ....

```

--------------------------------

### Test imagemagick setup with pdflatex and convert

Source: https://orgmode.org/worg/org-tutorials/org-latex-preview.html

Commands to test the imagemagick setup for LaTeX preview. Run these in a terminal after installing imagemagick. The example.tex file is the same test file used for dvipng.

```shell
cd /tmp
pdflatex /tmp/example.tex
convert /tmp/example.pdf /tmp/example.png
display /tmp/example.png

```

--------------------------------

### Start Sinatra web server

Source: https://orgmode.org/worg/blorgit.html

Start the Blorgit web server using Sinatra.

```bash
ruby blorgit.rb

```

--------------------------------

### Start Emacs with minimal init file on OS X

Source: https://orgmode.org/worg/org-faq

On OS X, use the full path to the Emacs executable to start with the minimal init file. This is the equivalent command for macOS installations.

```shell
/Applications/emacs.app/Contents/MacOS/Emacs -Q -l ~/minimal.emacs
```

--------------------------------

### Fontified code example in HTML export

Source: https://orgmode.org/worg/org-release-notes.html

Use #+BEGIN_SRC with a language identifier to get fontified code in HTML export. Requires htmlize.el version 1.34 or later. For other backends, it is exported as an EXAMPLE block.

```org
#+BEGIN_SRC emacs-lisp
  (defun org-xor (a b)
    "Exclusive or."
    (if a (not b) b))
#+END_SRC

```

```emacs-lisp
(defun org-xor (a b)
  "Exclusive or."
  (if a (not b) b))

```

--------------------------------

### Create blogs directory and apply default theme

Source: https://orgmode.org/worg/blorgit.html

Create a blogs directory in ~/blogs/ with default configuration and apply the default minimal theme. Requires the Emacs server to have been started at least once.

```bash
rake new
rake themes:default

```

--------------------------------

### org_html_manager.setup()

Source: https://orgmode.org/worg/code/org-info-js/index.html

Initializes the org-info.js script with default settings. Must be called after including the script and optionally configuring options via set().

```APIDOC
## org_html_manager.setup()

### Description
Initializes the org-info.js script with default settings. Must be called after including the script and optionally configuring options via set().

### Method
JavaScript function call

### Endpoint
org_html_manager.setup()

### Parameters
None

### Request Example
<script type="text/javascript" src="org-info.js"></script>
<script type="text/javascript">
/* <![CDATA[ */
org_html_manager.setup ();
/* ]]> */
</script>

### Response
No return value.
```

--------------------------------

### Embedded Groff example start and end

Source: https://orgmode.org/worg/org-tutorials/org-e-man-documentation.html

Use this embedded Groff block to mark example text between .EX and .EE. Alternatively, #+BEGIN_EXAMPLE/#+END_EXAMPLE or #+begin_src dummy/#+end_src achieves the same with cross-platform compatible commands.

```groff
#+BEGIN_MAN
.EX

.EE
#+END_MAN

```

--------------------------------

### Clojure session example for ob-clojure with CIDER

Source: https://orgmode.org/worg/org-release-notes.html

Example of Clojure code that can be evaluated in a session initialized via CIDER. The session can be linked to a project, directory, or buffer using sesman, or a new CIDER REPL can be started with cider-jack-in.

```clojure
(dissoc Clojure 'JVM)
(conj clojurists "stardiviner")

```

--------------------------------

### Column View Setup with COLUMNS Property

Source: https://orgmode.org/worg/org-release-notes.html

Example of setting up different column views for different levels of an outline tree using the COLUMNS property. The example defines column sets for People, Family, and Office sections.

```org
* People
  :PROPERTIES:
  :COLUMNS: %25ITEM %Name
  :END:
** Family
   :PROPERTIES:
   :COLUMNS: %25ITEM %Name %3Age
   :END:
*** Sam
    Info about Sam, including a property list with Name and Age.
*** Sarah
    Info about Sarah, including a property list with Name and Age.
** Office
   :PROPERTIES:
   :COLUMNS: %25ITEM %Name %Function %Salary
   :END:
*** Boss
    Info about the Boss, including a property list with Name,
    Function and Salary (if only we knew....).

```

--------------------------------

### Startup option to show 3 levels

Source: https://orgmode.org/worg/org-release-notes.html

Use #+startup: show3levels to start the document with three levels visible. This complements existing options like overview, content, showall, and showeverything.

```org
#+startup: show3levels

```

--------------------------------

### Extract frames from video with MPlayer

Source: https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-screen.html

Extracts frames from the video using MPlayer's PNG output. Set START and SECS variables to control the extraction window; example uses 1:00 start and 10 seconds duration.

```screen
#+begin_src screen :session create-gif
  START=1:00
  SECS=10

  mplayer -ao null -vo png $VIDEOFILE -ss $START -endpos $SECS
#+end_src
```

--------------------------------

### Org startup visibility options

Source: https://orgmode.org/manual/Initial-visibility.html

Add one of these lines anywhere in the buffer to set the initial visibility for the file. The options are: overview, content, showall, show2levels, show3levels, show4levels, show5levels, and showeverything. The default is showeverything.

```org
#+STARTUP: overview
#+STARTUP: content
#+STARTUP: showall
#+STARTUP: show2levels
#+STARTUP: show3levels
#+STARTUP: show4levels
#+STARTUP: show5levels
#+STARTUP: showeverything
```

--------------------------------

### Org mode footnote definition and reference example

Source: https://orgmode.org/guide/Creating-Footnotes.html

Shows the syntax for a footnote reference in text and its definition in a paragraph starting with the marker in square brackets at column 0. The definition paragraph must start with the marker and no indentation is allowed.

```org
The Org website[fn:1] now looks a lot better than it used to.
...
[fn:1] The link is: https://orgmode.org

```
Tokens:
Raw