Org-mode

The Org Mode home page explains that "at its core, Org Mode is a simple outliner for note-taking and list management".{{Citation

|last=O'Toole

|first=David

|title=Org tutorial

|url=http://orgmode.org/worg/org-tutorials/orgtutorial_dto.html

}} The Org system author Carsten Dominik explains that "Org Mode does outlining, note-taking, hyperlinks, spreadsheets, TODO lists, project planning, GTD, HTML and LaTeX authoring, all with plain text files in Emacs."{{Citation

|last=Dominik

|first=Carsten

|title=Technical description in 24 words

|url=http://orgmode.org/worg/org-quotes.html#sec-2-1

}}

The Org system is based on plain text files with a simple markup, which makes the files very portable. The Linux Information Project explains that "Plain text is supported by nearly every application program on every operating system".The Linux Information Project: [http://www.linfo.org/plain_text.html What is plain text?]

The system includes a lightweight markup language for plain text files (similar in function to Markdown, reStructuredText, Textile, etc., with a different implementation), allowing lines or sections of plain text to be hierarchically divided, tagged, linked, and so on.

This section gives some sample uses for the hierarchical display and editing of plain text.

• To-do lists often have subtasks, and so lend themselves to a hierarchical system. Org Mode facilitates this by allowing items to be subdivided into simple steps (nested to-dos and/or checklists), and given tags and properties such as priorities and deadlines. An agenda for the items to be done this week or day can then be automatically generated from date tags.{{Citation

| last=Chavan

| first=Abhijeet

| title=Get Organized with Emacs Org-mode

| journal=Linux Journal

| year=2007

| url=http://www.linuxjournal.com/article/9116

}}

• Plain text outlines.{{Citation

|last=Chua

|first=Sacha

|title=Outlining Your Notes with Org

|url=http://sachachua.com/blog/2008/01/outlining-your-notes-with-org/

}}

File:Org file showing simple planning for a short trip.png

• Org files as interconnected pages of a personal wiki, using the markup for links.
• Tracking bugs in a project, by storing .org files in a distributed revision control system such as Git.
• Extensive linking features, within the same file, to other files, to web pages, to emails, and also allows defining custom links.

An org-mode document can also be exported to various formats (including HTML, LaTeX, OpenDocument or plain text), these formats being used to render the structural outline in an appropriate fashion (including cross-references if needed). It can also use formatting markup (including LaTeX for mathematics), with facilities similar to those present in Markdown or LaTeX, thus offering an alternative to these tools.

File:Org Babel demonstration of basic features.png

Org Mode offers the ability to insert source code in the document being edited, which is automatically exported and/or executed when exporting the document; the result(s) produced by this code can be automatically fetched back in the resulting output.

This source code can be structured as reusable snippets, inserted in the source document at the place needed for logical exposition thus allowing this exposition to be independent of the structure needed by the compiler/interpreter.

Together with the markup facilities of org-mode, these two functionalities allow for

• Literate programming, by decoupling the exposition of the functions of a program from its code structure, and
• Reproducible research, by the creation of a consistent document consolidating exposition, original data, analyses, discussion and conclusion, in a way that can be reproduced by any reader using the same software tools.

As of June 2021, org-babel directly supports more than 70 programming languages or programmable facilities, more than 20 other tools being usable via contributed packages or drivers.{{cite web |title=Babel: Languages |url=https://orgmode.org/worg/org-contrib/babel/languages/ |access-date=7 June 2021}}

Org Mode has some features to export to other formats, and other systems have some features to handle org-mode formats. Further, a full-featured text editor may have functions to handle wikis, personal contacts, email, calendars, and so on; because org-mode is simply plain text, these features could be integrated into org-mode documents as well.

From org-mode, add-on packages export to other markup format such as MediaWiki (org-export-generic, org-export), to flashcard learning systems implementing SuperMemo's algorithms (org-drill, org-learn).[http://orgmode.org/worg/org-contrib/ Org-mode Contributed Packages], and many other hierarchical or list-oriented formats.

Outside of org-mode editors, org markup is supported by the GitLab, GitHub{{Citation

|title=GitHub Markup

|url=https://github.com/github/markup

|date=2023-10-02

}} and Gitea code repositories, the JIRA issue tracker,{{Citation

|last=Bao

|first=Haojun

|title=org-jira

|url=https://github.com/baohaojun/org-jira

|date=2019-12-02

}} Pandoc and others.

Org supports exporting to a variety of formats. Below you may find examples of Org fragments exported to a number of formats.

Other formats are supported by dedicated packages.

{|class="wikitable"

! width="6%" | Format

! width="22%" | Structure

! width="22%" | Text attributes

! width="22%" | Lists

! width="28%" | Images and blocks

|-valign="top"

|

Org

|

• Heading
• Sub heading

Paragraphs are separated

by a blank line.

-----

Five dashes is a horizontal rule.

|

Simple markup produces *bold*

and /italic/ text. There's also

~code~, and other markups.

Here is a link to the

org https://orgmode.org/][homepage.

|

An unordered list:

+ apples

+ oranges

+ pears

An ordered list:

1. lather

2. rinse

3. repeat

|

file:org-mode-unicorn.png

1. +begin_quote

Org blocks start with #+begin_BLOCK

and end with #+end_BLOCK.

This is a quote block.

1. +end_quote

You can also have format-specific markup, for some formats

@@html:like HTML@@

@@latex:like \LaTeX@@.

|-valign="top"

|

HTML

|

1.1 Sub heading

~~~~~~~~~~~~~~~

Paragraphs are separated by a blank line.

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

Five dashes is a horizontal rule.

|

Simple markup produces *bold* and /italic/ text. There's also `code',

and other markups.

Here is a link to the org [homepage].

[homepage]

|

An unordered list:

+ apples

+ oranges

+ pears

An ordered list:

1. lather

2. rinse

3. repeat

|

Org blocks start with #+begin_BLOCK and end with

#+end_BLOCK. This is a quote block.

You can also have format-specific markup, for some formats .

|-valign="top"

|

Markdown

|

1. Heading

1. Sub heading

Paragraphs are separated

by a blank line.

---

Three dashes is a horizontal rule.

|

Simple markup produces **bold**

and *italic* text. There's also

`code`, and other markups.

Here is a link to the

org [homepage](https://orgmode.org/).

|

An unordered list:

- apples

- oranges

- pears

An ordered list:

1. lather

2. rinse

3. repeat

|


> Org blocks start with #+begin_BLOCK

> and end with #+end_BLOCK.

> This is a quote block.

You can also have format-specific markup, for some formats

like HTML

|-valign="top"

|

Texinfo

|

@node Heading

@chapter Heading

@menu

• Sub heading::

@end menu

@node Sub heading

@section Sub heading

Paragraphs are separated

by a blank line.

Five dashes is a horizontal rule.

|

Simple markup produces @strong{bold}

and @emph{italic} text. There's also

@code{code}, and other markups.

Here is a link to the

org @uref{https://orgmode.org/, homepage}.

|

An unordered list:

@itemize

@item

apples

@item

oranges

@item

pears

@end itemize

An ordered list:

@enumerate

@item

lather

@item

rinse

@item

repeat

@end enumerate

|

@image{org-mode-unicorn,,,,png}

@quotation

Org blocks start with #+begin_BLOCK

and end with #+end_BLOCK.

This is a quote block.

@end quotation

You can also have format-specific markup, for some formats.

|}

• Lightweight markup language
• Comparison of notetaking software
• Comparison of document markup languages
• List of personal information managers
• Outliner

{{Reflist|30em}}

• {{cite book

|last=Dominik

|first=Carsten

|others=With contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye

|title=The Org Mode 7 Reference Manual: Organize your life with GNU Emacs

|year=2010

|publisher=Network Theory

|location=UK

|isbn=978-1-906966-08-9

|pages=282

|url=http://www.network-theory.co.uk/org/manual/

|access-date=2012-11-23

|archive-url=https://web.archive.org/web/20121102114420/http://www.network-theory.co.uk/org/manual/

|archive-date=2012-11-02

|url-status=dead

}}

• {{cite journal

|last1=Schulte

|first1=Eric

|last2=Davison

|first2=Dan

|last3=Dye

|first3=Thomas

|last4=Dominik

|first4=Carsten

|date=Jan 2012

|title=A Multi-Language Computing Environment for Literate Programming and Reproducible Research

|journal=Journal of Statistical Software

|volume=46

|issue=3

|pages=1–24

|publisher=American Statistical Association

|doi=10.18637/jss.v046.i03

|issn=1548-7660

|url=http://www.jstatsoft.org/v46/i03

|doi-access=free

}}

• {{cite journal

|last1=Schulte

|first1=E.

|last2=Davison

|first2=D.

|date=May–June 2011

|title=Active Documents with Org-Mode

|journal= Computing in Science & Engineering

|volume=13

|issue=3

|pages=66–73

|publisher=American Institute of Physics, and IEEE Computer Society

|issn=1521-9615

|doi=10.1109/MCSE.2011.41

|citeseerx=10.1.1.226.2202

|bibcode=2011CSE....13c..66S

|s2cid=38470377

}}

• {{Official website|https://orgmode.org/}}

{{EmacsNavbox}}

Category:Distributed bug tracking systems

Category:Emacs modes

Category:Free note-taking software

Category:Free personal information managers

Category:Free spreadsheet software

Category:Free task management software

Category:Lightweight markup languages

Category:Outliners