Org-mode

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search
Org-mode
Org-mode logo
Original author(s)Carsten Dominik
Developer(s)Carsten Dominik et al.
Stable release
9.1.14 / August 23, 2018; 3 months ago (2018-08-23)[1]
Repository Edit this at Wikidata
Written inEmacs lisp
TypePersonal information management, Notetaking, Outlining, Literate programming, Reproducibility
LicenseGPL
Websiteorgmode.org

Org-mode (also: Org mode;[2] /ˈɔːrɡ md/) is a document editing, formatting, and organizing mode, designed for notes, planning, and authoring within the free software text editor Emacs. The name is used to encompass plain 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 the markup 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 includes Org-mode[5] as a major mode by default. Bastien Guerry is the current maintainer, in cooperation with an active development community.[6] Since its success in Emacs, some other systems have also begun providing functions to work with org files.

Almost orthogonally, Org-mode has functionalities aimed at executing code in various external languages ; these functionalities form org-babel, "A Multi-Language Computing Environment for Literate Programming and Reproducible Research".

System[edit]

The Org-mode home page explains that "at its core, Org-mode is a simple outliner for note-taking and list management"[7] 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."[8]

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".[9]

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.

Functionality[edit]

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.[10]
  • Plain text outlines.[11]
A text file showing a tree in emacs org-mode
The same org file shown in overview in emacs org-mode
  • 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, to web pages, within the same file, to other files, 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.

Org-babel[edit]

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 November 2018, org-babel directly supports more than 50 programming languages or programmable facilities, more than 20 other tools being usable via contributed packages or drivers[12].

Integration[edit]

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).[13]

Outside of org-mode editors, org markup is supported by the GitLab and GitHub code repositories,[14] the JIRA issue tracker,[15] Pandoc, and others.

Other than Emacs, systems that handle org files include:

  • Mobile apps:[16]
    • BeOrg for iOS.
    • MobileOrg for iOS.
    • MobileOrg for Android.
    • MobileOrgNG for Android.
    • Orgzly for Android.
  • The Vim text editor, via plugins:[17]
    • VimOrganizer - An Emacs Org-mode clone for Vim.
    • vim-orgmode - Text outlining and task management for Vim based on Emacs Org-mode.
    • VOoM - Outliner including an Org markup mode.
    • vxfold.vim - Fold cycling similar to Emacs Org-mode.
  • Sublime Text editor, with Org syntax and features using its orgmode plugin.[18]

See also[edit]

References[edit]

  1. ^ "Org mode for Emacs – Your Life in Plain Text". orgmode.org. OrgMode team. Retrieved 2016-12-09.
  2. ^ Gmane: Org, Org-mode, Orgmode, Org Mode - Carsten Dominik: Org, the system; Org-mode, the major mode
  3. ^ Dominik, Carsten, Emacs Org-mode: Organizing a Scientist's Life and Work (abstract and video), Max Planck Institute for Neurological Research
  4. ^ Org Mode Manual: History and acknowledgments, Free Software Foundation
  5. ^ Corbet, Jonathan (2006), "Pre-testing Emacs 22", LWN.net
  6. ^ Org mode for Emacs – Community
  7. ^ O'Toole, David, Org tutorial
  8. ^ Dominik, Carsten, Technical description in 24 words
  9. ^ The Linux Information Project: What is plain text?
  10. ^ Chavan, Abhijeet (2007), "Get Organized with Emacs Org-mode", Linux Journal
  11. ^ Chua, Sacha, Outlining Your Notes with Org
  12. ^ "Babel: Languages". Retrieved 25 November 2018.
  13. ^ Org-mode Contributed Packages, and many other hierarchical or list-oriented formats.
  14. ^ GitHub Markup
  15. ^ Bao, Haojun, org-jira
  16. ^ Org mobile apps: BeOrg for iOS, MobileOrg for iOS Archived 2010-03-23 at the Wayback Machine., MobileOrg for Android, MobileOrgNG for Android, Orgzly for Android
  17. ^ Vim plugins for Org-mode functionality: VimOrganizer, vim-orgmode, VOoM, vxfold.vim
  18. ^ Magnusson, Daniel, orgmode

Further reading[edit]

Books[edit]

Journal articles[edit]

External links[edit]