Merge pull request #3316 from obsidian-tasks-group/shorten-property-names

refactor: Rename 'tasks_query_*' properties to 'TQ_*'

Author: claremacrae

docs/Queries/Query File Defaults.md

@@ -30,12 +30,12 @@ To try this out:
     - Enable the Obsidian core Properties view plugin: `Settings` > `Core plugins` > turn on `Properties view`
     - Switch to Reading or Live Preview modes.
     - Run the `Properties view: Show file properties` command.
-2. Add one or more `tasks_query_*` properties to the file
+2. Add one or more `TQ_*` properties to the file
     - Click on `Add property`.
-    - Start typing `tasks_query_`.
+    - Start typing `TQ_`.
     - Or you can paste in property names from the [[#Supported Query File Defaults property values]] section below.
     - Press `<Return>` or `<Enter>` to add the property.
-3. Now you can modify these `tasks_query_*` properties to change the behaviour of Tasks searches in this file.
+3. Now you can modify these `TQ_*` properties to change the behaviour of Tasks searches in this file.
 
 > [!info]
 > We plan to streamline the addition of these properties to notes.
@@ -50,7 +50,7 @@ You can make them wider with the following CSS Snippet.
 ```css
 /* Make property labels wider, to fit the names of Tasks-specific properties */
 .metadata-content {
-    --metadata-label-width: 18em;
+    --metadata-label-width: 14em;
 }
 ```
 <!-- endSnippet -->
@@ -84,27 +84,27 @@ These are all the properties currently supported by Tasks, as Query File Default
 <!-- snippet: DocsSamplesForDefaults.test.DocsSamplesForDefaults_supported-properties-empty.approved.yaml -->
 ```yaml
 ---
-tasks_query_explain:
-tasks_query_short_mode:
-tasks_query_show_tree:
-tasks_query_show_tags:
-tasks_query_show_id:
-tasks_query_show_depends_on:
-tasks_query_show_priority:
-tasks_query_show_recurrence_rule:
-tasks_query_show_on_completion:
-tasks_query_show_created_date:
-tasks_query_show_start_date:
-tasks_query_show_scheduled_date:
-tasks_query_show_due_date:
-tasks_query_show_cancelled_date:
-tasks_query_show_done_date:
-tasks_query_show_urgency:
-tasks_query_show_backlink:
-tasks_query_show_edit_button:
-tasks_query_show_postpone_button:
-tasks_query_show_task_count:
-tasks_query_extra_instructions:
+TQ_explain:
+TQ_short_mode:
+TQ_show_tree:
+TQ_show_tags:
+TQ_show_id:
+TQ_show_depends_on:
+TQ_show_priority:
+TQ_show_recurrence_rule:
+TQ_show_on_completion:
+TQ_show_created_date:
+TQ_show_start_date:
+TQ_show_scheduled_date:
+TQ_show_due_date:
+TQ_show_cancelled_date:
+TQ_show_done_date:
+TQ_show_urgency:
+TQ_show_backlink:
+TQ_show_edit_button:
+TQ_show_postpone_button:
+TQ_show_task_count:
+TQ_extra_instructions:
 ---
 ```
 <!-- endSnippet -->
@@ -125,27 +125,29 @@ File Defaults.
 ```json
 {
   "types": {
-    "tasks_query_explain": "checkbox",
-    "tasks_query_short_mode": "checkbox",
-    "tasks_query_show_tree": "checkbox",
-    "tasks_query_show_tags": "checkbox",
-    "tasks_query_show_id": "checkbox",
-    "tasks_query_show_depends_on": "checkbox",
-    "tasks_query_show_priority": "checkbox",
-    "tasks_query_show_recurrence_rule": "checkbox",
-    "tasks_query_show_on_completion": "checkbox",
-    "tasks_query_show_created_date": "checkbox",
-    "tasks_query_show_start_date": "checkbox",
-    "tasks_query_show_scheduled_date": "checkbox",
-    "tasks_query_show_due_date": "checkbox",
-    "tasks_query_show_cancelled_date": "checkbox",
-    "tasks_query_show_done_date": "checkbox",
-    "tasks_query_show_urgency": "checkbox",
-    "tasks_query_show_backlink": "checkbox",
-    "tasks_query_show_edit_button": "checkbox",
-    "tasks_query_show_postpone_button": "checkbox",
-    "tasks_query_show_task_count": "checkbox",
-    "tasks_query_extra_instructions": "text"
+    "TQ_explain": "checkbox",
+    "TQ_short_mode": "checkbox",
+    "TQ_show_tree": "checkbox",
+    "TQ_show_tags": "checkbox",
+    "TQ_show_id": "checkbox",
+    "TQ_show_depends_on": "checkbox",
+    "TQ_show_priority": "checkbox",
+    "TQ_show_recurrence_rule": "checkbox",
+    "TQ_show_on_completion": "checkbox",
+    "TQ_show_created_date": "checkbox",
+    "TQ_show_start_date": "checkbox",
+    "TQ_show_scheduled_date": "checkbox",
+    "TQ_show_due_date": "checkbox",
+    "TQ_show_cancelled_date": "checkbox",
+    "TQ_show_done_date": "checkbox",
+    "TQ_show_urgency": "checkbox",
+    "TQ_show_backlink": "checkbox",
+    "TQ_show_edit_button": "checkbox",
+    "TQ_show_postpone_button": "checkbox",
+    "TQ_show_task_count": "checkbox",
+    "TQ_sort_by": "multitext",
+    "TQ_group_by": "multitext",
+    "TQ_extra_instructions": "text"
   }
 }
 ```

docs/images/query-file-defaults-file-properties-controls.png

@@ -1,18 +1,18 @@
 <!-- snippet: DocsSamplesForDefaults.test.DocsSamplesForDefaults_meta-bind-widgets-snippet.approved.md -->
 ```md
-short mode: `INPUT[toggle:tasks_query_short_mode]`
-tree: `INPUT[toggle:tasks_query_show_tree]`
-tags: `INPUT[toggle:tasks_query_show_tags]`
-id: `INPUT[toggle:tasks_query_show_id]` depends on: `INPUT[toggle:tasks_query_show_depends_on]`
-priority: `INPUT[toggle:tasks_query_show_priority]`
-recurrence rule: `INPUT[toggle:tasks_query_show_recurrence_rule]` on completion: `INPUT[toggle:tasks_query_show_on_completion]`
-start date: `INPUT[toggle:tasks_query_show_start_date]` scheduled date: `INPUT[toggle:tasks_query_show_scheduled_date]` due date: `INPUT[toggle:tasks_query_show_due_date]`
-created date: `INPUT[toggle:tasks_query_show_created_date]` cancelled date: `INPUT[toggle:tasks_query_show_cancelled_date]` done date: `INPUT[toggle:tasks_query_show_done_date]`
-urgency: `INPUT[toggle:tasks_query_show_urgency]`
-backlink: `INPUT[toggle:tasks_query_show_backlink]`
-edit button: `INPUT[toggle:tasks_query_show_edit_button]` postpone button: `INPUT[toggle:tasks_query_show_postpone_button]`
-task count: `INPUT[toggle:tasks_query_show_task_count]`
-extra instructions: `INPUT[textArea:tasks_query_extra_instructions]`
-explain: `INPUT[toggle:tasks_query_explain]`
+short mode: `INPUT[toggle:TQ_short_mode]`
+tree: `INPUT[toggle:TQ_show_tree]`
+tags: `INPUT[toggle:TQ_show_tags]`
+id: `INPUT[toggle:TQ_show_id]` depends on: `INPUT[toggle:TQ_show_depends_on]`
+priority: `INPUT[toggle:TQ_show_priority]`
+recurrence rule: `INPUT[toggle:TQ_show_recurrence_rule]` on completion: `INPUT[toggle:TQ_show_on_completion]`
+start date: `INPUT[toggle:TQ_show_start_date]` scheduled date: `INPUT[toggle:TQ_show_scheduled_date]` due date: `INPUT[toggle:TQ_show_due_date]`
+created date: `INPUT[toggle:TQ_show_created_date]` cancelled date: `INPUT[toggle:TQ_show_cancelled_date]` done date: `INPUT[toggle:TQ_show_done_date]`
+urgency: `INPUT[toggle:TQ_show_urgency]`
+backlink: `INPUT[toggle:TQ_show_backlink]`
+edit button: `INPUT[toggle:TQ_show_edit_button]` postpone button: `INPUT[toggle:TQ_show_postpone_button]`
+task count: `INPUT[toggle:TQ_show_task_count]`
+extra instructions: `INPUT[textArea:TQ_extra_instructions]`
+explain: `INPUT[toggle:TQ_explain]`
 ```
 <!-- endSnippet -->

docs/snippets-embedded-in-multiple-pages/Meta Bind Query Widgets.md

@@ -1,4 +1,4 @@
 /* Make property labels wider, to fit the names of Tasks-specific properties */
 .metadata-content {
-    --metadata-label-width: 18em;
+    --metadata-label-width: 14em;
 }

resources/sample_vaults/Tasks-Demo/.obsidian/snippets/widen-property-labels.css

@@ -16,28 +16,28 @@
     "creation date": "datetime",
     "project": "text",
     "sample_text_multiline_property": "text",
-    "tasks_query_explain": "checkbox",
-    "tasks_query_short_mode": "checkbox",
-    "tasks_query_show_tree": "checkbox",
-    "tasks_query_show_tags": "checkbox",
-    "tasks_query_show_id": "checkbox",
-    "tasks_query_show_depends_on": "checkbox",
-    "tasks_query_show_priority": "checkbox",
-    "tasks_query_show_recurrence_rule": "checkbox",
-    "tasks_query_show_on_completion": "checkbox",
-    "tasks_query_show_created_date": "checkbox",
-    "tasks_query_show_start_date": "checkbox",
-    "tasks_query_show_scheduled_date": "checkbox",
-    "tasks_query_show_due_date": "checkbox",
-    "tasks_query_show_cancelled_date": "checkbox",
-    "tasks_query_show_done_date": "checkbox",
-    "tasks_query_show_urgency": "checkbox",
-    "tasks_query_show_backlink": "checkbox",
-    "tasks_query_show_edit_button": "checkbox",
-    "tasks_query_show_postpone_button": "checkbox",
-    "tasks_query_show_task_count": "checkbox",
-    "tasks_query_sort_by": "multitext",
-    "tasks_query_group_by": "multitext",
-    "tasks_query_extra_instructions": "text"
+    "TQ_explain": "checkbox",
+    "TQ_short_mode": "checkbox",
+    "TQ_show_tree": "checkbox",
+    "TQ_show_tags": "checkbox",
+    "TQ_show_id": "checkbox",
+    "TQ_show_depends_on": "checkbox",
+    "TQ_show_priority": "checkbox",
+    "TQ_show_recurrence_rule": "checkbox",
+    "TQ_show_on_completion": "checkbox",
+    "TQ_show_created_date": "checkbox",
+    "TQ_show_start_date": "checkbox",
+    "TQ_show_scheduled_date": "checkbox",
+    "TQ_show_due_date": "checkbox",
+    "TQ_show_cancelled_date": "checkbox",
+    "TQ_show_done_date": "checkbox",
+    "TQ_show_urgency": "checkbox",
+    "TQ_show_backlink": "checkbox",
+    "TQ_show_edit_button": "checkbox",
+    "TQ_show_postpone_button": "checkbox",
+    "TQ_show_task_count": "checkbox",
+    "TQ_sort_by": "multitext",
+    "TQ_group_by": "multitext",
+    "TQ_extra_instructions": "text"
   }
 }

