Skip to content

Commit da5e5de

Browse files
committed
docs: Remove single-entry numbered lists in Grouping and Sorting
Also, make the instruction lines explicit for each field, by inserting 'sort by ' or 'group by '.
1 parent f182f50 commit da5e5de

File tree

2 files changed

+68
-68
lines changed

2 files changed

+68
-68
lines changed

docs/Queries/Grouping.md

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,28 @@ For more information, including adding your own customised statuses, see [[Statu
2323

2424
### Status
2525

26-
1. `status` (Done or Todo, which is capitalized for visibility in the headings)
27-
- Note that the Done group is displayed before the Todo group,
26+
- `group by status` (Done or Todo, which is capitalized for visibility in the headings)
27+
- Note that the Done group is displayed before the Todo group,
2828
which differs from the Sorting ordering of this property.
2929

3030
### Status Name
3131

32-
1. `status.name`
33-
- This groups by the names you give to your custom statuses, in alphabetical order.
32+
- `group by status.name`
33+
- This groups by the names you give to your custom statuses, in alphabetical order.
3434

3535
> [!released]
3636
`group by status.name` was introduced in Tasks 1.23.0.
3737

3838
### Status Type
3939

40-
1. `status.type`
41-
- This groups by the types you have given to your custom statuses.
42-
- In order to impose a useful sort order, the types are prefixed with a number, so the groups will appear in this order, and with these group names:
43-
- `1 IN_PROGRESS`
44-
- `2 TODO`
45-
- `3 DONE`
46-
- `4 CANCELLED`
47-
- `5 NON_TASK`
40+
- `group by status.type`
41+
- This groups by the types you have given to your custom statuses.
42+
- In order to impose a useful sort order, the types are prefixed with a number, so the groups will appear in this order, and with these group names:
43+
- `1 IN_PROGRESS`
44+
- `2 TODO`
45+
- `3 DONE`
46+
- `4 CANCELLED`
47+
- `5 NON_TASK`
4848

4949
> [!released]
5050
`group by status.type` was introduced in Tasks 1.23.0.
@@ -53,52 +53,52 @@ For more information, including adding your own customised statuses, see [[Statu
5353

5454
### Done Date
5555

56-
1. `done`
57-
- The done date of the task, including the week-day, or `No done date`.
56+
- `group by done`
57+
- The done date of the task, including the week-day, or `No done date`.
5858

5959
> [!released]
6060
>
6161
> - `done` grouping option was introduced in Tasks 1.7.0.
6262
6363
### Due Date
6464

65-
1. `due`
66-
- The due date of the task, including the week-day, or `No due date`.
65+
- `group by due`
66+
- The due date of the task, including the week-day, or `No due date`.
6767

6868
> [!released]
6969
>
7070
> - `due` grouping option was introduced in Tasks 1.7.0.
7171
7272
### Scheduled Date
7373

74-
1. `scheduled`
75-
- The scheduled date of the task, including the week-day, or `No scheduled date`.
74+
- `group by scheduled`
75+
- The scheduled date of the task, including the week-day, or `No scheduled date`.
7676

7777
> [!released]
7878
>
7979
> - `scheduled` grouping option was introduced in Tasks 1.7.0.
8080
8181
### Start Date
8282

83-
1. `start`
84-
- The start date of the task, including the week-day, or `No start date`.
83+
- `group by start`
84+
- The start date of the task, including the week-day, or `No start date`.
8585

8686
> [!released]
8787
>
8888
> - `start` grouping option was introduced in Tasks 1.7.0.
8989
9090
### Created Date
9191

92-
1. `created`
93-
- The created date of the task, including the week-day, or `No created date`.
92+
- `group by created`
93+
- The created date of the task, including the week-day, or `No created date`.
9494

9595
> [!released]
9696
`created` grouping option was introduced in Tasks 2.0.0.
9797

9898
### Happens
9999

100-
1. `happens`
101-
- The earliest of start date, scheduled date, and due date, including the week-day, or `No happens date` if none of those are set.
100+
- `group by happens`
101+
- The earliest of start date, scheduled date, and due date, including the week-day, or `No happens date` if none of those are set.
102102

103103
> [!released]
104104
`happens` grouping option was introduced in Tasks 1.11.0.
@@ -107,46 +107,46 @@ For more information, including adding your own customised statuses, see [[Statu
107107

108108
### Priority
109109

110-
1. `priority`
111-
- The priority of the task, namely one of:
112-
- `Priority 0: Highest`
113-
- `Priority 1: High`
114-
- `Priority 2: Medium`
115-
- `Priority 3: None`
116-
- `Priority 4: Low`
117-
- `Priority 5: Lowest`
110+
- `group by priority`
111+
- The priority of the task, namely one of:
112+
- `Priority 0: Highest`
113+
- `Priority 1: High`
114+
- `Priority 2: Medium`
115+
- `Priority 3: None`
116+
- `Priority 4: Low`
117+
- `Priority 5: Lowest`
118118

119119
> [!released]
120120
>
121121
> - `priority` grouping option was introduced in Tasks 1.11.0.
122122
123123
### Urgency
124124

125-
1. `urgency` ([[Urgency|urgency]])
126-
- Currently, the groups run from the lowest urgency to highest.
127-
- You can reverse this with `group by urgency reverse`.
128-
- In a future release, the default group order will become from the highest urgency to lowest.
125+
- `group by urgency` ([[Urgency|urgency]])
126+
- Currently, the groups run from the lowest urgency to highest.
127+
- You can reverse this with `group by urgency reverse`.
128+
- In a future release, the default group order will become from the highest urgency to lowest.
129129

130130
> [!released]
131131
>
132132
> - `urgency` grouping option was introduced in Tasks 3.6.0.
133133
134134
### Recurrence
135135

136-
1. `recurring`
137-
- Whether the task is recurring: either `Recurring` or `Not Recurring`.
138-
1. `recurrence`
139-
- The recurrence rule of the task, for example `every week on Sunday`, or `None` for non-recurring tasks.
140-
- Note that the text displayed is generated programmatically and standardised, and so may not exactly match the text in any manually typed tasks. For example, a task with `🔁 every Sunday` is grouped in `every week on Sunday`.
136+
- `group by recurring`
137+
- Whether the task is recurring: either `Recurring` or `Not Recurring`.
138+
- `group by recurrence`
139+
- The recurrence rule of the task, for example `every week on Sunday`, or `None` for non-recurring tasks.
140+
- Note that the text displayed is generated programmatically and standardised, and so may not exactly match the text in any manually typed tasks. For example, a task with `🔁 every Sunday` is grouped in `every week on Sunday`.
141141

142142
> [!released]
143143
>
144144
> - `recurring` and `recurrence` grouping options were introduced in Tasks 1.11.0.
145145
146146
### Tags
147147

148-
1. `tags`
149-
- The tags of the tasks or `(No tags)`. If the task has multiple tags, it will show up under every tag.
148+
- `group by tags`
149+
- The tags of the tasks or `(No tags)`. If the task has multiple tags, it will show up under every tag.
150150

151151
> [!released]
152152
>
@@ -156,31 +156,31 @@ For more information, including adding your own customised statuses, see [[Statu
156156

157157
### File Path
158158

159-
1. `path` (the path to the file that contains the task, that is, the folder and the filename)
159+
- `group by path` (the path to the file that contains the task, that is, the folder and the filename)
160160

161161
### Root
162162

163-
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)
163+
- `group by 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)
164164

165165
> [!released]
166166
`root` grouping option was introduced in Tasks 1.11.0.
167167

168168
### Folder
169169

170-
1. `folder` (the folder to the file that contains the task, which will be `/` for files in root of the vault)
170+
- `group by folder` (the folder to the file that contains the task, which will be `/` for files in root of the vault)
171171

172172
### File Name
173173

174-
1. `filename` (the link to the file that contains the task, without the `.md` extension)
175-
- Note that tasks from different notes with the same file name will be grouped together in the same group.
174+
- `group by filename` (the link to the file that contains the task, without the `.md` extension)
175+
- Note that tasks from different notes with the same file name will be grouped together in the same group.
176176

177177
### Backlink
178178

179-
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)
179+
- `group by 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)
180180

181181
### Heading
182182

183-
1. `heading` (the heading preceding the task, or `(No heading)` if there are no headings in the file)
183+
- `group by heading` (the heading preceding the task, or `(No heading)` if there are no headings in the file)
184184

185185
## Multiple groups
186186

docs/Queries/Sorting.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ For more information, including adding your own customised statuses, see [[Statu
2020

2121
### Status
2222

23-
1. `status` (done or todo)
23+
- `sort by status` (done or todo)
2424

2525
### Status Name
2626

27-
1. `status.name` (Done, Todo, Cancelled, In Progress, Unknown, My very important custom status, etc - sorted alphabetically)
27+
- `sort by status.name` (Done, Todo, Cancelled, In Progress, Unknown, My very important custom status, etc - sorted alphabetically)
2828

2929
> [!released]
3030
`sort by status.name` was introduced in Tasks 1.23.0.
3131

3232
### Status Type
3333

34-
1. `status.type` (Sorted in the order `IN_PROGRESS`, `TODO`, `DONE`, `CANCELLED` then `NON_TASK`)
34+
- `sort by status.type` (Sorted in the order `IN_PROGRESS`, `TODO`, `DONE`, `CANCELLED` then `NON_TASK`)
3535

3636
> [!released]
3737
`sort by status.type` was introduced in Tasks 1.23.0.
@@ -40,30 +40,30 @@ For more information, including adding your own customised statuses, see [[Statu
4040

4141
### Done Date
4242

43-
1. `done` (the date when the task was done)
43+
- `sort by done` (the date when the task was done)
4444

4545
### Due Date
4646

47-
1. `due` (the date when the task is due)
47+
- `sort by due` (the date when the task is due)
4848

4949
### Scheduled Date
5050

51-
1. `scheduled` (the date when the task is scheduled)
51+
- `sort by scheduled` (the date when the task is scheduled)
5252

5353
### Start Date
5454

55-
1. `start` (the date when the task starts)
55+
- `sort by start` (the date when the task starts)
5656

5757
### Created Date
5858

59-
1. `created` (the date when the task was created)
59+
- `sort by created` (the date when the task was created)
6060

6161
> [!released]
6262
`sort by created` was introduced in Tasks 2.0.0.
6363

6464
### Happens
6565

66-
1. `happens` (the earliest of start date, scheduled date, and due date)
66+
- `sort by happens` (the earliest of start date, scheduled date, and due date)
6767

6868
> [!released]
6969
`sort by happens` was introduced in Tasks 1.21.0.
@@ -72,29 +72,29 @@ For more information, including adding your own customised statuses, see [[Statu
7272

7373
### Description
7474

75-
1. `description` (the description of the task)
75+
- `sort by description` (the description of the task)
7676

7777
### Priority
7878

79-
1. `priority` (priority of the task; "low" is below "none": [[Priority|priorities]])
79+
- `sort by priority` (priority of the task; "low" is below "none": [[Priority|priorities]])
8080

8181
### Urgency
8282

83-
1. `urgency` ([[Urgency|urgency]])
83+
- `sort by urgency` ([[Urgency|urgency]])
8484

8585
### Recurrence
8686

87-
1. `recurring` (recurring tasks sort before non-recurring ones: [[Recurring Tasks]])
87+
- `sort by recurring` (recurring tasks sort before non-recurring ones: [[Recurring Tasks]])
8888

8989
### Tags
9090

91-
1. `tag` (the description of the task)
91+
- `sort by tag` (the description of the task)
9292

9393
## Sort by File Properties
9494

9595
### File Path
9696

97-
1. `path` (the path to the file that contains the task)
97+
- `sort by path` (the path to the file that contains the task)
9898

9999
### Root
100100

@@ -106,15 +106,15 @@ It is not currently possible to sort by the folder that contains the task.
106106

107107
### File Name
108108

109-
1. `filename` (the filename of the file that contains the task, with its extension)
110-
- Note that tasks from different notes with the same file name will be sorter.
109+
- `sort by filename` (the filename of the file that contains the task, with its extension)
110+
- Note that tasks from different notes with the same file name will be sorter.
111111

112112
> [!released]
113113
`sort by filename` was introduced in Tasks 1.21.0.
114114

115115
### Heading
116116

117-
1. `sort by heading` (the heading preceding the task; files with empty headings sort before other tasks)
117+
- `sort by sort by heading` (the heading preceding the task; files with empty headings sort before other tasks)
118118

119119
> [!released]
120120
`sort by heading` was introduced in Tasks 1.21.0.

0 commit comments

Comments
 (0)