|
| 1 | +# Theming |
| 2 | + |
| 3 | +## Themes |
| 4 | +Command shells have very limited color abilities, but I decided it would be good to not impose my color scheme on everyone who uses redovc.... So, theming. |
| 5 | + |
| 6 | +## Theme file |
| 7 | +A theme file can live in your home directory and it will be used as the default. You can also have theme files in other directories and when you are in that directory, that theme will be used. |
| 8 | + |
| 9 | +The theme file must be named .todos.theme.json and the contents are used to describe how different sections of the redovc list command presents data. |
| 10 | + |
| 11 | +## Theme file color structure |
| 12 | +You can find sample theme files in the [sampleThemes](https://github.com/sottey/redo.vc/tree/main/sampleThemes) directory of the source code. |
| 13 | + |
| 14 | +For each section, there are a number of properties: |
| 15 | + |
| 16 | +- Desc - Color of group names when group: is specified |
| 17 | +- Name - Name of section. These are used by the code and must be one of: |
| 18 | + - groupTitleColor - Color of group names when group: is specified |
| 19 | + - noteIDColor - Color of note id's when --notes is used |
| 20 | + - noteTextColor - Color of note contents when --notes is used |
| 21 | + - taskIDColor - Color of a task id |
| 22 | + - taskIDPriColor - Color of a task id if the task is prioritized |
| 23 | + - completedColor - Color of completed indicator ([ ] or [X]) |
| 24 | + - statusColor - Color of task status |
| 25 | + - statusPriColor - Color of a task status if task is prioritized |
| 26 | + - informationColor - Color of area indicating Priority, Note and Archived |
| 27 | + - todayColor - Color of a task due today |
| 28 | + - todayPriColor - Color of a task due today if that task is prioritized |
| 29 | + - tomorrowColor - Color of a task due tomorrow |
| 30 | + - tomorrowPriColor - Color of a task due tomorrow if that task is prioritized |
| 31 | + - overdueColor - Color of a task that is overdue |
| 32 | + - overduePriColor - Color of a task that is overdue if that task is prioritized |
| 33 | + - otherDue - Color of a task that is not today, tomorrow or overdue |
| 34 | + - otherDuePriColor - Color of a task that is not today, tomorrow or overdue if the task is prioritized |
| 35 | + - taskTextColor - Color of task text |
| 36 | + - taskTextProjectWordColor - Color of project names in task text |
| 37 | + - taskTextTagWordColor - Color of tags in task text |
| 38 | + - taskTextPriColor - Color of task text if the task is prioritized |
| 39 | + - taskTextProjectPriWordColor - Color of project names in task text if that task is prioritized |
| 40 | + - taskTextTagWordPriColor - Color of tags in task text if that task is prioritized |
| 41 | +- Color - The color to be used. Valid colors are: |
| 42 | + - black |
| 43 | + - red |
| 44 | + - green |
| 45 | + - yellow |
| 46 | + - blue |
| 47 | + - magenta |
| 48 | + - cyan |
| 49 | + - white |
| 50 | +- Bold = true or false |
| 51 | + |
| 52 | +## Theme File Column Ordering Structure (not yet implemented): |
| 53 | +I am working on people being able to specify what order the columns are displayed when using 'redovc list'. These will be contained in the theme file as well. |
| 54 | + |
| 55 | +Currently, the json looks like this: |
| 56 | +``` |
| 57 | + "Columns": |
| 58 | + [ |
| 59 | + { |
| 60 | + "desc": "Task ID", |
| 61 | + "columnname": "id", |
| 62 | + "index":0 |
| 63 | + }, |
| 64 | + { |
| 65 | + "desc": "Completed column", |
| 66 | + "columnname": "completed", |
| 67 | + "index":1 |
| 68 | + }, |
| 69 | + { |
| 70 | + "desc": "Information - Priority, Note and Archived flags", |
| 71 | + "columnname": "information", |
| 72 | + "index":2 |
| 73 | + }, |
| 74 | + { |
| 75 | + "desc": "Task Due date", |
| 76 | + "columnname": "due", |
| 77 | + "index":3 |
| 78 | + }, |
| 79 | + { |
| 80 | + "desc": "Task status", |
| 81 | + "columnname": "status", |
| 82 | + "index":4 |
| 83 | + }, |
| 84 | + { |
| 85 | + "desc": "Task subject", |
| 86 | + "columnname": "subject", |
| 87 | + "index":5 |
| 88 | + } |
| 89 | + ], |
| 90 | +``` |
0 commit comments