mirror of
https://github.com/cactuzhead/Advanced-Progress-Bars.git
synced 2026-07-22 05:42:10 +00:00
Add files via upload
This commit is contained in:
cactuzhead
GitHub
parent
4e0460f9a1
commit
a587b007f9
6 changed files with 346 additions and 136 deletions
|
|
@ -1,128 +1,149 @@
|
|||
---
|
||||
title: Changelog
|
||||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 999
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
## Release v1.1.4 <span class="label label-green badge">NEW</span>
|
||||
### New Features
|
||||
- Expanded the templates system to allow for additional per template container, text and bar colors.
|
||||
- Added a button to transfer all your default settings to the default template.
|
||||
- <span class="label label-red badge">REMOVED</span> many settings that are now handled by the templates :-
|
||||
- **Light & Dark setting**
|
||||
- **Progress bar color**
|
||||
- completed color
|
||||
- bar background color
|
||||
- **Progress bar container**
|
||||
- border toggle
|
||||
- border color
|
||||
- background toggle
|
||||
- background color
|
||||
- **Text**
|
||||
- show title text toggle
|
||||
- title text color
|
||||
- show percentage text toggle
|
||||
- percentage tect color
|
||||
- show fraction text toggle
|
||||
- fraction text color
|
||||
- show completed text toggle
|
||||
- completed text color
|
||||
- **Tasks**
|
||||
- sub task color
|
||||
- sub task completed color
|
||||
- <span class="label label-red badge">REMOVED</span> inline edit gear color settings as this is now automatically assigned based on your progress bar containers background color.
|
||||
|
||||
### Documentation
|
||||
- Added comprehensive info about new expanded templates functionality.
|
||||
- Removed info about settings that have been replaced by the new template functionality.
|
||||
|
||||
### Bug Fixes
|
||||
- Removed an unused rogue CSS property which was causing a white bar to briefly appear at the top of the notes when starting Obsidian.
|
||||
|
||||
## Release v1.1.3
|
||||
### New Features
|
||||
- Inline editing for swift adjustments to the value of a standard progress bar (without a tag).
|
||||
|
||||
### Bug Fixes
|
||||
- Hotkeys are now enabled immediately upon plugin activation, allowing seamless interaction without needing to render a progress bar first.
|
||||
|
||||
### Documentation
|
||||
- Added `Inline Edit` page to explain the 4 new settings.
|
||||
- Added `Hotkeys` page for quick access to hotkey setup information.
|
||||
|
||||
## Release v1.1.2
|
||||
### New Features
|
||||
- Added a new toggle in the `Progress bar container` section of the settings called `Top margin`. This will allow you to choose to set a larger margin at the top of the code block so that the </> is now above the progress bars container when you hover over it.
|
||||
- Added a new toggle in the `tasks` section of the settings called `Auto tasks`. This will allow you to turn `on` automatic task refreshing or `off` for manual refreshing. It is **highly recommended** that you have this turned `off` and use a manual refresh hotkey or page switching.
|
||||
- Added a new hotkey called `Task manual refresh` which you can use to quickly refresh all linked tasks on your current note.
|
||||
|
||||
### Documentation
|
||||
- Updated `Container` page to include `Top margin` toggle explanation.
|
||||
- Updated `Tasks` page to include `Auto tasks` toggle explanation, refreshing and hotkey information.
|
||||
|
||||
## Release v1.1.1
|
||||
### New Features
|
||||
- Added Unicode support which fixed tag tracking not working with non-English languages that use letters like é, ñ, ü, ç or indeed, any characters in Latin, Greek, Cyrillic, Hebrew, Arabic, Hindi, Japanese, Chinese, and many more including emoji.
|
||||
|
||||
### Documentation
|
||||
- Updated `Tasks` page to explain introduction of Unicode tags to support most languages.
|
||||
|
||||
## Release v1.1.0
|
||||
### New Features
|
||||
- **New Template System:** Default and custom templates support assignable colors (up to 5), gradients, and gradient types for richer visual styling.
|
||||
- **Individual Progress Bar Styling:** Assign custom templates to specific progress bars to create unique styles, independent of the default color configuration.
|
||||
|
||||
- <span class="label label-red badge">REMOVED</span> **Removed Legacy Color and Gradient Settings:** Eliminated previous settings that applied uniform colors and gradients to **all** progress bars, enabling more flexible and targeted styling.
|
||||
|
||||
- **Added Box Shadow Feature:** Introduced global support for glow or drop shadows on progress bars, with customizable options for shadow color, blur, and inset.
|
||||
|
||||
- **Codebase Refactoring:** Streamlined and optimized the code for enhanced clarity, efficiency, and maintainability.
|
||||
|
||||
### Documentation
|
||||
- **New Theme:** Changed from `Minimal` jekyll theme to the `Just-The-Docs` jekyll theme. This provides a multi-page system with side menu for easier, less cluttered documentation.
|
||||
|
||||
- **New Pages:** Added documentation pages for both of the new features - Templates and Box Shadows.
|
||||
|
||||
|
||||
## Release v1.0.8
|
||||
- Added removal of the list bullets, to the left of progress bars, within columns on a Dashboard++ page, enhancing visual clarity.
|
||||
|
||||
## Release v1.0.7
|
||||
- Added a new toggle in the Progress Bar Color section called `Gradient Type`. This setting allows you to select either a color-mixed linear gradient or a simple linear gradient for your gradients.
|
||||
- Added a new section called `Tasks` with 6 settings.
|
||||
This will allow you to track the completion of tasks (and sub tasks) and for these to be reflected automatically in your progress bar.
|
||||
This is done by using tags, please see the full documentation for a detailed explanation of what this is, what the settings do and how to add tags.
|
||||
|
||||
## Release v1.0.6
|
||||
- Added an `Override large value error toggle` with accompanying percentage text color options.
|
||||
With this set, APB will no longer show an error when the Value exceeds the Total. Instead, it will display the percentage text in a new color and now supports values exceeding 100%.
|
||||
|
||||
## Release v1.0.5
|
||||
- Nine different types of fixes for submission.
|
||||
- Refactored code to use various settings functions.
|
||||
- Added gradient settings.
|
||||
|
||||
## Release v1.0.4
|
||||
- Fixes for submission.
|
||||
- Removed old var's.
|
||||
- Removed console.log's.
|
||||
- Added async/await for nearly all saveSettings.
|
||||
|
||||
## Release v1.0.3
|
||||
- Fixes for submission.
|
||||
- Removed old var's.
|
||||
- Removed console.log's.
|
||||
- Added async/await for nearly all saveSettings.
|
||||
|
||||
## Release v1.0.2
|
||||
Updated plugin with 3 new files:
|
||||
- main.js
|
||||
- manifest.json
|
||||
- styles.css
|
||||
|
||||
## Release v1.0.1
|
||||
Update index.md
|
||||
---
|
||||
title: Changelog
|
||||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 999
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
||||
## Release v1.2.0 <span class="label label-green badge">NEW</span>
|
||||
### New Features
|
||||
- Added date funtionality so you can use a start and end date to keep track of days.
|
||||
- Added prefix and suffix to templates so that you can add custom text before and/or after the value and total.
|
||||
- Added grouping of multiple progress bars with optional title and template.
|
||||
- Added a hotkey to insert a date code block using todays date as the start and 1 week later for the end date (you can change default duration).
|
||||
- Added a copy button on every custom template to duplicate the entire template which is useful for creating similar varients.
|
||||
- <span class="label label-red badge">REMOVED</span> `Height`, `Round end caps`, `Number of marks` and `Overage color` from the standard settings as they are now primarily template based.
|
||||
- Added a border around color pickers so they can be easily seen on mobile.
|
||||
- Increased time to 3 seconds for editing template name.
|
||||
### Documentation
|
||||
- Updated `Usage` page to include information about the new Date Progress Bars.
|
||||
- Updated `Templates Extended` page to include Prefix & Suffix information.
|
||||
- Added a new `Grouping` page to include information on how to create and customise your groups.
|
||||
### Bug Fixes
|
||||
- Fixed bug where the subtask text can be visible for progress bars without a tag or without a task matching tag.
|
||||
- Fixed a bug where if you set the completed bar color to pure black (#000000) it would still be displayed instead of hidden.
|
||||
- Made sure that the template name's textbox is not shrunk down in width on mobile so you can actually see the name.
|
||||
- Fixed the template name not being case insensative as intended.
|
||||
|
||||
|
||||
## Release v1.1.4
|
||||
### New Features
|
||||
- Expanded the templates system to allow for additional per template container, text and bar colors.
|
||||
- Added a button to transfer all your default settings to the default template.
|
||||
- <span class="label label-red badge">REMOVED</span> many settings that are now handled by the templates :-
|
||||
- **Light & Dark setting**
|
||||
- **Progress bar color**
|
||||
- completed color
|
||||
- bar background color
|
||||
- **Progress bar container**
|
||||
- border toggle
|
||||
- border color
|
||||
- background toggle
|
||||
- background color
|
||||
- **Text**
|
||||
- show title text toggle
|
||||
- title text color
|
||||
- show percentage text toggle
|
||||
- percentage tect color
|
||||
- show fraction text toggle
|
||||
- fraction text color
|
||||
- show completed text toggle
|
||||
- completed text color
|
||||
- **Tasks**
|
||||
- sub task color
|
||||
- sub task completed color
|
||||
- <span class="label label-red badge">REMOVED</span> inline edit gear color settings as this is now automatically assigned based on your progress bar containers background color.
|
||||
|
||||
### Documentation
|
||||
- Added comprehensive info about new expanded templates functionality.
|
||||
- Removed info about settings that have been replaced by the new template functionality.
|
||||
|
||||
### Bug Fixes
|
||||
- Removed an unused rogue CSS property which was causing a white bar to briefly appear at the top of the notes when starting Obsidian.
|
||||
|
||||
## Release v1.1.3
|
||||
### New Features
|
||||
- Inline editing for swift adjustments to the value of a standard progress bar (without a tag).
|
||||
|
||||
### Bug Fixes
|
||||
- Hotkeys are now enabled immediately upon plugin activation, allowing seamless interaction without needing to render a progress bar first.
|
||||
|
||||
### Documentation
|
||||
- Added `Inline Edit` page to explain the 4 new settings.
|
||||
- Added `Hotkeys` page for quick access to hotkey setup information.
|
||||
|
||||
## Release v1.1.2
|
||||
### New Features
|
||||
- Added a new toggle in the `Progress bar container` section of the settings called `Top margin`. This will allow you to choose to set a larger margin at the top of the code block so that the </> is now above the progress bars container when you hover over it.
|
||||
- Added a new toggle in the `tasks` section of the settings called `Auto tasks`. This will allow you to turn `on` automatic task refreshing or `off` for manual refreshing. It is **highly recommended** that you have this turned `off` and use a manual refresh hotkey or page switching.
|
||||
- Added a new hotkey called `Task manual refresh` which you can use to quickly refresh all linked tasks on your current note.
|
||||
|
||||
### Documentation
|
||||
- Updated `Container` page to include `Top margin` toggle explanation.
|
||||
- Updated `Tasks` page to include `Auto tasks` toggle explanation, refreshing and hotkey information.
|
||||
|
||||
## Release v1.1.1
|
||||
### New Features
|
||||
- Added Unicode support which fixed tag tracking not working with non-English languages that use letters like é, ñ, ü, ç or indeed, any characters in Latin, Greek, Cyrillic, Hebrew, Arabic, Hindi, Japanese, Chinese, and many more including emoji.
|
||||
|
||||
### Documentation
|
||||
- Updated `Tasks` page to explain introduction of Unicode tags to support most languages.
|
||||
|
||||
## Release v1.1.0
|
||||
### New Features
|
||||
- **New Template System:** Default and custom templates support assignable colors (up to 5), gradients, and gradient types for richer visual styling.
|
||||
- **Individual Progress Bar Styling:** Assign custom templates to specific progress bars to create unique styles, independent of the default color configuration.
|
||||
|
||||
- <span class="label label-red badge">REMOVED</span> **Removed Legacy Color and Gradient Settings:** Eliminated previous settings that applied uniform colors and gradients to **all** progress bars, enabling more flexible and targeted styling.
|
||||
|
||||
- **Added Box Shadow Feature:** Introduced global support for glow or drop shadows on progress bars, with customizable options for shadow color, blur, and inset.
|
||||
|
||||
- **Codebase Refactoring:** Streamlined and optimized the code for enhanced clarity, efficiency, and maintainability.
|
||||
|
||||
### Documentation
|
||||
- **New Theme:** Changed from `Minimal` jekyll theme to the `Just-The-Docs` jekyll theme. This provides a multi-page system with side menu for easier, less cluttered documentation.
|
||||
|
||||
- **New Pages:** Added documentation pages for both of the new features - Templates and Box Shadows.
|
||||
|
||||
|
||||
## Release v1.0.8
|
||||
- Added removal of the list bullets, to the left of progress bars, within columns on a Dashboard++ page, enhancing visual clarity.
|
||||
|
||||
## Release v1.0.7
|
||||
- Added a new toggle in the Progress Bar Color section called `Gradient Type`. This setting allows you to select either a color-mixed linear gradient or a simple linear gradient for your gradients.
|
||||
- Added a new section called `Tasks` with 6 settings.
|
||||
This will allow you to track the completion of tasks (and sub tasks) and for these to be reflected automatically in your progress bar.
|
||||
This is done by using tags, please see the full documentation for a detailed explanation of what this is, what the settings do and how to add tags.
|
||||
|
||||
## Release v1.0.6
|
||||
- Added an `Override large value error toggle` with accompanying percentage text color options.
|
||||
With this set, APB will no longer show an error when the Value exceeds the Total. Instead, it will display the percentage text in a new color and now supports values exceeding 100%.
|
||||
|
||||
## Release v1.0.5
|
||||
- Nine different types of fixes for submission.
|
||||
- Refactored code to use various settings functions.
|
||||
- Added gradient settings.
|
||||
|
||||
## Release v1.0.4
|
||||
- Fixes for submission.
|
||||
- Removed old var's.
|
||||
- Removed console.log's.
|
||||
- Added async/await for nearly all saveSettings.
|
||||
|
||||
## Release v1.0.3
|
||||
- Fixes for submission.
|
||||
- Removed old var's.
|
||||
- Removed console.log's.
|
||||
- Added async/await for nearly all saveSettings.
|
||||
|
||||
## Release v1.0.2
|
||||
Updated plugin with 3 new files:
|
||||
- main.js
|
||||
- manifest.json
|
||||
- styles.css
|
||||
|
||||
## Release v1.0.1
|
||||
Update index.md
|
||||
88
docs/grouping.md
Normal file
88
docs/grouping.md
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
---
|
||||
title: Grouping
|
||||
layout: default
|
||||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 25
|
||||
---
|
||||
## Usage Grouping
|
||||
With the introduction of version `1.2.0` you have the ability to visually group together multiple progress bars within a container.
|
||||
|
||||
You have always had the ability to stack multiple progress bars in a single code block by simply adding additional lines see example below.
|
||||
````
|
||||
```apb
|
||||
My Title: 57/100
|
||||
Smaller Total: 2/7
|
||||
Very Large Total: 2034/2345
|
||||
```
|
||||
````
|
||||
|
||||
These would be rendered seperately, and would appear in the exact same way as three single code blocks.
|
||||
This is still the case, but you now have the option of slightly altering the code block to visually group them all inside a container.
|
||||
|
||||
You simply need to add a first line to the code block that starts with `[[group]]` as displayed in the example below.
|
||||
|
||||
````
|
||||
```apb
|
||||
[[group]]
|
||||
My Title: 57/100
|
||||
Smaller Total: 2/7
|
||||
Very Large Total: 2034/2345
|
||||
```
|
||||
````
|
||||
|
||||
{: .note }
|
||||
**All** progress bar's within the same code block will be grouped together.
|
||||
|
||||
|
||||
## Adding a Title
|
||||
Additionally you can choose to add a title for your group of progress bars which will be displayed at the top of the container, before any progress bars are rendered.
|
||||
|
||||
To do this, simply add some text after the `[[group]]` on the first line (see below).
|
||||
|
||||
````
|
||||
```apb
|
||||
[[group]]This is my Title
|
||||
My Title: 57/100
|
||||
Smaller Total: 2/7
|
||||
Very Large Total: 2034/2345
|
||||
```
|
||||
````
|
||||
|
||||
This code block will result in the output seen below (example only uses default templates for progress bars)
|
||||
|
||||
|
||||
|
||||
## Adding a Template
|
||||
Of course, you might want to change from the default themes colors for the grouping container and title.
|
||||
|
||||
You can achieve this by specifying a theme at the end of the first line in a similar fashion to adding a theme to a progress bar.
|
||||
|
||||
Just add the name of the template you have created in the settings within some curly braces (see code block below).
|
||||
|
||||
````
|
||||
```apb
|
||||
[[group]]This is my Title{Your Template Name}
|
||||
My Title: 57/100
|
||||
Smaller Total: 2/7
|
||||
Very Large Total: 2034/2345
|
||||
```
|
||||
````
|
||||
|
||||
|
||||
|
||||
When you specify a template (or use the default template if omitted), it will use these template settings:-
|
||||
|
||||
- Container border color
|
||||
- Container background color
|
||||
- Container title text color
|
||||
|
||||
Only these three colors are used from the template - all other settings are ignored.
|
||||
|
||||
{: .note }
|
||||
You can use any template you want, although I recommend creating a template specifically for this grouping purpose.
|
||||
|
||||
You can be as creative as you wish with the all the templates, and can make custom tempaltes for each progress bar within a group like the example below.
|
||||
|
||||
|
||||
|
|
@ -7,9 +7,10 @@ nav_order: 800
|
|||
---
|
||||
|
||||
## Hotkeys
|
||||
There are two hotkeys you can setup with Advance Progress Bars.
|
||||
There are three hotkeys you can setup with Advance Progress Bars.
|
||||
- Paste code block
|
||||
- Task manual refresh
|
||||
- Paste date code block <span class="label label-green badge">NEW v1.1.4</span>
|
||||
|
||||
## Paste Code Block Hotkey Setup
|
||||
To make it more convenient, you can add a hotkey that automatically inserts a progress bar code block into Obsidian. Simply follow these steps:
|
||||
|
|
@ -33,3 +34,15 @@ If you want to manually trigger a task update without switching between notes, y
|
|||
|
||||
4. Click on the round plus button next to the found action, and assign the desired hotkey combination (e.g., `Ctrl + Shift + R` or any other combo that suits you).
|
||||
|
||||
|
||||
|
||||
## Paste Date Code Block Hotkey Setup <span class="label label-green badge">NEW v1.1.4</span>
|
||||
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.
|
||||
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: Paste date code block` action.
|
||||
|
||||
|
||||
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).
|
||||
|
||||
|
|
@ -11,7 +11,7 @@ Starting in release `1.1.4`, you now have the additional ability to have per tem
|
|||
|
||||
|
||||
|
||||
This update removed a lot of the default color settings from the main settings and moved them to the default template.
|
||||
This update removed a lot of the default settings from the main settings and moved them to the templates.
|
||||
|
||||
For information about the original template system settings created before this update, please visit our `Templates` page.
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ Now, the default template and all custom templates should have a small settings
|
|||
|
||||
|
||||
|
||||
This button once clicked will expand to show you 10 additional color settings for greater versatility of your Advanced Progress Bars.
|
||||
This button once clicked will expand to show you 21 additional color settings for greater versatility of your Advanced Progress Bars.
|
||||
|
||||
The default template when expanded, will be highlighted by a green border around the new extended settings panel as well as the settings button itself.
|
||||
|
||||
|
|
@ -39,12 +39,16 @@ All custom templates will be differentiated from the default settings by using a
|
|||
The panel will stay open (visible) until you either close it or you view another templates extended panel. This was done so you don't get confused about which template the panel belongs to.
|
||||
|
||||
## Colors
|
||||
Each color setting within this extended panel has a light and dark button so that you can set it to a default light or dark color.
|
||||
Each color setting within the default extended panel has a light and dark button so that you can set it to a default light or dark color.
|
||||
|
||||
It is slightly different in the custom templates extended panel, as each color setting instead has a reset to default color and reset to pure black buttons.
|
||||
|
||||
This gives you a quick way to copy the currently set default color or to hide/not display the related item by settting to `#000000`.
|
||||
|
||||
However as always, you can use the color picker to set it to any color you desire for your default and custom templates.
|
||||
|
||||
## Transfer previous default colors
|
||||
At the bottom of the `default` extended settings panel is an additional button which will transfer all of your previous colors to the default template.
|
||||
At the bottom of the `default` extended settings panel is an additional unique button which will transfer all of your previous colors to the default template.
|
||||
|
||||
|
||||
|
||||
|
|
@ -55,4 +59,50 @@ Instead of using a toggle to turn on or off a particular setting as was previous
|
|||
|
||||
The *only* setting that you can not switch off or make transparent is the `Bar background color` as it is required to be a color for the progress bar to work correctly.
|
||||
|
||||
This is why it the only color setting that allows you to use pure black `#000000`.
|
||||
This is why it the only color setting that allows you to use pure black `#000000`.
|
||||
|
||||
## Prefix and suffix
|
||||
With release `v1.2.0` you now have `Prefix` and `Suffix` settings in the extended templates panel.
|
||||
This means you can now have a per template prefix and suffix for both the value and the total.
|
||||
|
||||
|
||||
These will be added before and/or after your progress bars `value` and `total`.
|
||||
|
||||
|
||||
Examples of a prefix could be a currency like `$`, `£` and `€` or your suffix could be something like `days`, `kg` or `miles`.
|
||||
|
||||
{: .note }
|
||||
The prefix and suffix will be directly next to the value and total numbers so in some cases you may wish to add a space after a prefix or a space before a suffix to seperate the number from them.
|
||||
|
||||
Assigning unique per template prefixes and suffixes to the value and total of your progress bar provides remarkable versatility, allowing for tailored and visually striking designs.
|
||||
|
||||
You can leave a prefix or suffix blank and they will not affect your layout, or you can even just use a space if you want to seperate items.
|
||||
|
||||
## Dates color & format
|
||||
You can set a custom color for the `Dates color` text and the `Days left` text.
|
||||
|
||||
This text is shown below your progress bar as seen in this image below.
|
||||
|
||||
|
||||
You can additionally set the date format that you wish these dates to use by using the `Enable USA date format` toggle.
|
||||
|
||||
When toggled on, your dates will be in the format `Dec 31, 2025` and when you toggle it off `31 Dec 2025` will be the format used.
|
||||
|
||||
## Number of marks
|
||||
You can manually override the number of evenly spaced marks along the progress bar with this setting, to a maximum of 19.
|
||||
This means you can have a maximum of 20 sections along your progress bar.
|
||||
|
||||
If you set the slider to `0`, your progress bar will have no marks at all.
|
||||
|
||||
And if you want the progress bar to use the default automatically calculated value that you set up in the `Section marks` part of the settings, then you can set this slider to `-1` for the defaults to work.
|
||||
|
||||
## End cap style
|
||||
You can now set the style of your end caps per template rather than a global setting.
|
||||
|
||||
When toggled on, the progress bar will have a `round end cap` and when toggled off it will have a `square end cap`.
|
||||
|
||||
## Bar height
|
||||
Each template now supports a customizable bar height, adjustable via a slider ranging from 1px to 15px, with a default value of 8px.
|
||||
|
||||
## Overage percentage text color
|
||||
This is another new per template setting which changes the color of the percentage text if it exceeds the total.
|
||||
|
|
@ -14,7 +14,7 @@ This update removed a lot of the color and gradient settings from the `Progress
|
|||
The default template will automatically be applied to all progress bars that have not been alocated a specific custom template.
|
||||
|
||||
{: .note }
|
||||
**All** progress bars will still use all the other defaults set outwith the templating feature. These include, but are not limited to marks, text and tasks.
|
||||
**All** progress bars will still use all the other defaults set outwith the templating feature. These include, but are not limited to marks, inline edit and tasks.
|
||||
|
||||
With the introduction of templates, you can now have gradients with up to 5 equally spaced color stops for greater customisation.
|
||||
|
||||
|
|
@ -29,7 +29,7 @@ To add a new template, press the `Add Template` button and a new template row wi
|
|||
Each row will consist of these following settings:-
|
||||
|
||||
### Template Name
|
||||
Assign a unique, short, and descriptive name to your template. This name will be used in the code block for each progress bar where you want the template applied.
|
||||
Every new template is automatically assigned a unique name, but we recommend customizing it to a short, descriptive, and unique name for clarity. This name will be used in the code block to apply the template to each progress bar.
|
||||
|
||||
{: .note }
|
||||
The template names are case insensative so `My Template` is the same as `mY teMpLATE`.
|
||||
|
|
@ -130,6 +130,15 @@ These 3 buttons when pressed, will fill all 5 color pickers with either the `Lig
|
|||
{: .note }
|
||||
When pressed these will overwrite any colors you have already assigned and can not be undone.
|
||||
|
||||
### Duplicate Template Button
|
||||
This button was added in `v1.2.0` and once clicked, will create a new template at the bottom of the list with all the same settings as the current custom template.
|
||||
|
||||
|
||||
By duplicating the entire template, you can quickly create similar varients.
|
||||
|
||||
{: .note }
|
||||
Every new template is automatically assigned a unique name, but we suggest customizing it to a more descriptive, unique, and meaningful name to simplify identification and usage.
|
||||
|
||||
### Movement Buttons (up & down)
|
||||
If you wish to order your templates in the list, use these two buttons to move the row up or down.
|
||||
|
||||
|
|
|
|||
|
|
@ -58,3 +58,32 @@ The above stacked bars example would be rendered like this (using default dark c
|
|||
|
||||
{: .note }
|
||||
The code block example on the settings page will only include one progress bar. You will need to manually add any additional progress bars once pasted into Obsidian.
|
||||
|
||||
|
||||
## Date Progress Bars <span class="label label-green badge">NEW 1.2.0</span>
|
||||
With release `v1.2.0` you now have the ability to automatically track the days between a start and end date.
|
||||
|
||||
|
||||
|
||||
You can manually add a date progress bar by creating a code block which matches the pattern `Title: Start_date||End_date{template}`
|
||||
|
||||
An example code block would be the following:-
|
||||
|
||||
````
|
||||
```apb
|
||||
My Title: 2025-08-28||2025-12-31{template}
|
||||
```
|
||||
````
|
||||
|
||||
Just like a normal progress bar, at the start, you have to use a title followed by a colon `:`.
|
||||
|
||||
{: .note }
|
||||
Although you need to use a title followed by a colon for any valid progress bar, you can hide this title if you wish to by changing the title's color to pure black (`#000000`) from within the template system.
|
||||
|
||||
Both dates have to be in the format `YYYY-MM-DD` and seperated by a double pipe `||`
|
||||
|
||||
And just like a normal progress bar you can optionally add a valid template name within curly braces at the end of the line.
|
||||
|
||||
You can stack progress bars of any type (normal or date) within a single code block if you wish.
|
||||
|
||||
Additional styling options are found in your templates extended settings panel by clicking the gear button next to your template name.
|
||||
Loading…
Reference in a new issue