fix: Update code & docs for new ITS Theme docs & status

[Happypig375]

This link is the one given in the original link

Types of changes

Changes visible to users:

• New feature (prefix: feat - non-breaking change which adds functionality)
  • Issue/discussion:
  • WARNING: If the link is absent, the PR may be closed without review, due to the workload that such reviews usually require.
• Breaking change (prefix: feat!! or fix!! - fix or feature that would cause existing functionality to not work as expected)
  • Issue/discussion:
• Bug fix (prefix: fix - non-breaking change which fixes an issue)
  • Issue/discussion: Alternate Checkbox section links to out of date page  #2188
• Translation (prefix: i18n - additions or improvements to the translations - see Support a new language)
• Documentation (prefix: docs - improvements to any documentation content for users)
• Sample vault (prefix: vault - improvements to the Tasks-Demo sample vault)
• Contributing Guidelines (prefix: contrib - any improvements to documentation content for contributors - see Contributing to Tasks)

Internal changes:

• Refactor (prefix: refactor - non-breaking change which only improves the design or structure of existing code, and making no changes to its external behaviour)
• Tests (prefix: test - additions and improvements to unit tests and the smoke tests)
• Infrastructure (prefix: chore - examples include GitHub Actions, issue templates)

Description

Update to new link given by the original link

Many assorted updates as a result of the new status added in the latest version of the ITS theme and custom checkboxes code.

Motivation and Context

This fixes #2188.

Also, since ITS Theme and Snippets have added a new custom status symbol, < - called Migrated, this is now added to the ITS Theme & SIRvb Checkboxes: Add 37 [now 38] supported Statuses button in the Tasks settings.

How has this been tested?

Screenshots (if appropriate)

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

[claremacrae]

Hi, thank you very much for the update.

Can you please check whether any of the links below would also need updating?

For example:

• Have the available statuses changed?
• Do any of the screenshots need updating?

Here are the links I'm referring to:

• https://publish.obsidian.md/tasks/Reference/Status+Collections/ITS+Theme
• https://publish.obsidian.md/tasks/Reference/Status+Collections/SlRvb's+Alternate+Checkboxes
• https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/resources/sample_vaults/Tasks-Demo/Styling/Theme%20-%20ITS%20Theme.md
• https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/resources/sample_vaults/Tasks-Demo/Styling/Snippet%20-%20SlRvb's%20Alternate%20Checkboxes.md

[Happypig375]

@claremacrae I ran a Find and Replace on Alternate-Checkboxes.md and updated all the matched links.

Ah, have to update the pics too...

[Happypig375]

Ok, there is a new < symbol for "Migrated".

[Happypig375]

The screenshot is now updated:

[Happypig375]

Hmm, seems that the ITS theme also needs an update

[Happypig375]

I think it's done.

[claremacrae]

Many thanks for working on this.

I’m not in front of a computer to be able to do a full review, so this is an initial comment from what I can see in my phone.

Cheers.

[claremacrae]

I have noticed that some of the documentation changes are editing machine-generated content that is embedded in to the docs pages - so the next time the following GitHub Action runs, it will revert some of the edits made in this PR:

• https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/.github/workflows/update-docs-markdown.yml

The relevant processes are described here:

https://publish.obsidian.md/tasks-contributing/Code/How+do+I+add+one-click+support+for+new+themes+or+snippets+for+custom+statuses

I think the only file that needs to be updated is the following, as I think both the changed Snippet and Theme use the same list of supported custom statuses:

https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Config/Themes/ITSThemeCollection.ts

I would have said that I would be happy to make the change on the PR before merging, but I see that the PR is created from main - so I would have to do it as a separate edit after merging the PR - which is fine....

[Happypig375]

So I just add the new status the that ts file, right?

[claremacrae]

So I just add the new status the that ts file, right?

Yes, and then run the tests to update the files that the tests generate.

[claremacrae]

I do have quite a lot of automated steps generated from the code.

If you haven’t used Approval Tests before, there is a page about them on the Contributing guide.

The tests will fail saying that some outputs don’t match the “approved” files, that is, the previous output.

I’m happy to pick this up when I’m in front of a computer in a few days.

Do you mind if I push to your main branch?

[Happypig375]

Sure, but the source branch from my end is patch-1 and not main?

[claremacrae]

Sure, but the source branch from my end is patch-1 and not main?

Oh sorry, there are two PRs going on, and I must having been looking at the other one between looking at this one.

So yes, I can fix the tests and push to your branch, no problem.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[claremacrae]

Super - thanks very much!