tbabej/taskwiki
1
0
Fork 0
mirror of https://github.com/tbabej/taskwiki.git synced 2025-08-23 02:23:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Update README and documentation

Browse source
This commit is contained in:
djp 2015-04-25 23:44:50 -04:00 • committed by Tomas Babej
parent 248cde4c6c
commit a2037b429b
3 changed files with 258 additions and 123 deletions
Download patch file Download diff file Expand all files Collapse all files

120
README.md
View file

@ -6,9 +6,26 @@ _Use [taskwarrior](http://taskwarrior.org) task-management in [vimwiki](https://
[![Coverage Status](https://coveralls.io/repos/tbabej/taskwiki/badge.svg?branch=master)](https://coveralls.io/r/tbabej/taskwiki?branch=master)
[![Code Health](https://landscape.io/github/tbabej/taskwiki/master/landscape.svg?style=flat)](https://landscape.io/github/tbabej/taskwiki/master)
This is a vim plugin, which aims to provide integration between vimwiki and taskwarrior. It extends vimwiki by replacing the rudimentary Todo lists, and provides bidirecitonal synchronization between TaskWarrior and Vimwiki files.
\*[taskwiki.txt](/doc/taskwiki.txt)\*
<pre>
_____ _ __ ___ _ _ ~
a |_ _|_ _ ___| | _\ \ / (_) | _(_) a ~
command-line | |/ _` / __| |/ /\ \ /\ / /| | |/ / | personal wiki ~
todo list | | (_| \__ \ < \ V V / | | <| | for vim ~
manager |_|\__,_|___/_|\_\ \_/\_/ |_|_|\_\_| ~
~
==============================================================================
QUICK-REFERENCE -- use < leader > + t and one of:
This allows you to define your tasks in your vimwiki files and still have processing power of TaskWarrior at your disposal. If you use taskwarrior, and you use vimwiki, you want this plugin.
| a annotate | C calendar | Ga ghistory annual | p projects |
| bd burndown daily | d done | hm history month | s summary |
| bw burndown weekly | D delete | ha history annual | S stats |
| bm burndown monthly | e edit | i (or CR ) info | t tags |
| cp choose project | g grid | l back-link | + start |
| cp choose tag | Gm ghistory month | m modify | - stop |
</pre>
![taskwiki demo](/doc/TaskWiki-demo.gif)
### Requirements
@ -24,57 +41,86 @@ This allows you to define your tasks in your vimwiki files and still have proces
### Enhancements
* [vim-plugin-AnsiEsc](https://github.com/powerman/vim-plugin-AnsiEsc) for color support
* [tagbar](https://github.com/majutsushi/tagbar) for taskwiki file navigation
* [vim-taskwarrior](https://github.com/farseer90718/vim-taskwarrior) for grid view
### Install
Install this plugin like any other; using pathogen or copying the files and folders to your vim directories.
- plugins the vim way: http://vimdoc.sourceforge.net/htmldoc/usr_05.html#05.4
- plugins the easy way: https://github.com/tpope/vim-pathogen. Other "vim plugin managers" will probably work, but have not been tested
### Features
#### ViewPorts
* Create a heading that contains a taskwarrior filter, that looks like this;
- ViewPorts: a vimwiki header with a task query (filter) embedded, generate
a corresponding list of tasks. These tasks can be modified and changes
will be synced back to task data. A ViewPort heading looks like this:
<pre>
== Foo task list | project:foo ==
== Project Foo Tasks | +PENDING project:foo | +bar pri:H ==
title ^^^ filter ^^^ ^^^ user defaults
</pre>
and after saving the file, TaskWiki generates a full list of matching tasks.
title can be any text, and the filter elements are concealed in normal mode.
- Individual Todos: tasks can be used anywhere in a vimwiki, looking like:
#### Define defaults, by extending that heading like this;
<pre>
== Foo task list | project:foo | project:foo +bar ==
* [ ] Install TaskWiki plugin
</pre>
so that any tasks created under this heading will automatically be assigned "project:foo +bar"
#### Bidirecitonal updates:
* TW -> Vimwiki (upon file loading)
* Vimwiki -> TW (upon saving)
and when adding a new task, any other metadata can be added after "--" like
#### Updated information
* Description
* Task status (completion)
* Dependency sets (sets subtasks as dependencies of parent tasks)
* Due dates
* Priority
<pre>
* [ ] test taskwiki todos and viewports -- proj:tw.wiki +foo due:tomorrow
</pre>
and the task will be synced with the task data on saving. After syncing,
all tasks end with a concealed uuid (eg. #541c5b57) don't edit this!
- Task Info: hitting <CR> with the cursor over a task shows all task info.
- Reports: burndown, calendar, history, projects, summary, stats and tags
reports can all be invoked, opening in a split window.
- Grid view: the TaskWikiGrid command will open a new buffer with a grid
view of task details, of the nearest ViewPort (using vim-taskwarrior)
- Back-links: The command TaskWikiLink will add an annotation to the selected
task(s) with the ~/path/to/file.wiki
- Tests: TaskWiki is well tested in development to ensure data integrity.
**DISCLAIMER** This is free software, it comes with absolutely NO
warranty and no promise of fitness for any purpose! (back up your data!)
### Commands
* TaskWikiBurndown(Daily, Monthly, Weekly)
* TaskWikiCalendar
* TaskWikiDelete
* TaskWikiGhistory(Annual, Monthly)
* TaskWikiHistory(Annual, Monthly)
* TaskWikiInfo
* TaskWikiLink
* TaskWikiMod
* TaskWikiProjects
* TaskWikiProjectsSummary
* TaskWikiStart
* TaskWikiStats
* TaskWikiStop
* TaskWikiTags
* TaskWikiBurndown(Daily, Monthly, Weekly)
* TaskWikiCalendar
* TaskWikiChooseProject
* TaskWikiChooseTag
* TaskWikiDelete
* TaskWikiGhistory(Annual, Monthly)
* TaskWikiHistory(Annual, Monthly)
* TaskWikiInfo
* TaskWikiInspect
* TaskWikiLink
* TaskWikiMod
* TaskWikiProjects
* TaskWikiProjectsSummary
* TaskWikiStart
* TaskWikiStats
* TaskWikiStop
* TaskWikiTags
### Planned features
* Updating
* Removals from dependency sets
see more in doc/taskwiki.txt. After installing, run :helptags and then :he taskwiki
### Credits
Inspired by vimwiki-tasks plugin.
Authored by Tomas Babej
Inspired by [vimwiki-tasks plugin](https://github.com/teranex/vimwiki-tasks).
### Contributing
Clone, fork, contribute and learn more at https://github.com/tbabej/taskwiki
Good ideas, well formed bug reports and thoughtful pull-requests welcome.