| Org Mode | |
|---|---|
 | |
| Original author | Carsten Dominik |
| Developers | Carsten Dominik, Bastien Guerry,et al. |
| Initial release | 2003 |
| Stable release | |
| Written in | Emacs Lisp |
| Type | Personal information management,Notetaking,Outlining,Literate programming,Reproducibility |
| License | GPL-3.0-or-later |
| Website | orgmode |
| Repository | |
Org Mode (also:org-mode;[2]/ˈɔːrɡmoʊd/) is amode for document editing, formatting, and organizing within thefree softwaretext editorGNU Emacs and its derivatives, designed fornotes,planning, andauthoring. The name is used to encompassplain text files ("org files") that include simple marks to indicate levels of a hierarchy (such as the outline of an essay, a topic list with subtopics, nested computer code, etc.), and an editor with functions that can read themarkup and manipulate hierarchy elements (expand/hide elements, move blocks of elements, check off to-do list items, etc.).
Org Mode was created by Carsten Dominik in 2003, originally to organize his own life and work,[3] and since the first release numerous other users and developers have contributed to this free software package.[4] Emacs has included Org Mode[5] as a major mode by default since 2006. Bastien Guerry is the maintainer since 2010, in cooperation with an activedevelopment community.[6] Since its success in Emacs, some other systems now provide functions to work with org files.[7][8]
Almost orthogonally, Org Mode has functionalities aimed at executing code in various external languages; these functionalities form org-babel.[9][10]
The Org Mode home page explains that "at its core, Org Mode is a simple outliner for note-taking and list management".[11] The Org system author Carsten Dominik explains that "Org Mode doesoutlining,note-taking,hyperlinks,spreadsheets,TODO lists,project planning,GTD,HTML andLaTeX authoring, all with plain text files in Emacs."[12]
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".[13]
The system includes alightweight markup language for plain text files (similar in function toMarkdown,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.
An org-mode document can also be exported to various formats (includingHTML,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.
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
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.[16]
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 othermarkup format such asMediaWiki (org-export-generic, org-export), toflashcard learning systems implementingSuperMemo's algorithms (org-drill, org-learn).[17]
Outside of org-mode editors, org markup is supported by theGitLab,GitHub[18] andGitea code repositories, theJIRA issue tracker,[19]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.
| Format | Structure | Text attributes | Lists | Images and blocks |
|---|---|---|---|---|
Org | * Heading** Sub headingParagraphs are separatedby 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 theorg[[https://orgmode.org/][homepage]]. | An unordered list:+apples+oranges+pearsAn ordered list:1. lather2. rinse3. repeat | [[file:org-mode-unicorn.png]]#+begin_quoteOrg blocks start with #+begin_BLOCKand end with #+end_BLOCK.This is a quote block.#+end_quoteYou can also have format-specific markup, for some formats@@html:like<abbr title="Hypertext Markup Language">HTML</abbr>@@@@latex:like \LaTeX@@. |
HTML | <divid="outline-container-org75efe15"class="outline-2"><h2id="org75efe15"><spanclass="section-number-2">1</span> heading</h2><divclass="outline-text-2"id="text-1"></div><divid="outline-container-org548173a"class="outline-3"><h3id="org548173a"><spanclass="section-number-3">1.1</span> Sub heading</h3><divclass="outline-text-3"id="text-1-1"><p>Paragraphs are separatedby a blank line.</p><hr/><p>Five dashes is a horizontal rule.</p></div></div> | <p>Simple markup produces<b>bold</b>and<i>italic</i> text. There's also<code>code</code>, and other markups.</p><p>Here is a link to theorg<ahref="https://orgmode.org/">homepage</a>.</p> | <p>An unordered list:</p><ulclass="org-ul"><li>apples</li><li>oranges</li><li>pears</li></ul><p>An ordered list:</p><olclass="org-ol"><li>lather</li><li>rinse</li><li>repeat</li></ol> | <divid="org0d245af"class="figure"><p><imgsrc="org-mode-unicorn.png"alt="org-mode-unicorn.png"/></p></div><blockquote><p>Org blocks start with #+begin<sub>BLOCK</sub>and end with #+end<sub>BLOCK</sub>.This is a quote block.</p></blockquote><p>You can also have format-specific markup, for some formatslike<abbrtitle="Hypertext Markup Language">HTML</abbr>.</p> |
HTML (rendered) | Heading Sub heading Paragraphs are separatedby a blank line. Five dashes is a horizontal rule. | Simple markup producesboldanditalic text. There's also Here is a link to theorghomepage. | An unordered list:
An ordered list:
|
You can also have format-specific markup, for some formatslikeHTML. |
\section{Heading}\label{sec:orgb1c599c}\subsection{Sub heading}\label{sec:orgf23aeb1}Paragraphs are separatedby a blank line.\noindent\rule{\textwidth}{0.5pt}Five dashes is a horizontal rule. | Simple markup produces\textbf{bold}and\emph{italic} text. There's also\texttt{code}, and other markups.Here is a link to theorg\href{https://orgmode.org/}{homepage}. | An unordered list:\begin{itemize}\item apples\item oranges\item pears\end{itemize}An ordered list:\begin{enumerate}\item lather\item rinse\item repeat\end{enumerate} | \begin{center}\includegraphics[width=.9\linewidth]{org-mode-unicorn.png}\end{center}\begin{quote}Org blocks start with\#+begin\textsubscript{BLOCK}and end with\#+end\textsubscript{BLOCK}.This is a quote block.\end{quote}You can also have format-specific markup, for some formatslike\LaTeX. | |
<text:htext:style-name="Heading_20_1"text:outline-level="1"text:is-list-header="false"><text:bookmark-starttext:name="OrgXref.org3c83460"/><text:bookmarktext:name="org3c83460"/>Heading<text:bookmark-endtext:name="OrgXref.org3c83460"/></text:h><text:htext:style-name="Heading_20_2"text:outline-level="2"text:is-list-header="false"><text:bookmark-starttext:name="OrgXref.orgeb4e8ed"/><text:bookmarktext:name="orgeb4e8ed"/>Subheading<text:bookmark-endtext:name="OrgXref.orgeb4e8ed"/></text:h><text:ptext:style-name="Text_20_body">Paragraphsareseparatedbyablankline.</text:p><text:ptext:style-name="Horizontal_20_Line"></text:p><text:ptext:style-name="Text_20_body">Fivedashesisahorizontalrule.</text:p> | <text:ptext:style-name="Text_20_body">Simplemarkupproduces<text:spantext:style-name="Bold">bold</text:span>and<text:spantext:style-name="Emphasis">italic</text:span>text.There'salso<text:spantext:style-name="OrgCode">code</text:span>,andothermarkups.</text:p><text:ptext:style-name="Text_20_body">Hereisalinktotheorg<text:axlink:type="simple"xlink:href="https://orgmode.org/">homepage</text:a>.</text:p> | <text:listtext:style-name="OrgBulletedList"text:continue-numbering="false"><text:list-item><text:ptext:style-name="Text_20_body">apples</text:p></text:list-item><text:list-item><text:ptext:style-name="Text_20_body">oranges</text:p></text:list-item><text:list-item><text:ptext:style-name="Text_20_body">pears</text:p></text:list-item></text:list><text:ptext:style-name="Text_20_body">Anorderedlist:</text:p><text:listtext:style-name="OrgNumberedList"text:continue-numbering="false"><text:list-item><text:ptext:style-name="Text_20_body">lather</text:p></text:list-item><text:list-item><text:ptext:style-name="Text_20_body">rinse</text:p></text:list-item><text:list-item><text:ptext:style-name="Text_20_body">repeat</text:p></text:list-item></text:list> | <text:ptext:style-name="Text_20_body"><draw:framedraw:style-name="OrgDisplayImage"svg:width="6.24cm"svg:height="6.88cm"text:anchor-type="paragraph"draw:name="Frame1"><draw:imagexlink:href="Images/0001.png"xlink:type="simple"xlink:show="embed"xlink:actuate="onLoad"/></draw:frame></text:p><text:ptext:style-name="Quotations">Orgblocksstartwith#+begin<text:spantext:style-name="OrgSubscript">BLOCK</text:span>andendwith#+end<text:spantext:style-name="OrgSubscript">BLOCK</text:span>.Thisisaquoteblock.</text:p><text:ptext:style-name="Text_20_body">Youcanalsohaveformat-specificmarkup,forsomeformats.</text:p> | |
ASCII | 1 Heading=========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]<https://orgmode.org/> | An unordered list:+apples+oranges+pearsAn ordered list:1. lather2. rinse3. repeat | <file:org-mode-unicorn.png> 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 . |
<a id="orgfcf266c"></a># Heading<a id="org6c11f38"></a>## Sub headingParagraphs are separatedby 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 theorg [homepage](https://orgmode.org/). | An unordered list:- apples- oranges- pearsAn ordered list:1. lather2. rinse3. repeat | >Org blocks start with #+begin<sub>BLOCK</sub>>and end with #+end<sub>BLOCK</sub>.>This is a quote block.You can also have format-specific markup, for some formatslike <abbr title="Hypertext Markup Language">HTML</abbr> | |
@node Heading@chapter Heading@menu* Sub heading::@end menu@node Sub heading@section Sub headingParagraphs are separatedby 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 theorg @uref{https://orgmode.org/, homepage}. | An unordered list:@itemize@itemapples@itemoranges@itempears@end itemizeAn ordered list:@enumerate@itemlather@itemrinse@itemrepeat@end enumerate | @image{org-mode-unicorn,,,,png}@quotationOrg blocks start with #+begin_BLOCKand end with #+end_BLOCK.This is a quote block.@end quotationYou can also have format-specific markup, for some formats. |
| Implementations |
|  | ||||
|---|---|---|---|---|---|---|
| Modes | ||||||
| Internals | ||||||
| Community |
| |||||
| Other | ||||||
