Skip to content

Latest commit

 

History

History
343 lines (238 loc) · 12.1 KB

README.markdown

File metadata and controls

343 lines (238 loc) · 12.1 KB
Raw

This repository is only a mirror, all developpment happens at gitlab

Todo.txt-vim

    #####                                                #     #
      #    ####  #####   ####     ##### #    # #####     #     # # #    #
      #   #    # #    # #    #      #    #  #    #       #     # # ##  ##
      #   #    # #    # #    #      #     ##     #   ### #     # # # ## #
      #   #    # #    # #    #      #     ##     #        #   #  # #    #
      #   #    # #    # #    # ##   #    #  #    #         # #   # #    #
      #    ####  #####   ####  ##   #   #    #   #          #    # #    #

                    Efficient Todo.txt management in vim

Table of Contents

  1. Release notes
  2. Introduction
    1. Todo.txt rules
    2. Why this Fork ?
    3. Installation
  3. TodoTxt Files
  4. Completion
  5. Hierarchical Sort
  6. Recurrence
  7. Mappings
    1. Sort
    2. Priorities
    3. Dates
    4. Done

Release notes

  • V0.8.1 Incorporates yet another Fretep work : highlighting for tasks due today.

  • v0.8 Incorporates Fretep's work on overdue dates (PR#13 and PR#16) which removes python dependency, allow to control the cursor position after a sort by todo (see (sort)[#sort] and/or issue #15) and fixes bug when sorting a file containing only lines with due:date (issue #14).

  • v0.7.6 Incorporates Sietse's work to make cancel and mark as done mapping repeatable using vim-repeat.

  • v0.7.5 Incorporates Fievel's work to make overduedates work on python3.

  • v0.7.4 includes the overduedate support from Guilherme Victal (see pull

    request #45 on freitass version), it highlight dates in overdue tasks as an Error. It depends on a Python library, however, and as such will only be able to work if your version of Vim was compiled with the +python option (as most common versions do).

    If your Vim installation does not have Python support, this plugin will work just fine but this feature will be disabled.

  • Since v0.7.3, TodoComplete is replaced by todo#Complete, you might need to update your vimrc (see completion).

Introduction

Todo.txt-vim is a plugin to manage todo.txt files it was initially designed by Freitass then forked and improved by David Beniamine.

Todo.txt rules

Todo.txt is a standard human readable todo notes file defined here:

"The todo.txt format is a simple set of rules that make todo.txt both human and machine-readable. The format supports priorities, creation and completion dates, projects and contexts. That's all you need to be productive. See an example Todo.txt file":

(A) Call Mom @Phone +Family
(A) Schedule annual checkup +Health
(B) Outline chapter 5 +FamilyNovel @Computer
(C) Add cover sheets @ComputerOffice +FamilyTPSReports
Plan backyard herb garden @ComputerHome
Pick up milk @ComputerGroceryStore
Research self-publishing services +FamilyNovel @ComputerComputer
x Download Todo.txt mobile app @ComputerPhone

Why this fork ?

This plugin is a fork of freitass todo.txt-vim. It add several cool functionalities including:

Installation

Todo.txt-vim is a filetype plugin, make sure that your vimrc contains :

syntax on
filetype plugin on

Vizardry

If you have Vizardry installed, you can run from vim:

:Invoke -u dbeniamine todo.txt-vim

Pathogen install

git clone https://github.com/dbeniamine/todo.txt-vim.git ~/.vim/bundle/todo.txt-vim

Then from vim: :Helptags to update the doc

Quick install

    git clone https://github.com/dbeniamine/todo.txt-vim.git
    cd todo.txt-vim
    cp -r ./* ~/.vim

If you want the help installed, run :helptags ~/.vim/doc inside vim after having copied the files. Then you will be able to get the commands help with: :h todo.txt

TodoTxt Files

This plugin provides flexible file naming for todo.txt, all the following names are recognized as todo:

YYYY-MM-[Tt]odo.txt
YYYY-MM-DD[Tt]odo.txt
[Tt]odo-YYYY-MM.txt
[Tt]odo-YYYY-MM-DD.txt
[Tt]odo.txt
[Tt]oday.txt

And obviously the same are recognize as done:

YYYY-MM-[Dd]one.txt
YYYY-MM-DD[Dd]one.txt
[Dd]one-YYYY-MM.txt
[Dd]one-YYYY-MM-DD.txt
[Dd]one.txt
[Dd]one-[Tt]oday.txt

Moreover, <LocalLeader>D moves the task under the cursor to the done.txt file corresponding to the current todo.txt, aka if you are editing 2015-07-07-todo.txt, the done file will be 2015-07-07-done.txt. If you don't like this behavior, you can set the default done.txt name:

let g:TodoTxtForceDoneName='done.txt'

Completion

This plugin provides a nice complete function for project and context, to use it add the following lines to your vimrc:

" Use todo#Complete as the omni complete function for todo files
au filetype todo setlocal omnifunc=todo#Complete

You can also start automatically the completion when entering '+' or '@' by adding the next lines to your vimrc:

" Auto complete projects
au filetype todo imap <buffer> + +<C-X><C-O>

" Auto complete contexts
au filetype todo imap <buffer> @ @<C-X><C-O>

The todo#Complete function is designed to complete projects (starting by +) and context (starting by @). If you use it on a regular word, it will do a normal keyword completion (on all buffers).

If you try to complete a project, it will propose all projects in all open buffers and for each of them, it will show their context and the name of the buffers in which they appears in the preview window. It does the same thing for context except that it gives in the preview the list of projects existing in each existing contexts.

If you don't want the preview window to open when performing completion, add the following lines to your vimrc:

au filetype todo setlocal completeopt-=preview

If you would like the preview window to open even if there is only one match for a completion, then add the following lines to your vimrc:

au filetype todo setlocal completeopt+=menuone

Hierarchical sort

This fork provides a hierarchical sorting function designed to do by project and/or by context sorts and a priority sort.

<LocalLeader>sc : Sort the file by context then by priority <LocalLeader>scp : Sort the file by context, project then by priority <LocalLeader>sp : Sort the file by project then by priority <LocalLeader>spc : Sort the file by project, context then by priority

The user can give argument for the two calls to vim sort function by changing the following variables:

g:Todo_txt_first_level_sort_mode
g:Todo_txt_second_level_sort_mode

Defaults values are:

g:Todo_txt_first_level_sort_mode="i"
g:Todo_txt_second_level_sort_mode="i"

For more information on the available flags see help :sort

Recurrence

By adding a rec: tag to your task, when you complete (<LocalLeader>x) or postpone (<LocalLeader>p) the task, a new recurrence will be created due after the specified amount of time.

The format is: rec:[+][count][d|w|m|y]

Where: d = days, w = weeks, m = months, y = years The optional + specifies strict recurrence (see below)

Examples: * rec:2w - Recurs two weeks after the task is completed. * rec:3d - Recurs three days after the task is completed. * rec:+1w - Recurs one week from the due date (strict)

This is a non-standard but widely adopted keyword.

Mappings

By default todo-txt.vim sets all the mappings described in this section. To prevent this behavior, add the following line to your vimrc

let g:Todo_txt_do_not_map=1

<LocalLeader> is \ by default, so ̀<LocaLeader>-s means you type \s

Sort

  • <LocalLeader>s : Sort the file by priority
  • <LocalLeader>s+ : Sort the file on +Projects
  • <LocalLeader>s@ : Sort the file on @Contexts
  • <LocalLeader>sc : Sort the file by context then by priority
  • <LocalLeader>scp : Sort the file by context, project then by priority
  • <LocalLeader>sp : Sort the file by project then by priority
  • <LocalLeader>spc : Sort the file by project, context then by priority
  • <LocalLeader>sd : Sort the file on due dates. Entries with a due date appear sorted by at the beginning of the file, completed tasks are moved to the bottom and the rest of the file is not modified.

When you sort by due dates, at the end of the sort, your cursor will be placed at the top of the file. This behavior can be set with the following global variable :

let g:TodoTxtSortDueDateCursorPos = "top"

Possible values are :

  • top (default): The first line of the buffer, i.e. your most outstanding task
  • lastdue: The last task with a due:date set
  • notoverdue: The first task that is not overdue (requires #13)
  • bottom: The last line of the buffer

Priorities

  • <LocalLeader>j : Lower the priority of the current line
  • <LocalLeader>k : Increase the priority of the current line
  • <LocalLeader>a : Add the priority (A) to the current line
  • <LocalLeader>b : Add the priority (B) to the current line
  • <LocalLeader>c : Add the priority (C) to the current line

Dates

  • <LocalLeader>d : Insert the current date
  • <LocalLeader>p : Postpone the due date (accepts a count)
  • <LocalLeader>P : Decrement the due date (accepts a count)
  • date<tab> : (Insert mode) Insert the current date
  • due: : (Insert mode) Insert due: followed by the current date
  • DUE: : (Insert mode) Insert DUE: followed by the current date

If you would like the creation date (today) prefixed on new lines, add the following to your vimrc:

let g:Todo_txt_prefix_creation_date=1

With insert mode maps on, typing date<Tab> or due: can feel like glitches This is because vim wait for mappings before inserting the words to the buffer. To prevent the glitches, abbreviations can be used instead of mappings. To turn it on, add the following to your vimrc:

let g:TodoTxtUseAbbrevInsertMode=1

Abbreviations uses word separator to expand the abbreviations, thus <Tab> is unavailable on abbreviations. Turning abbreviations mode will change date<Tab> mapping into date:. The resulting abbreviations would be:

  • date: : (Insert mode) Insert the current date
  • due: : (Insert mode) Insert due: followed by the current date
  • DUE: : (Insert mode) Insert DUE: followed by the current date

Done

  • <LocalLeader>x : Toggle mark task as done (inserts or remove current
  • date as completion date)
  • <LocalLeader>C : Toggle mark task cancelled
  • <LocalLeader>X : Mark all tasks as completed
  • <LocalLeader>D : Move completed tasks to done file, see TodoTxt Files

When you mark an item with a priority as done, it is assigned a priority tag like pri:A so that the priority can be restored if the item is toggled back to undone. If you don't want the tags showing up in your done file, you can disable this behavior by setting the following global variable:

let g:TodoTxtStripDoneItemPriority=1

Format

  • <LocalLeader>ff : Try to fix todo.txt format

Fold

Todo.txt files can be folded by projects or context (see :help fold), by default they are foldable by context, to use project fold :

let g:Todo_fold_char='+'