sponsor Vim development Vim logo Vim Book Ad

VimOrganizer : An Emacs' Org-mode clone for Vim

 script karma  Rating 162/82, Downloaded by 3560    Comments, bugs, improvements  Vim wiki

created by
Herbert Sitz
 
script type
ftplugin
 
description
VimOrganizer version 0.31, November 8, 2011.  Requires Vim version that
is compiled with support for folding and tabs.  Conceal will
be taken advantage of if working with Vim73 supporting conceal.  
(Also, I STRONGLY suggest that you apply a patch to Vim so that
folded headings can have level-dependent highlighting,
patch for Vim73 is in contrib directory of the download.  If you're on
Windows contact me and I should be able to provide you with an
executable.  If I hadn't been able to make Vim do this I would have
bitten the bullet and moved to Emacs, as much as I hate editing in Emacs.)

Video showing some of the new features is here:
http://vimeo.com/31531308 (showing colorscheme support, narrowing, links,
                                                 general document authoring support)
http://vimeo.com/31564708 (showing excellent export to
                                                  LibreOffice/MS Word format)

VimOrganizer is a Vim filetype plugin that attempts to clone Emacs' Org-mode.  
It is currently (November 2011) in an alpha-stage, both in terms of (1) the
breadth and depth of Org-mode features it clones and (2) the stability of its
operation.  It is nevertheless very usable.

