Skip to content

Commit

Permalink
Update to version 4.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
claremacrae committed Jul 9, 2023
1 parent b183a17 commit be5405e
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 31 deletions.
2 changes: 1 addition & 1 deletion docs/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ publish: true

## What's New?

- X.Y.Z: 🔥 Add [[Custom Filters|custom filtering]]
- 4.2.0: 🔥 Add [[Custom Filters|custom filtering]]
- 4.1.0: 🔥 Add [[Layout|hide and show tags]]
- 4.0.0: 🔥 Add [[Custom Grouping|custom grouping]], using [[Task Properties|task properties]] to create [[expressions|expressions]] - the start of a whole new [[About Scripting|scripting]] world in Tasks!
- 3.9.0: 🔥 Add [[Priority#Priorities and Order|lowest and highest]] priorities
Expand Down
48 changes: 24 additions & 24 deletions docs/Queries/Filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This page is long. Here are some links to the main sections:
## Custom Filters

> [!released]
> `filter by function` was introduced in Tasks X.Y.Z.
> `filter by function` was introduced in Tasks 4.2.0.
Tasks provides many built-in filtering options, but sometimes they don't quite do what is wanted by all users.

Expand Down Expand Up @@ -222,7 +222,7 @@ For full details of combining filters with boolean operators, see [[Combining Fi
>
> The new behaviour is more flexible and was required to introduce support for in-progress and cancelled tasks. If the original behaviour is preferred, you can change the status types of every symbol except `space` to `DONE`. See [[Set up custom statuses|How to set up your custom statuses]].
Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by status** is now possible, using `task.isDone`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by status** is now possible, using `task.isDone`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.other_properties_task.isDone_docs.approved.md -->

Expand Down Expand Up @@ -251,7 +251,7 @@ Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by status** is now poss

For more information, including adding your own customised statuses, see [[Statuses]].

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by status names** is now possible, using `task.status.name`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by status names** is now possible, using `task.status.name`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.statuses_task.status.name_docs.approved.md -->

Expand All @@ -276,7 +276,7 @@ Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by status names** is no

For more information, including adding your own customised statuses, see [[Statuses]].

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by status type** is now possible, using `task.status.type`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by status type** is now possible, using `task.status.type`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.statuses_task.status.type_docs.approved.md -->

Expand All @@ -294,7 +294,7 @@ Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by status type** is now

There is no built-in instruction to filter by status symbols.

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by status symbol** is now possible, using `task.status.symbol`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by status symbol** is now possible, using `task.status.symbol`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.statuses_task.status.symbol_docs.approved.md -->

Expand All @@ -317,7 +317,7 @@ Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by status symbol** is n

There is no built-in instruction to filter by next status symbols.

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by next status symbol** is now possible, using `task.status.nextSymbol`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by next status symbol** is now possible, using `task.status.nextSymbol`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.statuses_task.status.nextSymbol_docs.approved.md -->

Expand Down Expand Up @@ -359,7 +359,7 @@ For more information, see [[Dates#Due date|Due date]].
> - `due (before|after|in) <date range>` searches were introduced in Tasks 2.0.0.
> - `due (before|after|in) (YYYY-Www|YYYY-mm|YYYY-Qq|YYYY)` searches were introduced in Tasks 3.1.0.
Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by due date** is now possible, using `task.due`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by due date** is now possible, using `task.due`.

These examples all use `task.due` property, which is a `TasksDate` object. You can see the current [TasksDate source code](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Scripting/TasksDate.ts), to explore its capabilities.

Expand Down Expand Up @@ -411,7 +411,7 @@ For more information, see [[Dates#Done date|Done date]].
> - `done (before|after|in) <date range>` searches were introduced in Tasks 2.0.0.
> - `done (before|after|in) (YYYY-Www|YYYY-mm|YYYY-Qq|YYYY)` searches were introduced in Tasks 3.1.0.
Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by done date** is now possible, using `task.done`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by done date** is now possible, using `task.done`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.dates_task.done_docs.approved.md -->

Expand Down Expand Up @@ -443,7 +443,7 @@ For more information, see [[Dates#Scheduled date|Scheduled date]].
> - `scheduled (before|after|in) <date range>` searches were introduced in Tasks 2.0.0.
> - `scheduled (before|after|in) (YYYY-Www|YYYY-mm|YYYY-Qq|YYYY)` searches were introduced in Tasks 3.1.0.
Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by scheduled date** is now possible, using `task.scheduled`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by scheduled date** is now possible, using `task.scheduled`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.dates_task.scheduled_docs.approved.md -->

Expand Down Expand Up @@ -475,7 +475,7 @@ For more information, see [[Dates#Start date|Start date]].
> - `starts (before|after|in) <date range>` searches were introduced in Tasks 2.0.0.
> - `starts (before|after|in) (YYYY-Www|YYYY-mm|YYYY-Qq|YYYY)` searches were introduced in Tasks 3.1.0.
Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by start date** is now possible, using `task.start`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by start date** is now possible, using `task.start`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.dates_task.start_docs.approved.md -->

Expand Down Expand Up @@ -537,7 +537,7 @@ Such a filter could be:
> - Created date was introduced in Tasks 2.0.0.
> - `created (before|after|in) (YYYY-Www|YYYY-mm|YYYY-Qq|YYYY)` searches were introduced in Tasks 3.1.0.
Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by created date** is now possible, using `task.created`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by created date** is now possible, using `task.created`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.dates_task.created_docs.approved.md -->

Expand Down Expand Up @@ -573,7 +573,7 @@ because the tasks starts before tomorrow. Only one of the dates needs to match.
> - `happens (before|after|in) <date range>` searches were introduced in Tasks 2.0.0.
> - `happens (before|after|in) (YYYY-Www|YYYY-mm|YYYY-Qq|YYYY)` searches were introduced in Tasks 3.1.0.
Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by happens date** is now possible, using `task.happens`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by happens date** is now possible, using `task.happens`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.dates_task.happens_docs.approved.md -->

Expand Down Expand Up @@ -653,7 +653,7 @@ For example:
| `#task` | `'- [ ] #task Do stuff ⏫ #tag1 ✅ 2022-08-12 #tag2/sub-tag '` | `'Do stuff #tag1 #tag2/sub-tag'` |
| `global-filter` | `'- [ ] global-filter Do stuff ⏫ #tag1 ✅ 2022-08-12 #tag2/sub-tag '` | `'Do stuff #tag1 #tag2/sub-tag'` |

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by description** is now possible, using `task.description`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by description** is now possible, using `task.description`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.other_properties_task.description_docs.approved.md -->

Expand All @@ -664,7 +664,7 @@ Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by description** is now

### Description without tags

Since Tasks X.Y.Z, it is possible to remove tags from the descriptions in custom filters, for use in **[[Custom Filters|custom filtering]]**, using `task.descriptionWithoutTags`.
Since Tasks 4.2.0, it is possible to remove tags from the descriptions in custom filters, for use in **[[Custom Filters|custom filtering]]**, using `task.descriptionWithoutTags`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.other_properties_task.descriptionWithoutTags_docs.approved.md -->

Expand All @@ -688,7 +688,7 @@ For more information, see [[Priority|Priorities]].
> [!released]
> Priorities 'lowest' and 'highest' were introduced in Tasks 3.9.0.
Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by priority name and number** is now possible, using `task.priorityName` and `task.priorityNumber`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by priority name and number** is now possible, using `task.priorityName` and `task.priorityNumber`.

Using the priority name:

Expand Down Expand Up @@ -729,7 +729,7 @@ Using the priority number:

There is no built-in instruction to filter by urgency.

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by urgency** is now possible, using `task.urgency`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by urgency** is now possible, using `task.urgency`.

> [!Warning]
> Please read the following examples carefully. To use `task.urgency` with `filter by function` successfully, it is important to understand how to handle searches for non-integer numbers.
Expand Down Expand Up @@ -782,7 +782,7 @@ For more information, see [[Recurring Tasks]].
> [!released]
`recurrence` text searching was introduced in Tasks 1.22.0.

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by recurrence** is now possible, using `task.isRecurring` and `task.recurrenceRule`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by recurrence** is now possible, using `task.isRecurring` and `task.recurrenceRule`.

Using `task.isRecurring`:

Expand Down Expand Up @@ -848,7 +848,7 @@ Introduced in Tasks 1.6.0.
> - `regex matches` and `regex does not match` were introduced in Tasks 1.13.0.
> - `no tags` and `has tags` were introduced in Tasks 2.0.0.
Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by tags** is now possible, using `task.tags`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by tags** is now possible, using `task.tags`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.other_properties_task.tags_docs.approved.md -->

Expand Down Expand Up @@ -885,7 +885,7 @@ These are more complicated examples, which you might like to copy if you use tas

There is no built-in instruction to filter by the original markdown line.

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by original markdown line** is now possible, using `task.originalMarkdown`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by original markdown line** is now possible, using `task.originalMarkdown`.

For example, this could be used to extract information from `task.originalMarkdown` that Tasks does not parse, to use for filtering tasks.

Expand All @@ -912,7 +912,7 @@ Note that the path includes the `.md` extension.
> [!released]
`regex matches` and `regex does not match` were introduced in Tasks 1.12.0.

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by file path** is now possible, using `task.file.path`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by file path** is now possible, using `task.file.path`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.file_properties_task.file.path_docs.approved.md -->

Expand Down Expand Up @@ -940,7 +940,7 @@ The `root` is the top-level folder of the file that contains the task, that is,
- Does regular expression match (case-sensitive by default).
- Essential reading: [[Regular Expressions|Regular Expression Searches]].

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by root folder** is now possible, using `task.file.root`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by root folder** is now possible, using `task.file.root`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.file_properties_task.file.root_docs.approved.md -->

Expand All @@ -966,7 +966,7 @@ This is the `folder` to the file that contains the task, which will be `/` for f
- Does regular expression match (case-sensitive by default).
- Essential reading: [[Regular Expressions|Regular Expression Searches]].

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by folder** is now possible, using `task.file.folder`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by folder** is now possible, using `task.file.folder`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.file_properties_task.file.folder_docs.approved.md -->

Expand Down Expand Up @@ -995,7 +995,7 @@ Note that the file name includes the `.md` extension.
- Does regular expression match (case-sensitive by default).
- Essential reading: [[Regular Expressions|Regular Expression Searches]].

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by file name** is now possible, using `task.file.filename`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by file name** is now possible, using `task.file.filename`.

<!-- placeholder to force blank line before included text --> <!-- include: CustomFilteringExamples.test.file_properties_task.file.filename_docs.approved.md -->

Expand Down Expand Up @@ -1024,7 +1024,7 @@ Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by file name** is now p
> [!released]
`regex matches` and `regex does not match` were introduced in Tasks 1.12.0.

Since Tasks X.Y.Z, **[[Custom Filters|custom filtering]] by heading** is now possible, using `task.heading`.
Since Tasks 4.2.0, **[[Custom Filters|custom filtering]] by heading** is now possible, using `task.heading`.

> [!Tip]
> Heading searches can be very powerful: you can put information in headings and then write your searches to look for the information:
Expand Down
2 changes: 1 addition & 1 deletion docs/Queries/Grouping.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ Since Tasks 4.0.0, **[[Custom Grouping|custom grouping]] by description** is now

### Description without tags

Since Tasks X.Y.Z, it is possible to remove tags from the descriptions in custom groups, for use in **[[Custom Grouping|custom grouping]]**.
Since Tasks 4.2.0, it is possible to remove tags from the descriptions in custom groups, for use in **[[Custom Grouping|custom grouping]]**.

The value `task.descriptionWithoutTags` returns a copy of the description with all the tags removed, so that you can group together any tasks whose descriptions differ only by their tags.

Expand Down
2 changes: 1 addition & 1 deletion docs/Scripting/Custom Filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ publish: true
<span class="related-pages">#feature/scripting #feature/filters</span>

> [!released]
> Custom filters were introduced in Tasks X.Y.Z.
> Custom filters were introduced in Tasks 4.2.0.
## Summary

Expand Down
2 changes: 1 addition & 1 deletion docs/Scripting/Expressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ publish: true
- The expression is a string instruction.
- Depending on the context, one or two tasks are passed in to the expression, and a calculation is performed.
- As of Tasks 4.0.0, in fact only a single task is passed in, to implement [[Custom Grouping]].
- As of Tasks X.Y.Z, a single task is passed in, to implement [[Custom Filters]].
- As of Tasks 4.2.0, a single task is passed in, to implement [[Custom Filters]].
- Tasks then calculates a value from the inputs.

## Example expressions
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "obsidian-tasks-plugin",
"name": "Tasks",
"version": "4.1.0",
"version": "4.2.0",
"minAppVersion": "1.1.1",
"description": "Task management for Obsidian",
"author": "Martin Schenck and Clare Macrae",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "obsidian-tasks",
"version": "4.1.0",
"version": "4.2.0",
"description": "Task management for the Obsidian knowledge base",
"main": "main.js",
"scripts": {
Expand Down
3 changes: 2 additions & 1 deletion versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,6 @@
"3.10.0": "1.1.1",
"4.0.0": "1.1.1",
"4.0.1": "1.1.1",
"4.1.0": "1.1.1"
"4.1.0": "1.1.1",
"4.2.0": "1.1.1"
}

0 comments on commit be5405e

Please sign in to comment.