resources/sample_vaults/Tasks-Demo/.obsidian/types.json

@@ -1,31 +1,31 @@
 ---
-tasks_query_explain: false
-tasks_query_short_mode: false
-tasks_query_show_tree: true
-tasks_query_show_tags: true
-tasks_query_show_id: true
-tasks_query_show_depends_on: true
-tasks_query_show_priority: true
-tasks_query_show_recurrence_rule: true
-tasks_query_show_on_completion: true
-tasks_query_show_created_date: true
-tasks_query_show_start_date: true
-tasks_query_show_scheduled_date: true
-tasks_query_show_due_date: true
-tasks_query_show_cancelled_date: true
-tasks_query_show_done_date: true
-tasks_query_show_urgency: true
-tasks_query_show_backlink: true
-tasks_query_show_edit_button: true
-tasks_query_show_postpone_button: true
-tasks_query_show_task_count: true
-tasks_query_sort_by:
+TQ_explain: false
+TQ_short_mode: false
+TQ_show_tree: true
+TQ_show_tags: true
+TQ_show_id: true
+TQ_show_depends_on: true
+TQ_show_priority: true
+TQ_show_recurrence_rule: true
+TQ_show_on_completion: true
+TQ_show_created_date: true
+TQ_show_start_date: true
+TQ_show_scheduled_date: true
+TQ_show_due_date: true
+TQ_show_cancelled_date: true
+TQ_show_done_date: true
+TQ_show_urgency: true
+TQ_show_backlink: true
+TQ_show_edit_button: true
+TQ_show_postpone_button: true
+TQ_show_task_count: true
+TQ_sort_by:
   - description
