generated from obsidianmd/obsidian-sample-plugin
-
-
Notifications
You must be signed in to change notification settings - Fork 236
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: New Reference section, about supported themes (#1577)
* test: Extract method verifyMarkdown * test: Standardise comments in approved files * test: Approval tests no longer need running twice to update output This was done by separating the calls to verify() out to separate it() blocks. I took the opportunity to improve the names of approved files too. This also removes some repetition in verify() calls. * docs,vault: Update names and content of snippets * refactor: Move minimalSupportedStatuses() to its own file * refactor: Move itsSupportedStatuses() to its own file * jsdoc: Remove out-of-date todos * refactor: Simplify imports from src/Config/Themes * vault: Remove reference to Primary theme It turns out that it supports fewer custom checkboxes than AnuPpuccin - and is currently a legacy theme. * docs: Add per-theme/snippet pages, in new Reference section * docs: Add sample tasks and screenshot to ITS Theme page * docs: Add detail to Minimal theme docs * docs: Note that I'll support more themes in future. * vault: Reset appearance to 'Default theme; no snippets' So it is easier to try out different themes and snippets. * docs: Add detail to SlRvb's Alternate Checkboxes docs * vault: Correct a filename in renamed file
- Loading branch information
1 parent
8758c34
commit 2ed910d
Showing
30 changed files
with
612 additions
and
197 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| layout: default | ||
| title: Reference | ||
| nav_order: 9 | ||
| has_children: true | ||
| --- | ||
|
|
||
| # Reference | ||
| {: .no_toc } | ||
|
|
||
| This section provides reference material - content which is typically too detailed for other parts of the documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| layout: default | ||
| title: Status Collections | ||
| nav_order: 1 | ||
| parent: Reference | ||
| has_children: true | ||
| has_toc: true | ||
| --- | ||
|
|
||
| # Status Collections | ||
| {: .no_toc } | ||
|
|
||
| <details open markdown="block"> | ||
| <summary> | ||
| Table of contents | ||
| </summary> | ||
| {: .text-delta } | ||
| 1. TOC | ||
| {:toc} | ||
| </details> | ||
|
|
||
| ## Background | ||
|
|
||
| {: .released } | ||
| Custom statuses were introduced in Tasks X.Y.Z | ||
|
|
||
| You can control the behaviour of your tasks (such as what happens when you click on a checkbox), using Tasks' [Custom Statuses]({{ site.baseurl }}{% link getting-started/statuses.md %}) feature. | ||
|
|
||
| The theme and snippet authors generally refer to this as 'custom checkboxes'. | ||
|
|
||
| Tasks only knows how to display two core statuses, `[space]` and `[x]`. | ||
|
|
||
| So before setting up custom statuses, you need to decide which CSS Snippet or Theme to adopt. This section will help with that. | ||
|
|
||
| ## Your current Theme or CSS Snippet | ||
|
|
||
| If you are already happy with a Theme or CSS Snippet that supports custom checkboxes, you can stop reading this section, and move on to configuring Tasks to use it: see [How to set up your custom statuses]({{ site.baseurl }}{% link how-to/set-up-custom-statuses.md %}). | ||
|
|
||
| ## Selecting a Theme or CSS Snippet | ||
|
|
||
| Tasks provides easy one-click set up of all the Themes and CSS Snippets in the 'Table of Contents' below. | ||
|
|
||
| ## Our recommendation: SlRvb’s Alternate Checkboxes | ||
|
|
||
| If you are unsure which to use, we recommend using a CSS Snippet rather than a Theme: | ||
|
|
||
| - Themes are very opinionated about lots of aspects of presenting your markdown. | ||
| - CSS Snippets can generally be used with a wide variety of Themes, so they keep your options a lot more open. | ||
|
|
||
| The very widely used [SlRvb’s Alternate Checkboxes]({{ site.baseurl }}{% link reference/status-collections/slrvb-alternate-checkboxes-snippet.md %}) snippet is excellent, and we recommend starting with that. | ||
|
|
||
| However, you can also browse through the pages in this section, to see the other options that Tasks is aware of. | ||
|
|
||
| ## Coming soon | ||
|
|
||
| We plan to add one-click support for these themes in a future release: | ||
|
|
||
| - [AnuPpuccin](https://publish.obsidian.md/hub/02+-+Community+Expansions/02.05+All+Community+Expansions/Themes/AnuPpuccin) | ||
| - [Aura](https://publish.obsidian.md/hub/02+-+Community+Expansions/02.05+All+Community+Expansions/Themes/Aura) | ||
| - [LYT Mode](https://publish.obsidian.md/hub/02+-+Community+Expansions/02.05+All+Community+Expansions/Themes/LYT+Mode) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| --- | ||
| layout: default | ||
| title: ITS Theme | ||
| parent: Status Collections | ||
| grand_parent: Reference | ||
| has_toc: false | ||
| --- | ||
|
|
||
| # ITS Theme | ||
| {: .no_toc } | ||
|
|
||
| <details open markdown="block"> | ||
| <summary> | ||
| Table of contents | ||
| </summary> | ||
| {: .text-delta } | ||
| 1. TOC | ||
| {:toc} | ||
| </details> | ||
|
|
||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This theme offers the same checkboxes as [SlRvb's Alternate Checkboxes]({{ site.baseurl }}{% link reference/status-collections/slrvb-alternate-checkboxes-snippet.md %}), which works in combination with other themes too, so is more flexible. | ||
|
|
||
| | Location | Link | | ||
| | ------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | GitHub: | <https://github.com/SlRvb/Obsidian--ITS-Theme> | | ||
| | Obsidian Hub: | [ITS Theme](https://publish.obsidian.md/hub/02+-+Community+Expansions/02.05+All+Community+Expansions/Themes/ITS+Theme) | | ||
| | Test note in Tasks-Demo vault: | [Theme - ITS Theme](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/resources/sample_vaults/Tasks-Demo/Styling/Theme%20-%20ITS%20Theme.md) | | ||
|
|
||
| ## Screenshot | ||
|
|
||
|  | ||
|
|
||
| ## Supported statuses | ||
|
|
||
| <!-- snippet: DocsSamplesForStatuses.test.Theme_ITS Text.approved.txt --> | ||
| ```txt | ||
| - [ ] #task `space` Unchecked | ||
| - [x] #task `x` Regular | ||
| - [X] #task `X` Checked | ||
| - [-] #task `-` Dropped | ||
| - [>] #task `>` Forward | ||
| - [D] #task `D` Date | ||
| - [?] #task `?` Question | ||
| - [/] #task `/` Half Done | ||
| - [+] #task `+` Add | ||
| - [R] #task `R` Research | ||
| - [!] #task `!` Important | ||
| - [i] #task `i` Idea | ||
| - [B] #task `B` Brainstorm | ||
| - [P] #task `P` Pro | ||
| - [C] #task `C` Con | ||
| - [Q] #task `Q` Quote | ||
| - [N] #task `N` Note | ||
| - [b] #task `b` Bookmark | ||
| - [I] #task `I` Information | ||
| - [p] #task `p` Paraphrase | ||
| - [L] #task `L` Location | ||
| - [E] #task `E` Example | ||
| - [A] #task `A` Answer | ||
| - [r] #task `r` Reward | ||
| - [c] #task `c` Choice | ||
| - [d] #task `d` Doing | ||
| - [T] #task `T` Time | ||
| - [@] #task `@` Character / Person | ||
| - [t] #task `t` Talk | ||
| - [O] #task `O` Outline / Plot | ||
| - [~] #task `~` Conflict | ||
| - [W] #task `W` World | ||
| - [f] #task `f` Clue / Find | ||
| - [F] #task `F` Foreshadow | ||
| - [H] #task `H` Favorite / Health | ||
| - [&] #task `&` Symbolism | ||
| - [s] #task `s` Secret | ||
| ``` | ||
| <!-- endSnippet --> | ||
|
|
||
| ## Tasks' one-click addition | ||
|
|
||
| Tasks' setting pane has a one-click button to add the following information, representing the custom checkboxes in this plugin. | ||
|
|
||
| <!-- placeholder to force blank line before included text --> <!-- include: DocsSamplesForStatuses.test.Theme_ITS Table.approved.md --> | ||
|
|
||
| | Status Character | Status Name<br>`status.name includes...`<br>`sort by status.name`<br>`group by status.name` | Next Status Character | Status Type<br>`status.type is...`<br>`sort by status.type`<br>`group by status.type` | Needs Custom Styling | | ||
| | ----- | ----- | ----- | ----- | ----- | | ||
| | `space` | Unchecked | `x` | `TODO` | No | | ||
| | `x` | Regular | `x` | `DONE` | No | | ||
| | `X` | Checked | `x` | `DONE` | Yes | | ||
| | `-` | Dropped | `x` | `CANCELLED` | Yes | | ||
| | `>` | Forward | `x` | `TODO` | Yes | | ||
| | `D` | Date | `x` | `TODO` | Yes | | ||
| | `?` | Question | `x` | `TODO` | Yes | | ||
| | `/` | Half Done | `x` | `IN_PROGRESS` | Yes | | ||
| | `+` | Add | `x` | `TODO` | Yes | | ||
| | `R` | Research | `x` | `TODO` | Yes | | ||
| | `!` | Important | `x` | `TODO` | Yes | | ||
| | `i` | Idea | `x` | `TODO` | Yes | | ||
| | `B` | Brainstorm | `x` | `TODO` | Yes | | ||
| | `P` | Pro | `x` | `TODO` | Yes | | ||
| | `C` | Con | `x` | `TODO` | Yes | | ||
| | `Q` | Quote | `x` | `TODO` | Yes | | ||
| | `N` | Note | `x` | `TODO` | Yes | | ||
| | `b` | Bookmark | `x` | `TODO` | Yes | | ||
| | `I` | Information | `x` | `TODO` | Yes | | ||
| | `p` | Paraphrase | `x` | `TODO` | Yes | | ||
| | `L` | Location | `x` | `TODO` | Yes | | ||
| | `E` | Example | `x` | `TODO` | Yes | | ||
| | `A` | Answer | `x` | `TODO` | Yes | | ||
| | `r` | Reward | `x` | `TODO` | Yes | | ||
| | `c` | Choice | `x` | `TODO` | Yes | | ||
| | `d` | Doing | `x` | `TODO` | Yes | | ||
| | `T` | Time | `x` | `TODO` | Yes | | ||
| | `@` | Character / Person | `x` | `TODO` | Yes | | ||
| | `t` | Talk | `x` | `TODO` | Yes | | ||
| | `O` | Outline / Plot | `x` | `TODO` | Yes | | ||
| | `~` | Conflict | `x` | `TODO` | Yes | | ||
| | `W` | World | `x` | `TODO` | Yes | | ||
| | `f` | Clue / Find | `x` | `TODO` | Yes | | ||
| | `F` | Foreshadow | `x` | `TODO` | Yes | | ||
| | `H` | Favorite / Health | `x` | `TODO` | Yes | | ||
| | `&` | Symbolism | `x` | `TODO` | Yes | | ||
| | `s` | Secret | `x` | `TODO` | Yes | | ||
|
|
||
| <!-- placeholder to force blank line after included text --> <!-- endInclude --> |
Oops, something went wrong.