From 3e1b4dce95f51f55c326a7a88bb9d41b6556f37a Mon Sep 17 00:00:00 2001 From: Anthony Perkins Date: Mon, 27 Mar 2023 16:12:02 +0100 Subject: [PATCH] Add example file --- pack/acp/start/vim-actodo/README.md | 57 +++++------------------- pack/acp/start/vim-actodo/example.actodo | 36 +++++++++++++++ 2 files changed, 48 insertions(+), 45 deletions(-) create mode 100644 pack/acp/start/vim-actodo/example.actodo diff --git a/pack/acp/start/vim-actodo/README.md b/pack/acp/start/vim-actodo/README.md index 3001e88..9739356 100644 --- a/pack/acp/start/vim-actodo/README.md +++ b/pack/acp/start/vim-actodo/README.md @@ -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 . - - 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) diff --git a/pack/acp/start/vim-actodo/example.actodo b/pack/acp/start/vim-actodo/example.actodo new file mode 100644 index 0000000..6edd5a3 --- /dev/null +++ b/pack/acp/start/vim-actodo/example.actodo @@ -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 . + +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.