sponsor Vim development Vim logo Vim Book Ad

vim-orgmode : Text outlining and task management for Vim based on Emacs' Org-Mode

 script karma  Rating 212/109, Downloaded by 22858  Comments, bugs, improvements  Vim wiki

created by
Jan Christoph Ebersbach
 
script type
ftplugin
 
description
INTRODUCTION                                 *vim-orgmode* *orgguide-introduction*

Vim-orgmode: Text outlining and task management for Vim based on Emacs'
Org-Mode.

The idea for this plugin was born by listening to the Floss Weekly podcast
introducing Emacs' Org-Mode (http://twit.tv/floss136). Org-Mode has a lot of
strong features like folding, views (sparse tree) and scheduling of tasks.
These are completed by hyperlinks, tags, todo states, priorities aso.

Vim-orgmode aims at providing the same functionality for Vim and for command
line tools*.

* for command line tools and other programs a library liborgmode is provided.
  It encapsulates all functionality for parsing and modifying org files.

------------------------------------------------------------------------------
Preface~
   vim-orgmode is a file type plugin for keeping notes, maintaining TODO
   lists, and doing project planning with a fast and effective plain-text
   system. It is also an authoring and publishing system.

   This document is a copy of the orgmode-guide for emacs
   (http://orgmode.org/) with modifications for vim. It contains all basic
   features and commands, along with important hints for customization.

------------------------------------------------------------------------------
Features~
  vim-orgmode is still very young but already quite usable. Here is a short
  list of the already supported features:

  - Cycle visibility of headings
  - Navigate between headings
  - Edit the structure of the document: add, move, promote, denote headings
    and more
  - Hyperlinks within vim-orgmode and outside (files, webpages, etc.)
  - TODO list management
  - Tags for headings
  - Basic date handling
  - Export (via emacs)

  More features are coming...

Feedback~
   If you find problems with vim-orgmode, or if you have questions, remarks, or
   ideas about it, please create a ticket on
   https://github.com/jceb/vim-orgmode
 
install details
Installation~
  Download the latest stable release at
  http://www.vim.org/scripts/script.php?script_id=3642

  Open the vimball archive in vim and source it.

  $ vim orgmode.vba
>
    :so %
<

  ATTENTION: All .pyc files from former versions of vim-orgmode need to be
  deleted before updating!
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
orgmode.vba 0.5.0 2015-10-10 7.3 Jan Christoph Ebersbach See https://github.com/jceb/vim-orgmode/blob/master/CHANGELOG.org
orgmode.vba 0.4.1 2011-12-04 7.3 Jan Christoph Ebersbach - fix cache problems when inserting a new heading, together with multi line text (closes issue #116)
orgmode.vba 0.4.0 2011-10-16 7.3 Jan Christoph Ebersbach - fix broken repeat settings for moving a heading
- improve performance when moving a heading upward or downward (closes issue #108)
- improve performance when changing the level of a heading (related to issue #108)
- extend liborgmode.headings.HeadingList to allow headings to not be tainted when moving them around
- change heading tree text object to ir/ar... because of vim's it/at text object (closes issue #106)
- improve performance when inserting a new heading below (closes issue #105)
- remove duplicate tags (closes issue #104)
- improve performance in insert mode (closes issue #103)
- improve performance when opening larger org files (closes issue #103)
- replace org.txt by orgguide.txt (closes issue #77)
- change g:org_leader to <LocalLeader> (closes issue #101)
  To restore the previous behavior add the following line to your vimrc:
>
  let maplocalleader = ','
<
- change normal command execution to not remap any key (related to issue #85)
- fix regression timeout when opening folds (closes issue #100)
- vim-orgmode multistate documentation (closes issue #77)
- add support for @-signs in tags (closes issue #98)
- enable file completion for hyperlinks by default (closes issue #97)
- fix traceback when pressing <Esc> while editing a link (closes issue #96)
- implement reverse visibility cycling using <S-Tab> (closes issue #95)
- change ,, and ,. to remap zr and zm. (closes issue #73)
- add .cnf files to the vimball archive (closes #93)
- integrate pylint code checker (closes issue #87)
- solve encoding issues in the agenda plugin (closes issue #86)
- add description for writing test cases
- add coverage report target (closes issue #74)
- add support for plain lists, thanks to Aleksandar Dimitrov (closes issue #81)
- add agenda view, many thanks to Stefan Otte (closes issue #34)
- move cursor to the current todo state when selecting the todo state
  interactively (closes issue #61)
- add parameter scope to method settings.get
- add method settings.unset
- fix cursor positioning when selecting todo states
- improve date plugin
- update vba targets to its new name vmb
- demoting a newly created second level heading doesn't cause all children to
  be deleted anymore (closes issue #65)
- add error message for missing dependencies (closes issue #59)
- rename tests directory
- change licensing of the documentation to GNU Free Documentation License
- integrate orgguide (closes issue #57)
- replace DIRECTION_* with an enum (closes issue #56 and issue #49)
orgmode.vba 0.3.1 2011-08-14 7.3 Jan Christoph Ebersbach - demoting a newly created second level heading doesn't cause all children to
  be deleted anymore (closes issue #65)
- add error message for missing dependencies (closes issue #59)
orgmode.vba 0.3 2011-08-09 7.0 Jan Christoph Ebersbach - fix completion menu popup that disappeared because of the usage of vim.command
  (closes issue #48)
- implement interactive todo state selection (closes issue #5)
- add orgmode group to au commands in TagProperties plugin (closes issue #53)
- allow demotion of first level headings (closes issue #27)
- fix encoding issues in Date plugin
- add general support for multiple todo sequences (closes Issue #46)
- fix folded text for headings containing backslashes or double quotes (closes
  issue #26)
- add Document.get_todo_states() and Document.get_all_todo_states()
- don't confuse upper case words at the beginning of a heading with a todo
    state (closes issue #28)
- fix error in setting tags (issue #25)
- improve split of heading (issue #24)
- add variable g:org_improve_split_heading to enable/disable improve the split
  of headings (issue #24)
- implement shortcut for moving to the partent's next sibling (g}) (issue #22)
- fix duplication of children when inserting a new heading (issue #20)
- always start insert mode when adding a new heading (issue #21)
orgmode.vba 0.2.1 2011-06-26 7.3 Jan Christoph Ebersbach - fix encoding of todo states set by the Todo plugin (thanks to Daniel Carl
  and kien for pointing out the issue)
- add documentation for remapping shortcuts
- add documentation for customizing syntax highlighting
orgmode.vba 0.2 2011-06-25 7.3 Jan Christoph Ebersbach Initial upload
ip used for rating: 34.228.239.171

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
Vim at Github