jceb/vim-orgmode

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

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. 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.

Features

Currently vim-orgmode does not support all orgmode features but is quite usable. Short list of the already supported features:

• Syntax highlighting
• Cycle visibility of headings (folding)
• 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
• Lists in alphanumeric and bullet item notation and checkbox support
• Basic date handling
• Export to other formats (via Emacs’ Org-Mode)

Installation and Usage

Installation and usage instructions are found in the file doc/orgguide.txt.

License

Information about the license is found in file LICENSE.

Changelog

All changes are found in file CHANGELOG.org

vim-orgmode's Issues

Start insert mode when adding a new heading

To provide a smoother editing experience insert mode should be started when pressing one of the keybindings for adding a new heading in normal mode.

tab key brings org mode to a halt

thanks for your work on org-mode, whenever I use tab key or shift tab, GVIM or VIM completely locks up. FYI, I'm using the SuperTab plugin (not sure if that would make a difference)

Implement Hyperlinks plugin

Implement Hyperlinks plugin

Text-objects implementation incomplete

Repeat doesn't work for most text-objects neither is a provided count properly evaluated.

Implement agenda view

Implement agenda view

Improve support for external links

Improve support for external links (http://orgmode.org/guide/External-links.html#External-links)

Moving to the partent's next sibling

It often happens to me that I'm in the middle of a heading and want to jump to the next section. This is possible by pressing g{]] but I find this rather cumbersome.

g} should be implemented to allow a fast movement to the parent's next sibling.

Implement sparse tree functionality

Implement sparse tree functionality

Fast searching of tags

There should be a mapping to search for tags very fast. I imaging a prompt where I can type a part of a tag and complete it by pressing . A search filter should be generated that looks something like this: /:\zsTAG\ze:

Implement properties

Implement properties

Implement 'Progress Indicator' for TODO Items

The feature is described here:

http://orgmode.org/guide/Breaking-down-tasks.html#Breaking-down-tasks

I have a working version of this for 'preliborgmode'. I'm going to port it soon...

Implement support for related document

Implement support for related document

What should be a plugin and what should be in the core

I'm not quite sure when i should put something into the core or the plugins. The TODO functionality for example is an essential feature and could get simplified quite a bit if it get's integrated in the lib. I'm not suggesting to do so. I'm simply asking for a guideline.

ALso when should the plugin write in the vim buffer and when should the document object be altered?

Cheers,
Stefan

Error msgs and mappings clash with delimitMate.vim

Error msgs when opening .org files on Windows (gVim 7.3, python 3).

"\bundles\vim-orgmode\README.org"
"\bundles\vim-orgmode\README.org" 439L, 21073C
Error detected while processing \vimfiles\ftplugin\org.vim:
line   83:
E121: Undefined variable: u
E15: Invalid expression: [u'TODO', u'|', u'DONE']
Traceback (most recent call last):
  File "<string>", line 11, in <module>
  File "\vimfiles\ftplugin\orgmode\__init__.py", line 299, in start
    self.register_plugin(p)
  File "\vimfiles\ftplugin\orgmode\keybinding.py", line 16, in r
    p = f(*args, **kwargs)
  File "\vimfiles\ftplugin\orgmode\keybinding.py", line 16, in r
    p = f(*args, **kwargs)
  File "\vimfiles\ftplugin\orgmode\menu.py", line 9, in r
    p = f(*args, **kwargs)
  File "\vimfiles\ftplugin\orgmode\__init__.py", line 257, in register_plugin
    self._plugins[plugin].register()
  File "\vimfiles\ftplugin\orgmode\plugins\Todo.py", line 149, in register
    settings.set(u'org_todo_keywords', [u'TODO', u'|', u'DONE'])
  File "\vimfiles\ftplugin\orgmode\settings.py", line 67, in set
    vim.command((u'let %s:%s = %s' % (VARIABLE_LEADER[scope], setting, v)).encode(u'utf-8'))
