mirror of
https://github.com/l7cy/obsidian-dynamic-timetable.git
synced 2026-07-22 07:40:29 +00:00
画像等
This commit is contained in:
parent
2afe051a19
commit
a05cb7ec8d
1 changed files with 19 additions and 10 deletions
29
README.md
29
README.md
|
|
@ -2,10 +2,12 @@
|
|||
|
||||
Dynamic Timetable is an [Obsidian](https://obsidian.md/) plugin that dynamically generates task timetables from Markdown files. This plugin was inspired by [タスクシュート(TaskChute)](https://cyblog.biz/pro/taskchute2/index2.php).
|
||||
|
||||
[](https://gyazo.com/8d8e6c74fc01416cd093d13c58632214)
|
||||
[](https://gyazo.com/6f1eb253ff398b6cafb3ac8835925753)
|
||||
|
||||
## Installation
|
||||
|
||||
The plugin is now officially released as a community plugin. You can install it from below.
|
||||
|
||||
```
|
||||
obsidian://show-plugin?id=dynamic-timetable
|
||||
```
|
||||
|
|
@ -13,32 +15,39 @@ obsidian://show-plugin?id=dynamic-timetable
|
|||
If you want to try the beta version, install it with `L7Cy/obsidian-dynamic-timetable` using [BRAT](https://github.com/TfTHacker/obsidian42-brat).
|
||||
|
||||
## Usage
|
||||
The Dynamic Timetable plugin generates task lists and time estimates from markdown files. The plugin supports the following markdown formats for tasks (including subtasks).
|
||||
|
||||
### Task description format
|
||||
|
||||
The plugin supports the following markdown formats for tasks.
|
||||
|
||||
```
|
||||
- [ ] Task name ; Estimated time
|
||||
- [ ] Task name ; Estimated time @ Start time
|
||||
- [ ] Task name @ Start time ; Estimated time
|
||||
```
|
||||
Completed tasks and tasks without estimated time are excluded.
|
||||
|
||||
To display the task list, open the command palette (Ctrl/Cmd + P) and type "Show/Hide Timetable".
|
||||
|
||||
By default, the plugin uses the currently active file as the source of the task list. If you want to use a different file, you can specify the file path in the plugin settings.
|
||||
|
||||
### Start time format
|
||||
|
||||
The start time is optional and can be added in two formats:
|
||||
|
||||
- Time only (e.g., `@ 14:30`)
|
||||
- Date and time (e.g., `@ 2023-04-16T14:30`)
|
||||
|
||||
### Task completion and interruption
|
||||
|
||||
To complete or interrupt a task, execute the commands "Complete Task" or "Interrupt Task." Upon execution, the topmost incomplete task is checked, and the estimated time and scheduled start time are overwritten with the actual time taken and actual start time.
|
||||
|
||||
[](https://gyazo.com/687f9193d6f01d1eb4f1e05b7ccda84b)
|
||||
|
||||
In the case of "Interrupt Task," in addition to this, a new task with the same name is created and the remaining time is set to the estimated time.
|
||||
|
||||
[](https://gyazo.com/526d2f3eaa20b533dffc2093a6758d9b)
|
||||
|
||||
### Task text color
|
||||
|
||||
When a start time is specified, tasks will have a text color based on the comparison with the end time of the previous task:
|
||||
|
||||
- 🟢Green: Indicates that the task is likely to start at the scheduled time, and there may be room to add more tasks before it.
|
||||
- 🔴Red: Indicates that it may be difficult to start the task at the scheduled time, and adjustments to previous tasks may be necessary.
|
||||
|
||||
This visual cue helps us understand how to effectively adjust our tasks.
|
||||
|
||||
## License
|
||||
This software is released under the [MIT License](https://opensource.org/license/mit/).
|
||||
|
|
|
|||
Loading…
Reference in a new issue