Some of the ADDITIONS AND IMPROVEMENTS since previous (December 2010) version:
   -- Adjusts to any colorscheme
   -- Org menu in gvim.
   -- "Dashboards" to assist with Date entry, Columns, Tables,
      Agenda searches, and exporting.
   -- VimOrganizer help file to install in Vim.
   -- Better compatibility with Org-mode files.  Open, edit, and save same
      files in Org-mode and/or VimOrganizer with (some) of the functionality and
      configuration-specific options of Org-mode supported in VimOrganizer.
   -- Support for Org-mode style links (as well as use of 'Conceal' in Vim73
                                        to hide link brackets and
                                        descriptions)
   -- Easy to use Org-like column mode, including column headings,
      inherited columns, support for Org column blocks, and ability to
      specify a list of custom column specs to apply in any buffer.
   -- Org-like narrowing of code blocks and subtrees
   -- Support for Org-like specifications of TODOS, tags, dates,
      including support for Org-compatible config lines in a file.
   -- Support for Org-like CATEGORIES, both in specification and in
      their inherited behavior.
   -- Search specification in Agenda searches is now nearly identical
      to specification of searches in Org-mode.
   -- User can specify list of commonly used custom agenda searches.
   -- Clockin, clockout, and (when a running Emacs server is available,
      clocktable block creation and updates.
   -- Org-like "refiling"
   -- Easy creation and editing of tables, as well as (when a running Emacs
      server is available) manipulation and evaluation of tables, including
      all spreadsheet functionality in Org-mode.
   -- "Live" block evaluation (when a running Emacs server is available)
   -- Support for nearly all the export types and export options
      available in Org-mode (when running Emacs server is available)
   -- Call out to an Emacs server to do "tangling" (literate programming).
   -- Many bug fixes and small improvements

Org-mode, and thus VimOrganizer, is a text-editor plugin/application that can
be used for (1) keeping notes, (2) maintaining TODO lists, (3) planning
projects, and/or (4) authoring and publishing documents, including support for
literate programming and "reproducible research".  Like Org-mode, VimOrganizer
does this by implementing a flexible plain-text system with a lightly
structured document format.  Org-mode has been in constant development for
seven or eight years, and continues to be developed.  Work on VimOrganizer is
likewise ongoing, but VimOrganizer is at present a smaller and less ambitious
project than Org-mode.

File formats and basic workflows for VimOrganizer and Org-mode are very
similar (files auto-convert as part of loading process) and VimOrganizer
actually calls out to an Emacs' Org-mode server to
implement important features, e.g., exporting to pdf format for printing.

Thus, to make full use of VimOrganizer you will want to have an Emacs'
server running alongside.  In most cases this requires little knowledge of
Emacs other than how to start it up and add a few lines to the '.emacs' file,
Emacs' counterpart to Vim's '.vimrc'.  (You can even edit the .emacs file in
Vim.)  VimOrganizer is focused on leveraging Org-mode by accessing it via
an Emacs server, and re-implementing in Vim only what is necessary and makes
sense.

VimOrganizer also lets Vim users access Org-babel, a subproject of
Org-mode that allows execution of source-code blocks in org-format
documents.  Uses for Org-babel range from writing technical research papers to
simply using a VimOrganizer document as a "language-scratchpad".  Over
twenty languages are supported, including C, R, Lisp, Python, Perl, Ruby,
and others.  VimOrganizer calls out to a running Emacs server for Org-babel
processing; functionality and speed are essentially the same as
when editing with Org-mode in Emacs.

VimOrganizer has a first draft of a Vim help file, but the best first step in
learning about VimOrganizer is to learn about Emacs' Org-mode.  VimOrganizer
uses the same basic concepts but implements them within the context of Vim
(and with a reduced feature set).  Org-mode's main documentation and
support newsgroup are found here:
Org-mode Main Manual:  http://orgmode.org/manual/index.html
Org-mode Compact Guide: http://orgmode.org/guide/index.html
Org-mode support:  http://news.gmane.org/gmane.emacs.orgmode
Org-babel information: http://orgmode.org/worg/org-contrib/babel/

VimOrganizer help can be found here:
https://github.com/hsitz/VimOrganizer/blob/master/doc/vimorg.txt

==========================
INSTALLATION INSTRUCTIONS
===========================
https://github.com/hsitz/VimOrganizer/blob/master/INSTALL.txt


QUESTIONS, COMMENTS, SUGGESTIONS
================================
Questions, comments, and suggestions regarding VimOrganizer are always
appreciated.  The preferred place for those is in the VimOrganizer newsgroup
here:
http://groups.google.com/group/vimorganizer/topics

VimOrganizer project files are maintained at github and the version
there may be more recent than the files at vim.org:
https://github.com/hsitz/VimOrganizer

----------------------------------------------------------------
NOTE:  some code from other Vim plugins has been incorporated into the
VimOrganizer script files.  Do NOT download these plugins to use them
with VimOrganizer; since VimOrganizer does not call out to them in any way:

1.  Charles Campbell's great calendar utilities
2.  Table editing routines from Maxim Kim's excellent vimwiki plugin.
    These are really quite nice (seem to be inspired by Org-mode's
    own table-editing stuff) and deserve to be offered as a separate
    plugin of their own, not dependent on any larger project. (If
    VimOrganizer is not quite the sort of plugin you're looking for then
    vimwiki may be.)
----------------------------------------------------------------

VimOrganizer page at vim.org:
http://www.vim.org/scripts/script.php?script_id=3342


 
install details
See:
https://github.com/hsitz/VimOrganizer/blob/master/INSTALL.txt
 

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
VimOrganizer_v0313.zip 0.313 2011-11-16 7.0 Herbert Sitz Fixed sample vimrc and vimorg.txt to reference g:agenda_files instead of non-existent g:org_agenda_files
VimOrganizer_v0312.zip 0.312 2011-11-10 7.0 Herbert Sitz Fix for some dates with repeaters not getting found in agenda searches
VimOrganizer_v031.zip 0.311 2011-11-10 7.0 Herbert Sitz 0.31-Fixed bug with opening agenda window on terminals when no g:agenda_files defined; added "todo dashboard" accessible by ,t  ; added support for auto log entries and date reset when changing date-repeater todos to done state, 0.311 -- fixed bug that could cause endless loop when cycling
VimOrganizer_0304.zip 0.304 2011-11-05 7.0 Herbert Sitz Additions to install.txt file re: emacs setup, set g:org_command_for_emacsclient by default on Linux and OSX systems.
VimOrganizer_v0302.zip 0.302 2011-11-03 7.0 Herbert Sitz Tweak to avoid error message when starting in terminal that has no Normal background color set
VimOrganizer_v0301.zip 0.301 2011-11-03 7.0 Herbert Sitz fix for error message when starting up with no g:org_todo_custom_highlights defined;
fix to hide FoldColumn in terminal versions of Vim
VimOrganizer_v030.zip 0.30 2011-11-03 7.0 Herbert Sitz Many changes, additions, improvements.  See intro.txt and the included vim-format help file.
ip used for rating: 54.227.20.250

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.
   
SourceForge.net Logo