Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
Update for additional cycling lists.
  • Loading branch information
wenlzhang committed Nov 4, 2023
1 parent 797a98a commit 3945a81
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@ An [Obsidian](https://obsidian.md/) plugin to change task status and append text
- Mark tasks with statuses such as `[>]` and `[/]`
- Mark individual task statuses with hotkeys
- Optionally append text such as `❎ 2023-01-01`
- Cycle task statuses
- Cycle tasks
- Cycle among configured statuses such as `[x]`, `[-]`, `[>]` and `[/]`
- Reversely cycle among configured statuses
- Cycle tasks among additional lists of statuses 📝 2023-11-04
- E.g., list 1 `x->/` for task execution status
- E.g., list 2 `?!biI` for task importance
- E.g., list 3 `pcud` for task pro/con/up/down
- Append text
- Command to append text such as `📝 2023-01-01` to any line
- Command to append text such as `✅ 2023-01-01` to any line
Expand Down
6 changes: 3 additions & 3 deletions docs/Setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ Task Marker uses [moment.js](https://momentjs.com/docs/#/displaying/format/) to

## Cycle tasks

- **Cycled task statuses**
- **Cycled task (main)**
- Examples:
- `x- Rip`
- **Support cycling task status reversely**
- If enabled, an additional command would be added to reversely cycle the statuses configured in **Cycled task statuses**.
- **Support cycling task reversely (main)**
- If enabled, an additional command would be added to reversely cycle the statuses configured in **Cycled task (main)**.
- For the example above, it means that this command would cycle among `piR -x`.

## Append text
Expand Down
8 changes: 4 additions & 4 deletions docs/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,19 @@ If the current line is (or selection contains) a task, and the task matches the
- Use the **mouse** to select an icon, or **type** the associated character.
- For instance, one can type `x` to complete the task.

## Cycle task status
## Cycle task

### Cycle task status
### Cycle task (main)

- If the current status of the task matches one of the configured statuses, the status would change to the next one.
- For instance, if `Rip` is configured and the current status is `R`, then the status become `i` after executing the command.
- If the current status of the task does not match any of the configured statuses, the status would change to the first one.
- For instance, if `Rip` is configured and the current status is `x`, then the status would become `R` after executing the command.
- If it is an item, e.g., `- Item`, rather than a task, then the status would start from the first status in the configuration.

### Cycle task status reversely
### Cycle task reversely (main)

- If **Support cycling task status reversely** is enabled, an additional command would be added to reversely cycle the statuses configured in **Cycled task statuses**.
- If **Support cycling task reversely (main)** is enabled, an additional command would be added to reversely cycle the statuses configured in **Cycled task (main)**.

## Append text

Expand Down

0 comments on commit 3945a81

Please sign in to comment.