Skip to content

Commit f182f50

Browse files
committed
docs: Make file properties heading names in Grouping & Sorting match Filters
1 parent 39c952e commit f182f50

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

docs/Queries/Grouping.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,16 +154,32 @@ For more information, including adding your own customised statuses, see [[Statu
154154
155155
## Group by File Properties
156156

157+
### File Path
158+
157159
1. `path` (the path to the file that contains the task, that is, the folder and the filename)
160+
161+
### Root
162+
158163
1. `root` (the top-level folder of the file that contains the task, that is, the first directory in the path, which will be `/` for files in root of the vault)
164+
165+
> [!released]
166+
`root` grouping option was introduced in Tasks 1.11.0.
167+
168+
### Folder
169+
159170
1. `folder` (the folder to the file that contains the task, which will be `/` for files in root of the vault)
171+
172+
### File Name
173+
160174
1. `filename` (the link to the file that contains the task, without the `.md` extension)
161175
- Note that tasks from different notes with the same file name will be grouped together in the same group.
162176

163-
> [!released]
164-
`root` grouping option was introduced in Tasks 1.11.0.
177+
### Backlink
165178

166179
1. `backlink` (the text that would be shown in the task's [[Backlinks|backlink]], combining the task's file name and heading, but with no link added)
180+
181+
### Heading
182+
167183
1. `heading` (the heading preceding the task, or `(No heading)` if there are no headings in the file)
168184

169185
## Multiple groups

docs/Queries/Sorting.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,28 @@ For more information, including adding your own customised statuses, see [[Statu
9292

9393
## Sort by File Properties
9494

95+
### File Path
96+
9597
1. `path` (the path to the file that contains the task)
98+
99+
### Root
100+
101+
It is not currently possible to sort by the top-level folder that contains the task.
102+
103+
### Folder
104+
105+
It is not currently possible to sort by the folder that contains the task.
106+
107+
### File Name
108+
96109
1. `filename` (the filename of the file that contains the task, with its extension)
97110
- Note that tasks from different notes with the same file name will be sorter.
98111

99112
> [!released]
100113
`sort by filename` was introduced in Tasks 1.21.0.
101114

115+
### Heading
116+
102117
1. `sort by heading` (the heading preceding the task; files with empty headings sort before other tasks)
103118

104119
> [!released]

0 commit comments

Comments
 (0)