A brief introduction to vim-orgmode

Table of Contents

1 Abstract

What is the reason why you use Vim on a daily basis? Use it for editing some configurations? Or writing lots of source code? That’s good. But some of you may want to use Vim for other purposes. For such users, Vim-orgmode has been developed by Jan Christoph Ebersbach as a Vim plugin from 2011. The vim-orgmode provides attractive capabilities to Vim users who potentially want to manage a bunch of TODO items, to write blog posts, and to edit technical articles or reports. In this lighting talk, the basic functionalities of vim-orgmode and remarkable features of the original Org Mode of Emacs are briefly introduced.

2 Introduction

2.1 Who am I?   attach


Name Takaaki ISHIKAWA
Twitter @takaxp
Job Researcher, Lecturer, Software engineer
  An expert of ISO/IEC JTC 1/SC 29
Lang. チョットダケ C, C++, and Perl

2.2 Personally,   attach

  • I love Pasta without Spaghetti source code.


3 vim-orgmode

3.1 What is vim-orgmode?

A Vim plugin of…

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

What for?

  • Not limited to writing source code
  • Organizing your tasks and actions (e.g. GTD)
  • Writing meeting minutes or technical reports
  • Capturing and recording everything as plain text

3.2 Capabilities   attach

  • See the official website: https://github.com/jceb/vim-orgmode
    • [ ] Syntax highlighting
    • [ ] Markup (not Markdown)
    • [ ] Cycle visibility of headings (folding)
    • [ ] 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
    • [ ] Generating well-structured document
    • [-] Export to other formats (via Emacs’ Org-Mode)
      • [X] Literate programming (Jupyter notebook? NO)
      • [ ] Reproducible research

3.3 Where can we see Org?

│        README on GitHub        │

Absolutely NO!


3.4 Supporting Org in other editors

  1. Sublime text: orgmode for Sublime Text 2 & 3
  2. VS Code: Emacs Org Mode for Visual Studio Code
  3. Atom: Atom grammar for org-mode syntax
  4. GNU Emacs: Org Mode (the original)

4 Org Mode

4.1 What is this?   attach

IMO, Org Mode is…

┌────────────────────────┐          ┌────────────────────────┐
│    the second brain    │    or    │        Exocortex       │
└────────────────────────┘          └────────────────────────┘
                                     An extension to your brain

4.2 Change your situation   attach


4.3 What is your requirements to text editor?

  1. Visual feedback (e.g. syntax highlighting)
  2. Efficiency
    • you don't like duplicated works
  3. Snippet or code completion
    • since we have limited memory in brain

4.4 But the ideal goal is…

│     Just imagine, then get the results.      │

Why are you typing your keyboard now?

4.5 Do not work too much   secret

                *Just imagine, then get the results!*
             ┌────────────────┐       ┌────────────────┐
             │     Imagine    │   →   │    Results!    │
             └────────────────┘       └────────────────┘

Need a report in Microsoft Word   →   Export it from an org file

I cannot remember but I know...   →   Search and find it from org files

   When I have to go to Vimconf   →   Get a reminder from Org

                      Security?   →   just encrypt data

5 Problems

5.1 Current status of development

  • vim-orgmode doesn't support full functionalities of Org Mode in Emacs.

    Table 1: basic statistics based on GitHub or git repository
      Org Mode Vim-orgmode vscode-org-mode
    Starting date 2003-mm-dd [2011-06-25 Sat] [2017-04-02 Sun]
    Contributors 100 (approx.) 34 7
    Commits 21,579 997 203

5.2 Now we are in the middle of the way

  • Human being needs your contributions to expand vim-orgmode ;-)

m9(^Д^) you!

6 Conclusion

│     Jump in Org Mode, today!      │

visit https://orgmode.org
vim-orgmode (GitHub)
Thanks to:

  1. Org Mode
  2. org-tree-slide.el (as presentation module)

This presentation was delivered by GNU Emacs and Org Mode

  • Sorry, not using Vim…
  • but near future, vim-orgmode may achieve this!

Date: 2018-12-02 Sun 11:18

Author: Takaaki ISHIKAWA <takaxp@ieee.org>

Created: 2018-12-02 Sun 11:18