Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

update README

latest commit 4bbf240365
Samson Wu authored February 04, 2014
Octocat-spinner-32 ftdetect add *.task file extension September 10, 2010
Octocat-spinner-32 plugin Fixed task plugin February 22, 2013
Octocat-spinner-32 syntax add "bug" to the highlighted keywords September 16, 2011
Octocat-spinner-32 README.mkd update README February 04, 2014
README.mkd

Overview

Basically, this is the TextMate Tasks Bundle port for Vim.

ScreenShot

Vim-Task in Action

Vim-Task in Action

Vim-Task with Monaco font

Vim-Task with Monaco font

Vim-Task with Consolas font (which support bold & italic)

Vim-Task with Consolas font

Installation

Normal installation steps follow the vim tradition: download the zip/tar archive then copy all the directories/files to ~/.vim directory. You can download vim-task zip/tar archive by clicking the “Download Source” button in github.

You can also check out the latest code if you have git installed:

$ git clone git://github.com/samsonw/vim-task.git
$ cd vim-task
$ rm README.mkd
$ cp -rv * ~/.vim

For those guys who use pathogen, the installation should be as simple as a git clone: $ cd ~/.vim/bundle $ git clone git://github.com/samsonw/vim-task.git

Shortcut Key, Key Binding & Customization

By default, I mapped Ctrl+Command+Enter for toggling task status, you can simply remap to what’s the most comfortable for you:

inoremap <silent> <buffer> <C-D-CR> <ESC>:call Toggle_task_status()<CR>i
noremap <silent> <buffer> <C-D-CR> :call Toggle_task_status()<CR>

Note, if you find the key binding doesn’t work as expect, please make sure your vim instance was compiled with the +ruby feature. Compiled with +ruby is not required any more, following +ruby check is optional since this plugin has already been ported to native vim script.

$ vim --version | grep +ruby
-python3 +quickfix +reltime +rightleft +ruby +scrollbind +signs +smartindent

File Format & Syntax

The Tasks grammar and commands by default apply to file todo.txt and files with the .task and .tasks extensions. You can customize this by editing ftdetect/task.vim:

autocmd BufNewFile,BufRead todo.txt,*.task,*.tasks  setfiletype task

All the formats and syntax is similar with the TextMate Tasks bundle, I just quoted below for your references:

Headers end with a colon (“:”).
Pending (uncompleted) tasks start with a hyphen (“-”). Completed tasks start with a checkmark (“✓”).
Headers and tasks can be indented for grouping/hierarchy, as seen in the screenshot above.

Bug & Feedback

Please report bugs and issues to github: http://github.com/samsonw/vim-task/issues, any feedback and suggestion is welcome and appreciated.

Something went wrong with that request. Please try again.