Org mode

from Wikipedia, the free encyclopedia
Org mode

Org-mode logo
Basic data

Maintainer Carsten Dominik
developer Bastien Guerry, GNU Project , Carsten Dominik
Publishing year 2003
Current  version 9.3.7
(June 2020)
operating system platform independent ( Emacs )
programming language Emacs Lisp
category Outline Editor , Notebook , Spreadsheet , Personal Information Manager
License GPL
orgmode.org

Org-mode ( also: Org Mode , org mode ) is a program for the free text editor Emacs , which is used to collect notes, draft texts and publish them in various formats . This editing mode also has functions for project planning and task management. All content is recorded in plain text and provided with its own simplified markup language . This file format is therefore also called org-mode. The content created in this way (scientific articles, books) can be exported directly from Org-mode into various target formats without external converters and processed further for production for print and online. Org-mode is an alternative to Markdown ; on GitHub are readme files in the format of Org-mode as Markdown files displayed.

history

The original author of Org-mode was Carsten Dominik, who started developing it in 2003. The project was led by Bastien Guerry from January 2011 to early 2013. With version 8.0 in April 2013, Bastien Guerry resigned as maintainer and Carsten Dominik took over the management of the project again. Org-mode was first officially included in Emacs 22.

The main goal was to develop an editing mode ( major mode ) for Emacs, with which it is possible to enter notes for scientific work, which are available as pure text, and to "organize" them (hence the name Org- mode ) and at the same time combine them with features for project management .

Dominik found the older Outline mode in Emacs to be inadequate for this because it was oriented too much towards an outline with headings and did not support lists. In addition, the keyboard shortcuts seemed too difficult to remember. He imagined a user interface in which the commands can be switched through in one cycle. It should also be possible to rearrange the structure of the notes.

Functions

Outline editor

Org-mode makes Emacs an outline editor (English: Outliner ) that can fold and reorganize hierarchically structured headings with the associated text . Items can be moved together with the sub-items within a list, both vertically (within the order in the list) and horizontally (with regard to the level of detail). Structural elements are highlighted in color.

The text can be formatted and structured in many ways (for example there are markups for bold or italic formatting, for lists and footnotes). Also hyperlinks to external resources can be inserted. An editor is also included, with which tables can be flexibly entered in plain text and also edited afterwards. Simple calculations are also possible in the table .

  • Org-mode as an outline editor for project management

  • By folding the code , only the first structure level can be seen

  • Unfolded: The complete text with all sub-items is displayed

Project management

Each part of the text of an org-mode file can be provided with metadata (keywords, deadlines, time stamps) which are used for project management and project planning . An agenda view can display all time-related metadata in the form of a weekly or daily calendar. For example, you can collect notes or keep a deadline or reminder calendar. These Org-mode works on request with the calendar ( Calendar ) and the diary ( Diary together) Emacs.

Digital publishing

Org-mode has several export filters that can be used to export text written with the mode for publication in HTML , DocBook , LaTeX and ODT . For presentations that can Beamer package for LaTeX be used. This makes Org-mode a general writing and publication environment in which entire projects can be carried out, similar to the older Emacs Muse project, which has not been further developed since 2008. The Pandoc converter also supports the Org-mode format.

Literate programming

Since structure, running text and program source texts can be freely combined with one another, it is also possible to use org-mode for literate programming . The following simple example shows this for an R code. In addition to the instruction, the calculation result is also displayed within the document: 

1 #+BEGIN_SRC R :results value
2 aepfel <- 6
3 birnen <- 4
4 obst <- aepfel + birnen
5 #+END_SRC
6 
7 #+RESULTS:
8 : 10

Its particular strength in connection with Org-Mode is then the export of the calculations and results within the document.

Mobile use

MobileOrg serves as a connection to smartphones and tablets that run on iOS and Android . Free apps are available for this, which can read and edit an export from Org-mode offline.

Example document

#+TITLE:       Die Vorzüge von Org-mode
#+AUTHOR:      Otto Normalverbraucher
#+EMAIL:       [email protected]
#+DATE:        <2018-05-02 Wed>
#+DESCRIPTION: ein Beispieldokument
#+KEYWORDS:    orgmode, wikipedia
#+LANGUAGE:    de

* Eine Überschrift erster Ebene

** Eine Überschrift zweiter Ebene

- Und hier folgen nun die Gliederungspunkte.
- Einer nach dem anderen.
  - Gliederungen können auch
  - geschachtelt
    - werden.
    - Bei Bedarf: Immer weiter einrücken.

** Eine weitere Überschrift zweiter Ebene

Auch Zitate können als solche ausgezeichnet werden:

#+BEGIN_QUOTE
Pageviews of Hawking’s article led the Top-10 across all language
Wikipedias and was the most popular of the month on the Spanish,
German, French, Portuguese, Arabic, Polish, and Farsi Wikipedias (and
probably more). ([[https://en.wikipedia.org/wiki/Wikipedia:Wikipedia_Signpost/2018-04-26/News_and_notes#Death_of_Stephen_Hawking][Wikipedia Signpost]], 26. April 2018)
#+END_QUOTE

* Nächster Abschnitt

Der Text kann auch als Fließtext ausformuliert werden. Auf diese Weise
kann man ganze Bücher schreiben, die später aus Org-mode in
Zielformate exportiert und gesetzt werden können.

literature

  • Abhijeet Chavan: Get Organized with Emacs Org-mode . In: Linux Journal. December 1, 2007. Retrieved February 4, 2012.
  • Carsten Dominik et al .: The Org Mode 8 Reference Manual - Organize your life with GNU Emacs. Samurai Media Limited, Hong Kong 2014, ISBN 978-988-13-2770-3 (printed version of the Org-mode 8.2 manual).
  • S. Khare, Y. Misra, V. Choppella: Using Org-mode and Subversion for Managing and Publishing Content in Computer Science Courses . In: 2012 IEEE Fourth International Conference on Technology for Education . July 18, 2012, p. 220–223 , doi : 10.1109 / T4E.2012.58 ( ieee.org [accessed January 5, 2019]).
  • Rainer König: Order into chaos with org mode . In: free magazine. 10/2009. Pp. 18-25.
  • Orgpaper: Reproducible Research Papers using Org-mode and R: A Guide. In: GitHub. January 10, 2018, accessed on May 2, 2018 (English, Vikas Rawal describes how the book Jomo Kwame Sundaram, Vikas Rawal, Michael T. Clark: Ending malnutrition: from commitment to action . Ed .: Food and Agriculture Organization of the United Nations, Rome, Italy, ISBN 978-92-5108872-2 ( fao.org [PDF]).Written and produced in org-mode; with source code).
  • Eric Schulte, Dan Davison: Active Documents with Org-Mode (PDF; 879 kB). In: Computing in Science & Engineering. May / June 2011. pp. 2–9.
  • Eric Schulte, Dan Davison, Thomas Dye, Carsten Dominik: A Multi-Language Computing Environment for Literate Programming and Reproducible Research . In: Journal of Statistical Software . tape 46 , no. 3 , January 25, 2012, doi : 10.18637 / jss.v046.i03 (released under CC-by 3.0, including the source code in org-mode).

Web links

Individual evidence

  1. ↑ a b c d Carsten Dominik: Emacs Org-mode - a system for note-taking and project planning . GoogleTechTalk. July 15, 2008. Retrieved February 4, 2012.
  2. ^ Maintainer change from Carsten Dominik to Bastien Guerry . In: Mailing List, November 15, 2010. Retrieved June 23, 2013.
  3. ^ Maintainer change from Bastien Guerry to Carsten Dominik . In: Mailing List, April 18, 2013. Retrieved June 23, 2013.
  4. ↑ corbet: Pre-testing Emacs 22 . In: lwn.net. October 31, 2006. Retrieved February 4, 2012.
  5. ↑ The description of the functions follows the manual which is available in Emacs via Info. Online version: The Org Manual . Version 8.0.3. Retrieved June 23, 2013.
  6. ↑ Hendrik Sünkler: Task management in Emacs Org mode. In: suenkler.info. January 1, 2016, accessed September 28, 2016 .
  7. ↑ Emacs Muse. In: gnu.org. April 9, 2016, accessed September 28, 2016 .
  8. ↑ Babel: active code in Org-mode . In: Orgmode.de. Worg. Retrieved February 8, 2012.
  9. ↑ How to Use Emacs Org-Babel Mode to Write Literate Programming Document in R Language . In: Orgmode.de. Worg. Retrieved February 7, 2012.
  10. ↑ Andreas Leha, Tim Beißbarth: The Emacs Org-mode: Reproducible Research and Beyond (PDF; 91 kB). Abstract. Warwick University. Without a date. Retrieved February 7, 2012.
  11. ↑ Eric Schulte, Dan Davison, Thomas Dye, Carsten Dominik: A Multi-Language Computing Environment for Literate Programming and Reproducible Research . In: Journal of Statistical Software. Volume 46, No. 3, January 2012. Retrieved February 11, 2012.
  12. ↑ Documentation . Retrieved February 7, 2012 (documentation for the MobileOrg app for Android on github.com).