Org

From WikEmacs
Revision as of 12:18, 9 January 2017 by Elvince (talk | contribs) (→‎Extensions: toc-org)
Jump to navigation Jump to search
Org,Org-Mode
Description GTD and document authoring package/markup language
Author Carsten Dominik
Maintainer Bastien Guerry
Source http://orgmode.org/w/org-mode.git
Part of Emacs yes (likely be out of date)

Org is an Emacs mode for keeping notes, maintaining TODO lists, project planning, outlining, and authoring with a fast and effective plain-text system. Org Mode is simple enough to start using right away, but provides tons of advanced features to support a wide variety of tasks and workflows.

Org-Mode is distributed with Emacs (since Emacs 22.2). This project is under active development and new releases are often available.

Features

  • Simple plain text markup for hierarchical documents.
  • Built-in table editor: easily format tables and work with spreadsheets in plain text.
  • Extensible hyperlinking: create cross-references, link to external resources, and more.
  • Capture system: create templates to quickly capture and file notes and tasks.
  • Sequences of TODO-style keywords for task progress tracking.
  • Tags, priorities and properties to categorize, sort, filter, and search.
  • Custom project views using Org's Agenda.
  • Convenient date/time handling for timestamps, deadlines, and scheduling.
  • Clock support to track time spent on projects.
  • Export from plain-text to a variety of formats (HTML, LaTeX, DocBook, etc).
  • Embedded source blocks: edit code blocks in-line with the appropriate mode. Execute code blocks to generate content. Org can even be used for literate programming.
  • Mobile support providing a subset of Org capabilities on iOS and Android devices.

External Links

The Org-Mode project maintains excellent documentation and has an active community.

Extensions

Org-wiki

org-wiki allows to easily create links and browse them (helm integration).

Find files and headlines anywhere, anytime, by indexing them in a database

This is the approach taken by John Kitchin who handles thousands of org files: http://kitchingroup.cheme.cmu.edu/blog/2017/01/03/Find-stuff-in-org-mode-anywhere/

Admittedly its current approach is a bit tedious since one has to write sql queries, also there is not all the possible features yet, like an ignore pattern.

Generate an inline table of contents (toc) for github readmes

That's possible with toc-org, available in melpa. We set an heading as :TOC: and then we can call M-x toc-org-insert-toc or make it update the toc at every file save.

See also

Deft, to browse and edit directories of plain text notes

Deft, an Emacs mode for quickly browsing, filtering, and editing directories of plain text notes, inspired by Notational Velocity. It can be a way to leverage the process of taking notes in several org files.