vim.error
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line    4:
E225: global mapping already exists for �kb
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   24:
E225: global mapping already exists for �kB
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   29:
E225: global mapping already exists for �kD
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   35:
E225: global mapping already exists for �kl
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   35:
E225: global mapping already exists for �kr
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   42:
E225: global mapping already exists for �ku
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   42:
E225: global mapping already exists for �kd
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line    4:
E225: global mapping already exists for �kb
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   24:
E225: global mapping already exists for �kB
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   29:
E225: global mapping already exists for �kD
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   35:
E225: global mapping already exists for �kl
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   35:
E225: global mapping already exists for �kr
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   42:
E225: global mapping already exists for �ku
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   42:
E225: global mapping already exists for �kd
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line    4:
E225: global mapping already exists for �kb
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   24:
E225: global mapping already exists for �kB
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   29:
E225: global mapping already exists for �kD
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   35:
E225: global mapping already exists for �kl
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   35:
E225: global mapping already exists for �kr
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   42:
E225: global mapping already exists for �ku
Error detected while processing function <SNR>17_DelimitMateDo..<SNR>17_Map..<SNR>17_ExtraMappings:
line   42:
E225: global mapping already exists for �kd

Tabs within a heading title confuse tag auto alignment

Tabs within a heading title confuse tag auto alignment. E.g.

• HeadingTAB1 :Tag:

The tag will not be aligned properly because the tag in the title is counted as one character.

Assigning a list to Heading.tags causes the list to be converted to string

Assigning a list to Heading.tags causes the list to be converted to string

Demoting heading causes endless loop

If you try to demote the last heading in the following sample file with << Vim runs into an endless loop.

$ cat test.org
* Foobar
** Barfoo
** Foo
$

$ vim --version
VIM - Vi IMproved 7.2 (2008 Aug 9, compiled Apr 16 2010 12:40:58)

As it is shipped with Ubuntu 10.04.

make check error

I have always errors on calling make, because the testcases fails.

# make check
cd test && python run_tests.py
Traceback (most recent call last):
  File "run_tests.py", line 4, in 
    import test_vimbuffer
  File "/home/daniel/code/vim/vim-orgmode/test/test_vimbuffer.py", line 10, in 
    from orgmode.document import VimBuffer
  File "../ftplugin/orgmode/__init__.py", line 13, in 
    from orgmode.document   import VimBuffer
  File "../ftplugin/orgmode/document.py", line 4, in 
    from liborgmode import Document, Heading, MultiPurposeList
ImportError: cannot import name MultiPurposeList
make: *** [check] Fehler 1

I can't build any vba file with this error. I don't know if this is related to issu 16.

Daniel

,d keybinding doesn't change todo state

The ,d keybinding doesn't change todo state anymore.

Implement Hyperlinks plugin

Implement Hyperlinks plugin

Improve detection of mapping

Figure out a way to get the keys the user pressed to activate a mapping so that feedkeys can be used properly.

Related: v:operator and maparg() and mapcheck()

Improve context based actions

Org-Mode uses the default mapping to perform different actions depending on the context:

• create new heading
• create new list item
  ...

Demoting a first level heading without title causes first child to be deleted

Demoting a first level heading without title causes first child to be deleted. Somehow the demoting via >> doesn't work when triggered the first time. The second time the first child is deleted an then the heading is demoted two level. - Very strange behavior.

Implement record DONE time

Implement record DONE time

Doc: Adjust orgmode's 'compact guide' to vim-orgmode

In order to get a decent documentation we could take the orgmode 'compact guide' and adjust it to the current vim-orgmode status. The guide also describes the behavior of orgmode and can serve as guideline for the implementation of the orgmode features.

http://orgmode.org/guide/index.html

Implement logging/time tracking plugin

Implement logging/time tracking plugin

Duplication of children when inserting a new heading