-tasks_query_group_by:
+TQ_group_by:
   - status.type
   - happens reverse
   - function task.tags.sort().join(' ')
-tasks_query_extra_instructions: |-
+TQ_extra_instructions: |-
   # press shift-return to add new lines
   # not done
   # sort by done date
@@ -39,28 +39,28 @@ tasks_query_extra_instructions: |-
 
 <!-- placeholder to force blank line before included text --><!-- include: DocsSamplesForDefaults.test.DocsSamplesForDefaults_meta-bind-widgets-include.approved.md -->
 
-short mode: `INPUT[toggle:tasks_query_short_mode]`
-tree: `INPUT[toggle:tasks_query_show_tree]`
-tags: `INPUT[toggle:tasks_query_show_tags]`
-id: `INPUT[toggle:tasks_query_show_id]` depends on: `INPUT[toggle:tasks_query_show_depends_on]`
-priority: `INPUT[toggle:tasks_query_show_priority]`
-recurrence rule: `INPUT[toggle:tasks_query_show_recurrence_rule]` on completion: `INPUT[toggle:tasks_query_show_on_completion]`
-start date: `INPUT[toggle:tasks_query_show_start_date]` scheduled date: `INPUT[toggle:tasks_query_show_scheduled_date]` due date: `INPUT[toggle:tasks_query_show_due_date]`
-created date: `INPUT[toggle:tasks_query_show_created_date]` cancelled date: `INPUT[toggle:tasks_query_show_cancelled_date]` done date: `INPUT[toggle:tasks_query_show_done_date]`
-urgency: `INPUT[toggle:tasks_query_show_urgency]`
-backlink: `INPUT[toggle:tasks_query_show_backlink]`
-edit button: `INPUT[toggle:tasks_query_show_edit_button]` postpone button: `INPUT[toggle:tasks_query_show_postpone_button]`
-task count: `INPUT[toggle:tasks_query_show_task_count]`
-extra instructions: `INPUT[textArea:tasks_query_extra_instructions]`
-explain: `INPUT[toggle:tasks_query_explain]`
+short mode: `INPUT[toggle:TQ_short_mode]`
+tree: `INPUT[toggle:TQ_show_tree]`
+tags: `INPUT[toggle:TQ_show_tags]`
+id: `INPUT[toggle:TQ_show_id]` depends on: `INPUT[toggle:TQ_show_depends_on]`
+priority: `INPUT[toggle:TQ_show_priority]`
+recurrence rule: `INPUT[toggle:TQ_show_recurrence_rule]` on completion: `INPUT[toggle:TQ_show_on_completion]`
+start date: `INPUT[toggle:TQ_show_start_date]` scheduled date: `INPUT[toggle:TQ_show_scheduled_date]` due date: `INPUT[toggle:TQ_show_due_date]`
+created date: `INPUT[toggle:TQ_show_created_date]` cancelled date: `INPUT[toggle:TQ_show_cancelled_date]` done date: `INPUT[toggle:TQ_show_done_date]`
+urgency: `INPUT[toggle:TQ_show_urgency]`
+backlink: `INPUT[toggle:TQ_show_backlink]`
+edit button: `INPUT[toggle:TQ_show_edit_button]` postpone button: `INPUT[toggle:TQ_show_postpone_button]`
+task count: `INPUT[toggle:TQ_show_task_count]`
+extra instructions: `INPUT[textArea:TQ_extra_instructions]`
+explain: `INPUT[toggle:TQ_explain]`
 
 <!-- placeholder to force blank line after included text --><!-- endInclude -->
 
 ## Can now have logical operators inside placeholders
 
 So we can easily control the query interactively now, via Obsidian's File Properties panel!!!
 
