ant/nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add example file

Browse source
This commit is contained in:
Anthony Rose 2023-03-27 16:12:02 +01:00
parent bca02e6fc6
commit 3e1b4dce95
2 changed files with 48 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
pack/acp/start/vim-actodo/README.md
View file

@ -1,59 +1,26 @@
# vim-actodo
This is a very basic TODO list syntax plugin. There are no fancy keybindings,
and nothing automatic. It simply formats a TODO list to make it easier to track
what you are working on.
This is a very basic TODO list syntax plugin.
There are no fancy keybindings, and nothing automatic.
It simply formats a TODO list to make it easier to track what you are working on.
## Supported keywords
Lines beginning with `#` will be shown in bold and should be used as headers.
You can use multiple hash characters for different levels but they will all be
formatted the same. Leading whitespace is ignored.
You can use multiple hash characters for different levels but they will all be formatted the same.
Leading whitespace is ignored.
Lines beginning with `TODO:`, `WORK:` (for work-in-progress), or `DONE:` are
your tasks, with the associated status. The keywords will be coloured red,
green, and grey respectively, but the rest of the line will be shown normally.
Lines beginning with `TODO:`, `WORK:` (for work-in-progress), `WAIT:` (for jobs waiting on someone else), or `DONE:` are your tasks, with the associated status.
URLs enclosed with angled brackets will be shown in blue, as will dates in a
subset of the ISO 8601 format (`YYYY-mm-dd`, `YYYY-mm-ddTHH:MM`, and `THH:MM`,
with or without a trailing `Z`).
URLs enclosed with angled brackets will be shown in blue, as will dates in a subset of the ISO 8601 format (`YYYY-mm-dd`, `YYYY-mm-ddTHH:MM`, and `THH:MM`, with or without a trailing `Z`).
Any other lines will be shown in plain text, and are designed for notes or
comments on the tasks.
Tags begin with a # and a letter, and must be two or more letters long.
Any other lines will be shown in plain text, and are designed for notes or comments on the tasks.
## Example
This is an example TODO list, and a screenshot of how it is displayed. The file
should have the extension `.actodo`.
Projects
========
# Office party
TODO: Buy snacks.
James is allergic to peanuts.
Beth doesn't like seafood.
WORK: Decorate the hall.
Bouncy castle will be delivered at T09:30.
WORK: Sell raffle tickets.
Also online at <https://example.com/raffle>.
DONE: Put up posters.
DONE: Book Ceilidh dance tutor.
## After-party
TODO: Find a jazz band.
An example list can be found in the file [example.actodo](example.actodo) in this repository.
Files should have the extension `.actodo`.
![Screenshot of an example list](screenshot.png)

36
pack/acp/start/vim-actodo/example.actodo Normal file
View file

@ -0,0 +1,36 @@
Projects
========
# Office party
TODO: Buy snacks.
[!!!] James is allergic to peanuts.
Beth doesn't like seafood.
WAIT: Decorate the hall.
Bouncy castle will be delivered Monday at T09:30.
Can't decorate until the castle has been delivered.
WORK: Sell raffle tickets. #advertising
Deadline for tickets is end of 2021-12-31.
Also online at <https://example.com/raffle>.
WAIT: Asked IT to sort out speaker system. #activities
Ticket ##10035##.
DONE: Put up posters. #advertising
DONE: Book Ceilidh dance tutor. #activities
## After-party
TODO: Find a jazz band.