Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wenlzhang committed Feb 17, 2023
1 parent de18810 commit 3ec722a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/Setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Task Marker uses [moment.js](https://momentjs.com/docs/#/displaying/format/) to
- Examples:
- `x- Rip`
- **Support cycling task status reversely**
- If enabled, an additional command would be added to cycle the statuses configured in **Cycled task statuses**.
- If enabled, an additional command would be added to reversely cycle the statuses configured in **Cycled task statuses**.
- For the example above, it means that this command would cycle among `piR -x`.

## Append text
Expand Down
37 changes: 23 additions & 14 deletions docs/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,50 @@

If the current line is (or selection contains) a list item or a task with the mark `[ ]`:

1. It will convert the list item to a task.
2. If an append text format string is configured, append a formatted text string to the end of the task text.
- It will convert the list item to a task.
- If an append text format string is configured, append a formatted text string to the end of the task text.

## Complete tasks

### Complete tasks

If the current line is (or selection contains) a task, and the task matches the configuration for an incomplete task:

1. It will mark the task as complete (`[x]` or `[X]` if selected).
1. If an append text format string is configured, append a formatted text string to the end of the task text.
- It will mark the task as complete (`[x]` or `[X]` if selected).
- If an append text format string is configured, append a formatted text string to the end of the task text.

## Cancel tasks (if enabled)
### Cancel tasks (if enabled)

If the current line is (or selection contains) a task, and the task matches the configuration for an incomplete task:

1. It will mark the task as canceled (`[-]`).
1. If an append text format string is configured, append a formatted text string to the end of the task text.
- It will mark the task as canceled (`[-]`).
- If an append text format string is configured, append a formatted text string to the end of the task text.

## Mark tasks

1. A dialog will pop up showing set task statuses in three groups:
- A dialog will pop up showing set task statuses in three groups:
- Group 1 contains marks for "completed" tasks.
- Group 2 contains marks for "Additional task statuses (row 1)".
- Group 3 contains marks for "Additional task statuses (row 2)".
2. Use the **mouse** to select an icon, or **type** the associated character.
- Use the **mouse** to select an icon, or **type** the associated character.
- For instance, one can type `x` to complete the task.

## Cycle task statuses
## Cycle task status

### Cycle task status

1. If the current status of the task matches one of the configured statuses, the status would change to the next one.
- 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.
1. If the current status of the task does not match any of the configured statuses, the status would change to the first one.
- 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

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

## Append text

1. If an append text format string is configured, append a formatted text string to the end of any line text.
2. One can configure text of different formats to append.
- If an append text format string is configured, append a formatted text string to the end of any line text.
- One can configure text of different formats to append.
- For example, the formats can correspond to the texts for creating, completing and marking tasks.

0 comments on commit 3ec722a

Please sign in to comment.