Skip to content

Commit

Permalink
docs: Record limitations task date support, to aid user support
Browse files Browse the repository at this point in the history
  • Loading branch information
claremacrae committed Oct 18, 2024
1 parent 75893b5 commit d216a16
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/Getting Started/Dates.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,3 +202,24 @@ However, it is possible to search for any tasks with invalid dates in your vault

> [!warning]
The date values on task lines must be calendar or absolute dates, referring to a specific year, month and day. Text such as `📅 today` is not understood by the Tasks plugin, and will not be found in searches.

## Limitations of task date support

### Date format is not configurable

- The date format on task lines is not yet configurable.
- The only format recognised is `YYYY-MM-DD`, for example `2024-09-17`.
- It is not possible to customise the format of date values on task lines.
- It is also not possible to format dates as links, such as `[[2024-09-17]]`.
- We are tracking this in [discussion #69](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/69).

### Dates cannot include times

- It is not yet possible to include times on task lines to indicate when they *should* be acted on.
- Nor is it possible to record the time when tasks were created, completed or cancelled.
- We are tracking this in discussions [#607](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/607) and [#668](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/668).

### Time-tracking, productivity tracking, pomodoros, notifications and similar out-of-scope

- The following are out-of-scope for the Tasks plugin: time-tracking, productivity tracking, pomodoros, notifications and similar.
- We recorded this in [discussion #2721](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/2721).
4 changes: 4 additions & 0 deletions docs/Support and Help/Known Limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ This page gathers together all the documentation on known limitations of the plu

![[Getting Started#Limitations and warnings]]

## Writing Tasks: Dates

![[Dates#Limitations of task date support]]

## Writing Tasks: Dependencies

![[Task Dependencies#Known Limitations]]
Expand Down

0 comments on commit d216a16

Please sign in to comment.