diff --git a/docs/changelog.md b/docs/changelog.md index 9bd4cef..bf3781d 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -8,7 +8,17 @@ nav_order: 999 # Changelog -## Release v1.2.1 NEW +## Release v1.3.0 NEW +### New Features +- Added sort functionality so you can arrange grouped progress bars in either ascending or descending order. +- Added a hotkey to manually trigger a sort of progress bars in a group based on percentage completed. + +### Documentation +- Updated `Hotkeys` page to include manual sort hotkey. +- Updated `Grouping` page to include information on how to customise your groups to sort. + + +## Release v1.2.1 ### Bug Fixes - Inline edit gear settings icon is now hidden when a wikilink is used to display the progress bar on another note (it will still be viewable on the original note). - Progress bars within callouts should now work as intended. diff --git a/docs/grouping.md b/docs/grouping.md index 6a86209..cc4b95d 100644 --- a/docs/grouping.md +++ b/docs/grouping.md @@ -86,4 +86,76 @@ You can use any template you want, although I recommend creating a template spec You can be as creative as you wish with the all the templates, and can make custom templates for each progress bar within a group like the example below. -![date example](/assets/Obsidian Advanced Progress Bars - Templates Extended Date Example.png) \ No newline at end of file +![date example](/assets/Obsidian Advanced Progress Bars - Templates Extended Date Example.png) + + +## Percentage Sorting +With the introduction of version `1.3.0` you have the ability to sort any grouped progress bars, either in ascending or descending order. + +For sorting to work, you must have a title line with either `[[asc]]` or `[[desc]]` added to the end of the line. + +The minimal requirement is to have your top line have `[[group]][[asc]]` or `[[group]][[desc]]`. +You can of course also have Text for the title and a template as mentioned above. + +```` +```apb +[[group]]This is my Title{Your Template Name}[[asc]] +My Title: 57/100 +Smaller Total: 2/7 +Very Large Total: 2034/2345 +``` +```` + +All progress bars will be sorted apropriately based on percentage completed, regardless of what type of progress bar or scales they use i.e. numeric or date progress bars. + +### Manual Sort Hotkey Setup NEW v1.3.0 +To add a hotkey that automatically sorts grouped progress bars either in ascending or desdcending order. Simply follow these steps: + +1. Open Obsidian and go to the **Settings** by clicking the gear icon in the bottom left corner. +2. From the **Settings** menu, go to the **Hotkeys** section on the left sidebar. +3. In the filter search bar found at the top of the Hotkeys section, start typing **"Advanced Progress Bars"** to find the `Advanced Progress Bars: Manual Sort` action. +![Sort Hotkey Search](/assets/Obsidian Advanced Progress Bars - Manual Sort.png) + +4. Click on the round plus button next to the found action, and assign the desired hotkey combination (e.g., `Ctrl + Shift + S` or any other combo that suits you). +![Sort Hotkey](/assets/Obsidian Advanced Progress Bars - Sort Hotkey.png) + + +{: .note } +Using the sort hotkey will result in **all** progress bars within any groups with an `[[asc]]` or `[[desc]]` being sorted on the currently opened page. + +If you have two or more groups on your page, each can be sorted independantly of each other. + +For example, if you want one group of progress bars to sort in ascending order but another group in descending order, then simply group them seperately and give them the appropriate `[[asc]]` or `[[desc]]` to the end of each of their title lines. + +{: .note } +Any grouped progress bars where the `[[asc]]` or `[[desc]]` is not added to the end of the title line will not sort at all - which can be helpful if you want to always keep them in your desired order. + +In this example, you can see that the first line has a text title but with no custom template added before the `[[asc]]` + +```` +```apb +[[group]]Game Achievements[[asc]] +Online Winner x300: 157/300{rainbow4} +Use Level Editor: 2/5{rainbow5} +Crash into a Tree: 3/10{rainbow6} +Online Winner x100: 157/100{rainbow1} +Matches Played: 1234/1337{rainbow1} +Create a Party: 6/10{rainbow3} +Collect All Gifts: 111/150{rainbow2} +7 Day Streak: 2026-02-14||2026-02-21{date} +Multiplayer Wins: 30/100{rainbow8} +``` +```` + +The above example also has various progress bar lines, each with very different scales and even a date progress bar. +Each progress bar line has also been assigned a custom template. + +The normal result you would see is this:- +![Unsorted](/assets/Obsidian Advanced Progress Bars - Unsorted.png) + +Once you use the sort hotkey you will now see the following in ascending order:- +![Sorted Asc](/assets/Obsidian Advanced Progress Bars - Sorted Asc.png) + + +And if you change the `[[asc]]` to `[[desc]]` and use the sort hotkey once more, you will now see this:- +![Sorted Desc](/assets/Obsidian Advanced Progress Bars - Sorted Desc.png) \ No newline at end of file diff --git a/docs/hotkeys.md b/docs/hotkeys.md index c099c06..937cb75 100644 --- a/docs/hotkeys.md +++ b/docs/hotkeys.md @@ -36,7 +36,7 @@ If you want to manually trigger a task update without switching between notes, y ![Hotkey](/assets/Obsidian Advanced Progress Bars - Manual Refresh Hotkey.png) -## Paste Date Code Block Hotkey Setup NEW v1.2.0 +## Paste Date Code Block Hotkey Setup NEW v1.2.0 To make it more convenient, you can add a hotkey that automatically inserts a date progress bar code block into Obsidian. Simply follow these steps: 1. Open Obsidian and go to the **Settings** by clicking the gear icon in the bottom left corner. @@ -45,4 +45,16 @@ To make it more convenient, you can add a hotkey that automatically inserts a da ![Date Hotkey Search](/assets/Obsidian Advanced Progress Bars - Date Hotkey Search.png) 4. Click on the round plus button next to the found action, and assign the desired hotkey combination (e.g., `Ctrl + Shift + D` or any other combo that suits you). -![Date Hotkey](/assets/Obsidian Advanced Progress Bars - Date Hotkey.png) \ No newline at end of file +![Date Hotkey](/assets/Obsidian Advanced Progress Bars - Date Hotkey.png) + + +## Manual Sort Hotkey Setup NEW v1.3.0 +To add a hotkey that automatically sorts grouped progress bars either in ascending or desdcending order. Simply follow these steps: + +1. Open Obsidian and go to the **Settings** by clicking the gear icon in the bottom left corner. +2. From the **Settings** menu, go to the **Hotkeys** section on the left sidebar. +3. In the filter search bar found at the top of the Hotkeys section, start typing **"Advanced Progress Bars"** to find the `Advanced Progress Bars: Manual Sort` action. +![Sort Hotkey Search](/assets/Obsidian Advanced Progress Bars - Manual Sort.png) + +4. Click on the round plus button next to the found action, and assign the desired hotkey combination (e.g., `Ctrl + Shift + S` or any other combo that suits you). +![Sort Hotkey](/assets/Obsidian Advanced Progress Bars - Sort Hotkey.png) \ No newline at end of file