---

Ⅰ. 插件描述

Shortcuts to add and remove TODO: to lines in files being edited with Vim

Ⅱ. 基本信息

创建日期：  2013-10-11 使用用户：  2 Github星：  6 插件作者：  Edward Delaporte

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'edthedev/vim-todo-you-belong-with-me'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'edthedev/vim-todo-you-belong-with-me'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'edthedev/vim-todo-you-belong-with-me'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/edthedev/vim-todo

Ⅳ. 文档说明

vim-todo

vim-todo_ is a Vim plugin that adds shortcuts
to add and remove TODO: to lines in files.

.. _vim-todo: http://github.com/edthedev/vim-todo

Installation

This plugin is packaged for use with Vundle_.
This plugin requires Vim_ to be compiled with Python_ support.

.. _Vim: http://vim.org/about.php
.. _Python: http://python.org
.. _Vundle: https://github.com/gmarik/vundle/blob/master/README.md

Install Vundle_ and then add 'edthedev/vim-rst' to your .vimrc.::

Bundle 'edthedev/vim-todo'

Then, from within Vim, run BundleInstall.::

:BundleInstall

Configuration

Enable the built in keyboard mappings with::

let g:vim_todo_keys = 1

Keyboard Mappings

Default shortcut mappings are:

1. Toggle the current line between TODO, DONE, WAITING, and WONT. A line with none of those will gain TODO: at the beginning.::

   <Leader>od 
   

2. List all TODO lines in the current buffer::

   <Leader>ol
   

3. Display completion count of TODO and DONE lines for the current buffer. i.e. Completed: 1/4::

   <Leader>op
   

Syntax Highlighting

This syntax highlighting depends on very simple markdown-like checklists.

Location 1, Person 1
    [ ] Item 1
    [ ] Item 2
    [x] Completed Item
Location 2, Person 2
    [x] Completed Item
    [ ] Item 1
    [x] Completed Item

This plugin will automatically apply the syntax highlighting to files named *.todo.

The syntax highlighting is thanks to https://github.com/tomswartz07/vim-todo