-The `tasks_query_` prefix was chosen to stand for `Task Query`. Interpretation of all of these except `tasks_query_sort_by` and `tasks_query_group_by` is now built in to Tasks.
+The `TQ_` prefix was chosen to stand for `Task Query`. Interpretation of all of these except `TQ_sort_by` and `TQ_group_by` is now built in to Tasks.
 
 To try this out:
 
@@ -74,8 +74,8 @@ path includes {{query.file.path}}
 
 # Instructions are listed in the order that items are displayed in Tasks search results
 
-{{const prop = 'tasks_query_sort_by';                return query.file.hasProperty(prop) &&   query.file.property(prop).map((g) => 'sort by ' + g).join('\n') || ''}}
-{{const prop = 'tasks_query_group_by';               return query.file.hasProperty(prop) &&   query.file.property(prop).map((g) => 'group by ' + g).join('\n') || ''}}
+{{const prop = 'TQ_sort_by';                return query.file.hasProperty(prop) &&   query.file.property(prop).map((g) => 'sort by ' + g).join('\n') || ''}}
+{{const prop = 'TQ_group_by';               return query.file.hasProperty(prop) &&   query.file.property(prop).map((g) => 'group by ' + g).join('\n') || ''}}
 ```
 
 ## Can now call functions inside placeholders

resources/sample_vaults/Tasks-Demo/Manual Testing/Frontmatter/Placeholder examples to capture in tests and docs.md

@@ -1,25 +1,25 @@
 ---
-tasks_query_explain: false
-tasks_query_short_mode: false
-tasks_query_show_tree: false
-tasks_query_show_tags: false
-tasks_query_show_id: false
-tasks_query_show_depends_on: false
-tasks_query_show_priority: false
-tasks_query_show_recurrence_rule: false
-tasks_query_show_on_completion: false
-tasks_query_show_created_date: false
-tasks_query_show_start_date: false
-tasks_query_show_scheduled_date: false
-tasks_query_show_due_date: false
-tasks_query_show_cancelled_date: false
-tasks_query_show_done_date: false
-tasks_query_show_urgency: false
-tasks_query_show_backlink: false
-tasks_query_show_edit_button: false
-tasks_query_show_postpone_button: false
-tasks_query_show_task_count: false
-tasks_query_extra_instructions: |-
+TQ_explain: false
+TQ_short_mode: false
+TQ_show_tree: false
+TQ_show_tags: false
+TQ_show_id: false
+TQ_show_depends_on: false
+TQ_show_priority: false
+TQ_show_recurrence_rule: false
+TQ_show_on_completion: false
+TQ_show_created_date: false
+TQ_show_start_date: false
+TQ_show_scheduled_date: false
+TQ_show_due_date: false
+TQ_show_cancelled_date: false
+TQ_show_done_date: false
+TQ_show_urgency: false
+TQ_show_backlink: false
+TQ_show_edit_button: false
+TQ_show_postpone_button: false
+TQ_show_task_count: false
+TQ_extra_instructions: |-
   # press shift-return to add new lines
   not done
 ---