When on a heading and the command for creating a new heading is invoked all children of that heading get duplicated. This doesn't happen when the heading is inserted after the last child.

Implement export functionality to other formats

Implement export functionality to other formats

Implement shortcuts for accessing todo states

Implement shortcuts for accessing todo states.

Implement mouse interaction for hyperlinks

Implement mouse interaction for hyperlinks

Errors in Updates

Shift Enter Broken in Recent Updates, doesn't work at all in Normal mode, and when using Insert mode I get the following error:

Error detected while processing InsertLeave Auto commands for "<buffer=1>":
Traceback (most recent call last):
Press ENTER or type command to continue
Error detected while processing InsertLeave Auto commands for "<buffer=1>":
  File "<string>", line 1, in <module>
Press ENTER or type command to continue
Error detected while processing InsertLeave Auto commands for "<buffer=1>":
  File "/home/wavded/.vim/bundle/vim-orgmode/ftplugin/orgmode/plugins/TagsProperties.py", line 100, in realign_tags
Press ENTER or type command to continue
Error detected while processing InsertLeave Auto commands for "<buffer=1>":
    heading = Document.current_heading()    

Implement link to current location

Store a link to the current location (http://orgmode.org/guide/Handling-links.html#Handling-links)

Omni completion menu vanishes when fold is visible

Omni completion menu vanishes when fold is visible in the same window. This is also discussed here http://groups.google.com/group/vim_dev/browse_thread/thread/d686250e5bfaede0/b3915c7edcb1865a?show_docid=b3915c7edcb1865a

The reason is the GetOrgFoldtext() method. I suspect the function is changing vim modes and therefore causing the menu to disappear.

Do a screencast

Do a screencast at Vimeo

Group autocommands in orgmode

Group autocommands in orgmode

Implement support for todo sequences

Implement support for todo sequences

Repeat last movement

It should be possible to easily repeat the last movement. Especially for movements invoked by pressing two keys this would be very beneficial.

chapa implements this by mapping and to repeat movement in the same or in the opposite direction.

Improve split of heading

When the cursor is behind the last character of a heading in insert mode the last character is currently split off. Unfortunately it's not possible to tell the exact position of the cursor. As a workaround the last character should only be split off when the second last character is a space or tab character.

Quote in a heading title causes folded text to display "0"

Quote in a heading title causes folded text to display "0"

Fake todo states confuse Todo plugin

When the first word in a heading is equal to it's upper case representation (word == word.upper()), the Todo plugin assumes it's a todo state. When changing the todo states, the word get's deleted.

Implement lists

Implement lists

Reduce redundancy of DIRECTION_FORWARD and DIRECTION_BACKWARD

Do we really need DIRECTION_FORWARD and DIRECTION_BACKWARD? It's kinda redundant. One (preferably DIRECTION_FORWARD) should be enough.

Defined in liborgmode.py, line 6 and 7:
DIRECTION_FORWARD = True
DIRECTION_BACKWARD = False

Implement calendar for date selection

Implement calendar for date selection

Reference Exampe.py should be PluginExample.py

Cannot build .deb-Package as debian/examples file reference is broken:

Referenced file: Exampe.py
Available file: PluginExample.py

Tags with umlauts are not recognized

Tags with umlauts are not recognized. One can enter them via Tags plugin but auto alignment and editing don't work for them.

Inserting a new heading is very slow

Inserting a new heading below the current one is very slow when the current heading has children. First the children are deleted and then inserted again.

Implement Internal and Targeted links

Implement Internal links (http://orgmode.org/guide/Internal-links.html#Internal-links) and Targeted links (http://orgmode.org/guide/Targeted-links.html#Targeted-links)

Implement Dates and Scheduling plugin

Implement Dates and Scheduling plugin

simple export via Emacs (pdf, html)

pull request July 17, 2011, from sotte:
This uses emacs to achieve a quick export (html and pdf).

see also #50

Todo state colors not defineable

Todo state colors not defineable