From 6d4d8835d7f321c0ce8cd10405bb833199661ec6 Mon Sep 17 00:00:00 2001 From: Ali Karbassi Date: Thu, 5 Jul 2018 23:01:42 -0500 Subject: [PATCH] textile to markdown --- ...s.textile => Creating-Add-ons:-Examples.md | 46 +++++++++---------- 1 file changed, 22 insertions(+), 24 deletions(-) rename Creating-Add-ons:-Examples.textile => Creating-Add-ons:-Examples.md (58%) diff --git a/Creating-Add-ons:-Examples.textile b/Creating-Add-ons:-Examples.md similarity index 58% rename from Creating-Add-ons:-Examples.textile rename to Creating-Add-ons:-Examples.md index c619bec..093ab79 100644 --- a/Creating-Add-ons:-Examples.textile +++ b/Creating-Add-ons:-Examples.md @@ -1,32 +1,30 @@ -Todo.sh add-ons let you add new todo.sh actions or change (override) default -actions. See [[Creating and Installing Add-ons]] for more info. +Todo.sh add-ons let you add new todo.sh actions or change (override) default actions. See [[Creating and Installing Add-ons]] for more info. -h2. Example: overriding a built-in command +## Example: overriding a built-in command -Here is one example to override the "add" command. -This is done in bash but note that you can do it in any language you want (in which case parsing the config file may be a bit harder). +Here is one example to override the "add" command. This is done in bash but note that you can do it in any language you want (in which case parsing the config file may be a bit harder). -h3. Proposed features: +### Proposed features: We'll allow to add an item and mark it as done in one shot with the following syntax: -
-todo.sh add x Helping colleague to install linux
-
+```bash +$ todo.sh add x Helping colleague to install Linux +``` -Why such a feature? Because some of us are using todo.sh to track all their activities, not only those which are planned for later therefore "to do". Why "x" and not just "do"? Because there is a big risk that some of the actual todos will start with "Do something...", and "x" comes from the "x" marker put on done items by "todo.sh do". +Why such a feature? Because some of us are using todo.sh to track all their activities, not only those which are planned for later, therefore "to do". Why "x" and not just "do"? Because there is a big risk that some of the actual todos will start with "Do something...", and "x" comes from the "x" marker put on done items by `todo.sh do`. And as we're hacking the "add" anyway, let's also allow to set a priority when adding an item using the following syntax: -
-todo.sh add pri A "Need to write plugin example on Gina's wiki"
-
+```bash +$ todo.sh add pri A "Need to write plugin example on Gina's wiki" +``` -h3. Implementation: +### Implementation: -First argument is either the action itself or the keyword "usage", in which case we'll display some help and exit: +The first argument is either the action itself or the keyword "usage", in which case we'll display some help and exit: -
+```bash
 #!/bin/bash
 
 action=$1
@@ -42,11 +40,11 @@ shift
   echo ""
   exit
 }
-
+```sh Then the core of our customized action: are we in the regular "add" case or in the custom cases of marking the item as done immediately or prioritized immediately? -
+```bash
 PRIORITY=false
 DO=false
 if [ x"$1" = x"pri" -o x"$1" = x"p" ] && [[ x"$2" = x[a-zA-Z] ]]; then
@@ -57,18 +55,18 @@ elif [ x"$1" = x"x" ]; then
     DO=true
     shift
 fi
-
+``` -Doing what we've to do: here the environment variable $TODO_SH can be used to call back the todo.sh script wherever it is and no matter how it's called. +Doing what we've to do: here the environment variable $TODO_SH can be used to call back the `todo.sh` script wherever it is and no matter how it's called. -Because we want to use the original built-in "add" we call todo.sh with the action "command add" in the same spirit of the bash "command". -As we've sourced the config file, the todo file is reachable with $TODO_FILE . +Because we want to use the original built-in "add" we call todo.sh with the action "command add" in the same spirit of the bash "command". +As we've sourced the config file, the todo file is reachable with `$TODO_FILE`. -
+```bash
 if "$TODO_SH" command add "$@"; then
     # getting the number item: it's simply the last item added to the file
     line=`wc -l "$TODO_FILE" | cut -d' ' -f1`
     [ $PRIORITY != false ] && "$TODO_SH" command pri "$line" $PRIORITY
     $DO && "$TODO_SH" command do "$line"
 fi
-
+```