Types of changes

Changes visible to users:

• New feature (prefix: feat - non-breaking change which adds functionality)
  • Issue/discussion:
    • Support for using YAML front Matter Values as Variables in Queries [via placeholder values, without the need for 'filter by function'] #3154
    • Filter Tasks by Properties Frontmatter #2480
• Documentation (prefix: docs - improvements to any documentation content for users)
• Sample vault (prefix: vault - improvements to the Tasks-Demo sample vault)

Internal changes:

• Tests (prefix: test - additions and improvements to unit tests and the smoke tests)

Description

Introduce a new facility which I have named Query File Defaults.

This defines a set of properties that users can define in a query file to control the behaviour of all Tasks searches in that file:

---
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:
---

Document two ways to edit these properties:

• Obsidian's File Properties
• Meta Bind plugin widgets

Other changes:

• Add a snippet widen-property-labels.css to make longer property names readable in the Properties view

Motivation and Context

I started off by documenting how users could define these variables themselves, and use filter by function, but those user queries were going to be so complex and repetitive - to document and to use - that I opted for building-in the facility from the outset.

How has this been tested?

• Automated tests
• Exploratory testing

Screenshots (if appropriate)

Image caption: Using Obsidian's File Properties to edit "Query File Defaults"

Image caption: Using the Meta Bind plugin's widgets to edit "Query File Defaults"

Checklist

• My code follows the code style of this project and passes yarn run lint.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• My change has adequate Unit Test coverage.

Terms

• My contribution follows this project's contributing guide
• I agree to follow this project's Code of Conduct