diff --git a/contributing/Documentation/Redirects - Testing old links still work.md b/contributing/Documentation/Redirects - Testing old links still work.md index 8c303beac9..f8fcdceed4 100644 --- a/contributing/Documentation/Redirects - Testing old links still work.md +++ b/contributing/Documentation/Redirects - Testing old links still work.md @@ -16,12 +16,14 @@ All these links should still work: - - - +- - - - - - - +- ## Moved files in the contributing vault diff --git a/docs/Installation.md b/docs/Getting Started/Installation.md similarity index 97% rename from docs/Installation.md rename to docs/Getting Started/Installation.md index 7c42f9e211..c5826f2550 100644 --- a/docs/Installation.md +++ b/docs/Getting Started/Installation.md @@ -2,6 +2,7 @@ publish: true aliases: - Installation/Installation + - Installation --- # Installation diff --git a/docs/Introduction.md b/docs/Introduction.md index 74d65a85a2..70f1f6242f 100644 --- a/docs/Introduction.md +++ b/docs/Introduction.md @@ -4,128 +4,6 @@ publish: true # Introduction -## What's New? - - - -> [!Warning] Warning: Obsidian bug in versions 1.6.0 to 1.6.3 has caused some tasks not to be found -> See [[Missing tasks in callouts with some Obsidian 1.6.x versions]] for how to ==make Obsidian 1.6.5 fix its metadata cache==, in case it was broken by earlier 1.6.x versions. - - - -_In recent [releases](https://github.com/obsidian-tasks-group/obsidian-tasks/releases)..._ - - - -- 7.6.0: - - New setting to [[Use Filename as Default Date#Additional date format|recognise extra date format]] in file name as default date. - - Add page [[Request a Feature]]. -- 7.5.0: - - Add page [[Missing tasks in callouts with some Obsidian 1.6.x versions]]. - - [[Auto-Suggest#How do I see fewer or more suggestions?|Auto-suggest]] now defaults to at most 20 suggestions in new vaults. This is useful when adding dependencies. -- 7.4.0: - - [[Auto-Suggest#Details|Auto-suggest]] now supports [[Task Dependencies#Option 2 Use the Auto-Suggest feature|task dependencies]]. - -> [!Released]- Earlier Releases -> -> - 7.3.0: -> - Add 'Remove date' option to the [[Postponing|postpone]] right-click menu in search results. -> - 7.2.0: -> - Much improved layout of the [[Create or edit Task]] modal, on mobile devices. -> - Add [[Tasks Api#`executeToggleTaskDoneCommand (line string, path string) => string;`|executeToggleTaskDoneCommand()]] to the Tasks API. -> - Add [[Tasks Api#Auto-Suggest Integration|Auto-Suggest Integration]], to enable other plugins to use Tasks' [[Auto-Suggest]] facility. -> - 7.1.0: -> - Much improved layout of the [[Create or edit Task]] modal, on desktop machines. -> - Add access keys for Created, Done and Cancelled dates in [[Create or edit Task]]. -> - 7.0.0: -> - Major improvements to [[Combining Filters]] with Boolean combinations. See [[Combining Filters#Appendix Changes to Boolean filters in Tasks 7.0.0|the appendix]] for details. -> - Add documentation page [[Resources]], with links to write-ups, talks and sample vaults from users. -> - 6.1.0: -> - Add support for [[task dependencies]]: -> - First, [[Create or edit Task#Dependencies|use 'Create or edit Task']] to define the order in which you want to work on a set of tasks, using two new task emojis: 🆔 and ⛔. -> - Then adjust your searches, perhaps to see tasks that are [[Filters#Blocking Tasks|blocking others]], or hide ones that are [[Filters#Blocked Tasks|blocked]] and cannot yet be done. -> - `query.allTasks` is now available in custom searches: see [[Query Properties#Values for Query Search Properties|query search properties]]. -> - The [[Create or edit Task]] modal now fully supports editing of statuses, updating done and cancelled dates, and creating new recurrences. See the [[Create or edit Task#Status|section on editing statuses]] for details and tips. -> - Add HTML samples in [[Styling#Sample HTML Full mode|full]] and [[Styling#Sample HTML Short mode|short]] modes to demonstrate custom styling. -> - 6.0.0: -> - Add [[Custom Sorting|custom sorting]]. -> - Document the [[Sorting#Default sort order|default sort order]]. -> - **Warning**: This release contains some **bug-fixes** to **sorting** and to treatment of **invalid dates**. -> - The changes are detailed in [[breaking changes#Tasks 6.0.0 (19 January 2024)|breaking changes]], even though they are all improvements to the previous behaviour. -> - You may need to update any CSS snippets for the Edit or Postpone buttons: see [[How to style buttons]]. -> - 5.6.0: -> - The [[Postponing|postpone]] menu now offers `today` and `tomorrow`. -> - 5.5.0: -> - The [[Create or edit Task]] modal can now edit Created, Done and Cancelled dates -> - Add support for [[Dates#Cancelled date|cancelled dates]]. -> - 5.4.0: -> - Add [[Layout#Full Mode|'full mode']] to turn off `short mode`. -> - Add any [[Grouping|'group by']] and [[Sorting|'sort by']] instructions to [[Explaining Queries|explain]] output. -> - Recurrence now works well [[Recurring Tasks and Custom Statuses#When DONE is not followed by TODO or IN_PROGRESS|when DONE is not followed by TODO or IN_PROGRESS]]. -> - 5.3.0: -> - Add [[Postponing|postpone button]] to Tasks query results. -> - Add [[Toggling and Editing Statuses#'Change task status' context menu|'change task status' menu]] to Reading mode and Tasks query results. -> - Add documentation section about [[About Editing|editing tasks]]. -> - Add documentation page about [[toggling and editing statuses]]. -> - 5.2.0: -> - Most query instructions can now include [[About Queries#Capitals in Query Instructions - Case Insensitivity|capital letters]]. -> - 5.1.0: -> - Add 'Review and check your Statuses' facility: see [[Check your Statuses|check your statuses]]. -> - Enable [[Custom Filters|custom filters]] and [[Custom Grouping|custom grouping]] to use [[Query Properties|query properties]] directly - no placeholders required. -> - 5.0.0: -> - Add [[Line Continuations|line continuations]]. -> - **Warning**: This is a [[Line Continuations#Appendix Updating pre-5.0.0 searches with trailing backslashes|potentially breaking change]] if you search for backslash (`\`) characters. -> - Document [[Comments#Inline comments|inline comments]] -> - Document [[Recurring Tasks and Custom Statuses|recurring tasks and custom statuses]] -> - Add new Help pages [[Known Limitations]] and [[Breaking Changes]]. -> - 4.9.0: -> - Add [[Task Properties|task properties]] `task.priorityNameGroupText` and `task.status.typeGroupText`, for example: -> - `group by function task.priorityNameGroupText + ': ' + task.status.typeGroupText` -> - Add [[Task Properties#Values in TasksDate Properties|task date properties]] for categorising dates, for example: -> - `group by function task.due.category.groupText` -> - Add [[Task Properties#Values in TasksDate Properties|task date properties]] for grouping dates by [time from now](https://momentjs.com/docs/#/displaying/fromnow/), for example: -> - `group by function task.due.fromNow.groupText` -> - 4.8.0: -> - Add [[Query Properties#Values for Query File Properties|query file properties]] `query.file.pathWithoutExtension` and `query.file.filenameWithoutExtension` -> - Add [[Task Properties#Values for File Properties|task file properties]] `task.file.pathWithoutExtension` and `task.file.filenameWithoutExtension` -> - 4.7.0: -> - Use [[Query Properties]] and [[Placeholders]] to filter and group with the query's file path, root, folder and name. -> - 4.6.0: -> - Add `on or before` and `on or after` to [[Filters#Date search options|date search options]] -> - Add `in or before` and `in or after` to [[Filters#Date range options|date range search options]] -> - 4.5.0: -> - Support task in list items starting with [[Getting Started#Finding tasks in your vault|`+` signs]] -> - 4.4.0: -> - Support [[Expressions#More complex expressions|variables, if statements, and functions]] in custom filters and groups -> - 4.3.0: -> - Bug fixes, usability improvements and `explain` support for [[Regular Expressions|regular expression]] searches -> - 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 -> - 3.8.0: -> - Add [[Limiting#Limit number of tasks in each group|limiting tasks per group]] -> - Add option to control the [[Recurring Tasks#Order of the new task|order of new recurring tasks]] -> - 3.7.0: -> - Add [[Grouping#Reversing groups|reverse sorting of groups]] -> - 3.6.0: -> - Add [[Grouping#Urgency|group by urgency]] -> - Add [[Sorting#Recurrence|sort by recurring]] -> - 3.5.0: -> - New [[Global Query]] facility. -> - 3.4.0: -> - Clicking on a [[Backlinks|Backlink]] jumps to the exact task line. -> - Tasks now requires at least Obsidian 1.1.1. -> - 3.3.0: -> - Multiple [[About Task Formats|Task Format]] support - starting with [[Dataview Format]]. - ## Navigation around this site These are the main pages and sections, that connect to all the pages here: @@ -133,7 +11,6 @@ These are the main pages and sections, that connect to all the pages here: > [!Info] Navigation > ### Basics > -> - [[Installation]] > - [[About Getting Started|Getting Started ...]] > - [[About Statuses|Statuses ...]] > - [[About Editing|Editing...]] @@ -153,7 +30,7 @@ These are the main pages and sections, that connect to all the pages here: > > - [[About How Tos|How Tos ...]] > - [[About Support and Help|Support and Help ...]] -> - [[Useful Links]] +> - [[Changelog|Changelog...]] ## Task management for the Obsidian knowledge base @@ -163,16 +40,6 @@ Supports due dates, recurring tasks (repetition), done dates, sub-set of checkli You can toggle the task status in any view or query and it will update the source file. -> Please submit bugs using [[Report a Bug]]. -> -> Please submit ideas using the [Feature Request form](https://github.com/obsidian-tasks-group/obsidian-tasks/issues/new?assignees=&labels=type%3A+enhancement&template=feature-request.yaml). -> -> Please ask for help in the [Q&A Discussions section](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/categories/q-a) by clicking **New discussion**. -> -> Please share any interesting or fun uses of tasks in the [Show and Tell Discussions section](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/categories/show-and-tell) by clicking **New discussion**. - -For changes in each release, please check the [releases page](https://github.com/obsidian-tasks-group/obsidian-tasks/releases). - ## Screenshots - _All screenshots assume the global filter `#task` which is not set by default (see also "Getting Started")._ diff --git a/docs/Support and Help/About Support and Help.md b/docs/Support and Help/About Support and Help.md index 86054d2f03..3bd5bcb950 100644 --- a/docs/Support and Help/About Support and Help.md +++ b/docs/Support and Help/About Support and Help.md @@ -13,12 +13,7 @@ publish: true - [[Known Limitations]] - [[Missing tasks in callouts with some Obsidian 1.6.x versions]] - Use Obsidian 1.6.5 or newer to fix potential missed tasks in your vaults. -- [[Breaking Changes]] - - Tasks releases with version numbers ending `.0.0` indicate that an update to user vaults may be required. - [[Report a Bug]] - [[Request a Feature]] - -### Ways to use the Tasks Plugin - -- [[Resources]] +- [[Useful Links]] - Links to write-ups, talks and sample vaults from people who use this plugin. diff --git a/docs/Support and Help/Resources.md b/docs/Support and Help/Useful Links.md similarity index 54% rename from docs/Support and Help/Resources.md rename to docs/Support and Help/Useful Links.md index 0970f8aa77..73640cccc8 100644 --- a/docs/Support and Help/Resources.md +++ b/docs/Support and Help/Useful Links.md @@ -1,27 +1,46 @@ --- publish: true +aliases: + - Useful Links + - Support and Help/Resources --- -# Resources +# Useful Links + +## Tasks plugin in action If you'd like to see the Tasks plugin in action, have a look at these resources made by users. -## Videos +### Videos - 2022-09-16: [EASY Task Management in Obsidian](https://www.youtube.com/watch?v=SAfBpltPx0w) by [Danny Hatcher](https://www.youtube.com/@DannyHatcherTech) - 2023-01-28: [Massive tasks update!](https://www.youtube.com/watch?v=beCk8wXtVto&t=240s) by [Danny Hatcher](https://www.youtube.com/@DannyHatcherTech): A thorough walk-through of [[Custom Statuses]] - 2023-08-04: [Obsidian doesn't have a way to do tasks, but...](https://www.youtube.com/watch?v=c6A0u6NQccw) by [vladcampos](https://www.youtube.com/@vladcampos) -## Articles +### Articles - 2024-03-24: [My Obsidian Setup](https://dudethatserin.com/my-obsidian-setup/) by [Dude, That's Erin!](https://dudethatserin.com) -## Vaults +### Example Vaults - 2024-02-25: [My personal obsidian vault showcase](https://github.com/ashu-otaku/Personal-Wiki) by [Ashutosh Thakur](https://github.com/ashu-otaku) --- _Did we miss any? [Let us know](https://github.com/obsidian-tasks-group/obsidian-tasks/issues/2732) and we'll add them to the list._ + +## Tasks resources on GitHub + +- Tasks plugin [GitHub repository](https://github.com/obsidian-tasks-group/obsidian-tasks) +- Chat with users + - Ask for help in the [Q&A Discussions section](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/categories/q-a) by clicking **New discussion**. + - Share any interesting or fun uses of tasks in the [Show and Tell Discussions section](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions/categories/show-and-tell) by clicking **New discussion**. +- Improving the plugin: + - [Issues](https://github.com/obsidian-tasks-group/obsidian-tasks/issues) + - [Discussions](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions) + +## Notes for Tasks developers + +- [Contributing Guide](https://publish.obsidian.md/tasks-contributing/) diff --git a/docs/Useful Links.md b/docs/Useful Links.md deleted file mode 100644 index 3a6f326ee2..0000000000 --- a/docs/Useful Links.md +++ /dev/null @@ -1,21 +0,0 @@ -# Useful Links - -## More Tasks resources - -- [Contributing Guide](https://publish.obsidian.md/tasks-contributing/) -- [User Guide](https://publish.obsidian.md/tasks/) (this vault) - -## GitHub Links - -- Tasks plugin [GitHub repository](https://github.com/obsidian-tasks-group/obsidian-tasks) -- Improving the plugin: - - [Issues](https://github.com/obsidian-tasks-group/obsidian-tasks/issues) - - [Discussions](https://github.com/obsidian-tasks-group/obsidian-tasks/discussions) - - [Pull Requests](https://github.com/obsidian-tasks-group/obsidian-tasks/pulls) -- [Releases](https://github.com/obsidian-tasks-group/obsidian-tasks/releases) -- [GitHub Actions](https://github.com/obsidian-tasks-group/obsidian-tasks/actions) - -## Other links - -- Tasks On [Obsidian Plugins Directory](https://obsidian.md/plugins?search=obsidian-tasks-plugin) -- Tasks in the [Obsidian Hub](https://publish.obsidian.md/hub/02+-+Community+Expansions/02.05+All+Community+Expansions/Plugins/obsidian-tasks-plugin) diff --git a/docs/Support and Help/Breaking Changes.md b/docs/What is New?/Breaking Changes.md similarity index 98% rename from docs/Support and Help/Breaking Changes.md rename to docs/What is New?/Breaking Changes.md index 15cfdfd615..f6762d25a2 100644 --- a/docs/Support and Help/Breaking Changes.md +++ b/docs/What is New?/Breaking Changes.md @@ -1,5 +1,7 @@ --- publish: true +aliases: + - Support and Help/Breaking Changes --- # Breaking changes diff --git a/docs/What is New?/Changelog.md b/docs/What is New?/Changelog.md new file mode 100644 index 0000000000..906f30f110 --- /dev/null +++ b/docs/What is New?/Changelog.md @@ -0,0 +1,112 @@ +--- +publish: true +--- + +# Changelog + +See also [[Breaking Changes]]: Tasks releases with version numbers ending `.0.0` indicate that an update to user vaults may be required. + +_In recent [Tasks releases](https://github.com/obsidian-tasks-group/obsidian-tasks/releases)..._ + +- 7.6.0: + - New setting to [[Use Filename as Default Date#Additional date format|recognise extra date format]] in file name as default date. + - Add page [[Request a Feature]]. +- 7.5.0: + - Add page [[Missing tasks in callouts with some Obsidian 1.6.x versions]]. + - [[Auto-Suggest#How do I see fewer or more suggestions?|Auto-suggest]] now defaults to at most 20 suggestions in new vaults. This is useful when adding dependencies. +- 7.4.0: + - [[Auto-Suggest#Details|Auto-suggest]] now supports [[Task Dependencies#Option 2 Use the Auto-Suggest feature|task dependencies]]. +- 7.3.0: + - Add 'Remove date' option to the [[Postponing|postpone]] right-click menu in search results. +- 7.2.0: + - Much improved layout of the [[Create or edit Task]] modal, on mobile devices. + - Add [[Tasks Api#`executeToggleTaskDoneCommand (line string, path string) => string;`|executeToggleTaskDoneCommand()]] to the Tasks API. + - Add [[Tasks Api#Auto-Suggest Integration|Auto-Suggest Integration]], to enable other plugins to use Tasks' [[Auto-Suggest]] facility. +- 7.1.0: + - Much improved layout of the [[Create or edit Task]] modal, on desktop machines. + - Add access keys for Created, Done and Cancelled dates in [[Create or edit Task]]. +- 7.0.0: + - Major improvements to [[Combining Filters]] with Boolean combinations. See [[Combining Filters#Appendix Changes to Boolean filters in Tasks 7.0.0|the appendix]] for details. + - Add documentation page (now in [[Useful Links]]), with links to write-ups, talks and sample vaults from users. +- 6.1.0: + - Add support for [[task dependencies]]: + - First, [[Create or edit Task#Dependencies|use 'Create or edit Task']] to define the order in which you want to work on a set of tasks, using two new task emojis: 🆔 and ⛔. + - Then adjust your searches, perhaps to see tasks that are [[Filters#Blocking Tasks|blocking others]], or hide ones that are [[Filters#Blocked Tasks|blocked]] and cannot yet be done. + - `query.allTasks` is now available in custom searches: see [[Query Properties#Values for Query Search Properties|query search properties]]. + - The [[Create or edit Task]] modal now fully supports editing of statuses, updating done and cancelled dates, and creating new recurrences. See the [[Create or edit Task#Status|section on editing statuses]] for details and tips. + - Add HTML samples in [[Styling#Sample HTML Full mode|full]] and [[Styling#Sample HTML Short mode|short]] modes to demonstrate custom styling. +- 6.0.0: + - Add [[Custom Sorting|custom sorting]]. + - Document the [[Sorting#Default sort order|default sort order]]. + - **Warning**: This release contains some **bug-fixes** to **sorting** and to treatment of **invalid dates**. + - The changes are detailed in [[Breaking Changes#Tasks 6.0.0 (19 January 2024)|breaking changes]], even though they are all improvements to the previous behaviour. + - You may need to update any CSS snippets for the Edit or Postpone buttons: see [[How to style buttons]]. +- 5.6.0: + - The [[Postponing|postpone]] menu now offers `today` and `tomorrow`. +- 5.5.0: + - The [[Create or edit Task]] modal can now edit Created, Done and Cancelled dates + - Add support for [[Dates#Cancelled date|cancelled dates]]. +- 5.4.0: + - Add [[Layout#Full Mode|'full mode']] to turn off `short mode`. + - Add any [[Grouping|'group by']] and [[Sorting|'sort by']] instructions to [[Explaining Queries|explain]] output. + - Recurrence now works well [[Recurring Tasks and Custom Statuses#When DONE is not followed by TODO or IN_PROGRESS|when DONE is not followed by TODO or IN_PROGRESS]]. +- 5.3.0: + - Add [[Postponing|postpone button]] to Tasks query results. + - Add [[Toggling and Editing Statuses#'Change task status' context menu|'change task status' menu]] to Reading mode and Tasks query results. + - Add documentation section about [[About Editing|editing tasks]]. + - Add documentation page about [[toggling and editing statuses]]. +- 5.2.0: + - Most query instructions can now include [[About Queries#Capitals in Query Instructions - Case Insensitivity|capital letters]]. +- 5.1.0: + - Add 'Review and check your Statuses' facility: see [[Check your Statuses|check your statuses]]. + - Enable [[Custom Filters|custom filters]] and [[Custom Grouping|custom grouping]] to use [[Query Properties|query properties]] directly - no placeholders required. +- 5.0.0: + - Add [[Line Continuations|line continuations]]. + - **Warning**: This is a [[Line Continuations#Appendix Updating pre-5.0.0 searches with trailing backslashes|potentially breaking change]] if you search for backslash (`\`) characters. + - Document [[Comments#Inline comments|inline comments]] + - Document [[Recurring Tasks and Custom Statuses|recurring tasks and custom statuses]] + - Add new Help pages [[Known Limitations]] and [[Breaking Changes]]. +- 4.9.0: + - Add [[Task Properties|task properties]] `task.priorityNameGroupText` and `task.status.typeGroupText`, for example: + - `group by function task.priorityNameGroupText + ': ' + task.status.typeGroupText` + - Add [[Task Properties#Values in TasksDate Properties|task date properties]] for categorising dates, for example: + - `group by function task.due.category.groupText` + - Add [[Task Properties#Values in TasksDate Properties|task date properties]] for grouping dates by [time from now](https://momentjs.com/docs/#/displaying/fromnow/), for example: + - `group by function task.due.fromNow.groupText` +- 4.8.0: + - Add [[Query Properties#Values for Query File Properties|query file properties]] `query.file.pathWithoutExtension` and `query.file.filenameWithoutExtension` + - Add [[Task Properties#Values for File Properties|task file properties]] `task.file.pathWithoutExtension` and `task.file.filenameWithoutExtension` +- 4.7.0: + - Use [[Query Properties]] and [[Placeholders]] to filter and group with the query's file path, root, folder and name. +- 4.6.0: + - Add `on or before` and `on or after` to [[Filters#Date search options|date search options]] + - Add `in or before` and `in or after` to [[Filters#Date range options|date range search options]] +- 4.5.0: + - Support task in list items starting with [[Getting Started#Finding tasks in your vault|`+` signs]] +- 4.4.0: + - Support [[Expressions#More complex expressions|variables, if statements, and functions]] in custom filters and groups +- 4.3.0: + - Bug fixes, usability improvements and `explain` support for [[Regular Expressions|regular expression]] searches +- 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 +- 3.8.0: + - Add [[Limiting#Limit number of tasks in each group|limiting tasks per group]] + - Add option to control the [[Recurring Tasks#Order of the new task|order of new recurring tasks]] +- 3.7.0: + - Add [[Grouping#Reversing groups|reverse sorting of groups]] +- 3.6.0: + - Add [[Grouping#Urgency|group by urgency]] + - Add [[Sorting#Recurrence|sort by recurring]] +- 3.5.0: + - New [[Global Query]] facility. +- 3.4.0: + - Clicking on a [[Backlinks|Backlink]] jumps to the exact task line. + - Tasks now requires at least Obsidian 1.1.1. +- 3.3.0: + - Multiple [[About Task Formats|Task Format]] support - starting with [[Dataview Format]].