mirror of
https://github.com/cactuzhead/Advanced-Progress-Bars.git
synced 2026-07-22 12:20:30 +00:00
Add files via upload
This commit is contained in:
cactuzhead
GitHub
parent
c4f9dc5862
commit
18ba688309
12 changed files with 81 additions and 81 deletions
|
|
@ -3,7 +3,7 @@ title: Box Shadow
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 9
|
||||
nav_order: 90
|
||||
---
|
||||
|
||||
# Box-Shadow <span class="label label-green badge">NEW v1.1.0</span>
|
||||
|
|
@ -34,4 +34,4 @@ When this is toggled `on` you invert the box-shadow so that it runs from the bor
|
|||
|
||||
|
||||
## Box-Shadow Color
|
||||
Select your desired custom color for the box-shadow with the colorpicker or use one of the `Light` or `Dark` defaults.
|
||||
Select your desired custom color for the box-shadow with the colorpicker or use one of the `Light` or `Dark` defaults.
|
||||
|
|
@ -3,7 +3,7 @@ title: Container
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 8
|
||||
nav_order: 80
|
||||
---
|
||||
|
||||
## Container Settings
|
||||
|
|
@ -21,4 +21,4 @@ When this is toggled `on`, the progress bar will have a larger margin at the top
|
|||
If it is turned off then it behaves as before to save vertical screen space for those who don't mind the hover over </> obscuring the top right text.
|
||||
|
||||
{: .note }
|
||||
This extra spacing only happens once for each code block, so if you have multiple progress bars in one code block the spacing between progress bars will remain the same.
|
||||
This extra spacing only happens once for each code block, so if you have multiple progress bars in one code block the spacing between progress bars will remain the same.
|
||||
|
|
@ -3,7 +3,7 @@ title: Dashboard++
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 13
|
||||
nav_order: 130
|
||||
---
|
||||
|
||||
## Using in Dashboard++
|
||||
|
|
@ -36,4 +36,4 @@ In earlier versions, this workaround worked, but starting with release `1.0.8`,
|
|||
|
||||
|
||||
|
||||
Now, you can effortlessly place simple progress bars anywhere in column lists without a list bullet on the left, enhancing visual clarity.
|
||||
Now, you can effortlessly place simple progress bars anywhere in column lists without a list bullet on the left, enhancing visual clarity.
|
||||
|
|
@ -3,14 +3,14 @@ title: Light & Dark
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 3
|
||||
nav_order: 30
|
||||
---
|
||||
|
||||
# Light & Dark Settings
|
||||
## Light & Dark Settings
|
||||
|
||||
|
||||
These two buttons (`Light` & `Dark`) will change **ALL** the color settings to their respective defaults.
|
||||
All other settings will remain unchanged.
|
||||
All templates and other settings will remain unchanged.
|
||||
|
||||
{: .note }
|
||||
Once selected, all previous colors will be lost forever and can *not* be retrieved.
|
||||
Once selected, all previous colors will be lost forever and can **not** be retrieved.
|
||||
|
|
@ -3,7 +3,7 @@ title: Override Error Warning
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 7
|
||||
nav_order: 70
|
||||
---
|
||||
|
||||
## Override Error Warning
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Progress Bar Color
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 10
|
||||
nav_order: 100
|
||||
---
|
||||
|
||||
## Progress Bar Color Settings
|
||||
|
|
@ -20,4 +20,4 @@ You can see in the image above, that the completed progress bar is using the def
|
|||
This is the color for the remaining portion of the progress bar.
|
||||
In this example it is a mid blue-grey color.
|
||||
|
||||
|
||||
|
||||
|
|
@ -3,7 +3,7 @@ title: Progress Bar
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 4
|
||||
nav_order: 40
|
||||
---
|
||||
|
||||
## Progress Bar Settings
|
||||
|
|
@ -54,4 +54,4 @@ Pressing the `Reset to Default` button changes this value back to 8 pixels tall.
|
|||
If this is toggled `on`, then the progress bar (and its background) will have rounded ends.
|
||||
Toggling it `off` will change them to square ends.
|
||||
|
||||
|
||||
|
||||
|
|
@ -3,7 +3,7 @@ title: Section Marks
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 5
|
||||
nav_order: 50
|
||||
---
|
||||
|
||||
## Section Mark Settings
|
||||
|
|
@ -51,4 +51,4 @@ The color selected will automatically be set to 50% transparency, allowing the p
|
|||
|
||||
### Section Mark Width
|
||||
This is a slider to set the width of each marker from a range of 1 to 5 pixels.
|
||||
Pressing the `Reset to Default` button changes this value back to 3 pixels wide.
|
||||
Pressing the `Reset to Default` button changes this value back to 3 pixels wide.
|
||||
|
|
@ -3,7 +3,7 @@ title: Tasks
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 11
|
||||
nav_order: 110
|
||||
---
|
||||
|
||||
- TOC
|
||||
|
|
@ -165,4 +165,4 @@ As you can see in the example above, there is a `~2/4` placed directly after the
|
|||
This is simply the `Value/Total` for subtasks of your progress bars tag, and is automatically added by APB.
|
||||
|
||||
{: .note }
|
||||
For task linked progress bars - it is not recommended that you make any changes manually to the code block apart from the `Title` or `#tag` as it will be overwritten when APB refreshes the data.
|
||||
For task linked progress bars - it is not recommended that you make any changes manually to the code block apart from the `Title` or `#tag` as it will be overwritten when APB refreshes the data.
|
||||
|
|
@ -3,7 +3,7 @@ title: Templates
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 12
|
||||
nav_order: 120
|
||||
---
|
||||
|
||||
## Templates <span class="label label-green badge">NEW v1.1.0</span>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Text
|
|||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 6
|
||||
nav_order: 60
|
||||
---
|
||||
|
||||
## Text Settings
|
||||
|
|
|
|||
120
docs/usage.md
120
docs/usage.md
|
|
@ -1,60 +1,60 @@
|
|||
---
|
||||
title: Usage
|
||||
layout: default
|
||||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 2
|
||||
---
|
||||
## Usage Example Code Block
|
||||
To insert an `Advanced Progress Bar` into Obsidian, you use a fenced code block similar to the one below.
|
||||
````
|
||||
```apb
|
||||
My Title: 57/100
|
||||
```
|
||||
````
|
||||
In the `apb` code block, you define the attributes as `Title`: `Value` / `Total`.
|
||||
|
||||
|
||||
|
||||
The `percentage` will be automatically calculated based on your `Value` and `Total`.
|
||||
{: .note }
|
||||
The text within the code block example on the settings page will automatically be updated to reflect the changes you make in the other settings.
|
||||
|
||||
## 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:
|
||||
|
||||
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 code block` action.
|
||||
|
||||
|
||||
5. Click on the round plus button next to the found action, and assign the desired hotkey combination (e.g., `Ctrl + Shift + B` or any other combo that suits you).
|
||||
|
||||
|
||||
## Copy to Clipboard
|
||||
Instead of manually typing the code block, or setting up a hotkey, you can use the `Copy to Clipboard` button, found at the top of the `APB` settings page to quickly copy it for later pasting into Obsidian.
|
||||
|
||||
## Refreshing Notes After Changes
|
||||
To see the changes you've made in the settings reflected in your notes, you may need to switch back and forth between notes or alternatively, reload Obsidian to refresh the active note.
|
||||
|
||||
However, if a new progress bar is added to a note, it *will* display correctly, even if the existing progress bars on the same page haven't been refreshed yet.
|
||||
|
||||
{: .note }
|
||||
This will only be a problem directly after you make changes to the settings.
|
||||
|
||||
## Multiple Advanced Progress Bars
|
||||
You can also stack progress bars by adding additional bars within the same code block, see example below.
|
||||
````
|
||||
```apb
|
||||
My Title: 57/100
|
||||
Smaller Total: 2/7
|
||||
Very Large Total: 2034/2345
|
||||
```
|
||||
````
|
||||
The above stacked bars example would be rendered like this (using default dark colors & settings)
|
||||
|
||||
|
||||
|
||||
{: .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.
|
||||
---
|
||||
title: Usage
|
||||
layout: default
|
||||
has_toc: false
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
nav_order: 20
|
||||
---
|
||||
## Usage Example Code Block
|
||||
To insert an `Advanced Progress Bar` into Obsidian, you use a fenced code block similar to the one below.
|
||||
````
|
||||
```apb
|
||||
My Title: 57/100
|
||||
```
|
||||
````
|
||||
In the `apb` code block, you define the attributes as `Title`: `Value` / `Total`.
|
||||
|
||||
|
||||
|
||||
The `percentage` will be automatically calculated based on your `Value` and `Total`.
|
||||
{: .note }
|
||||
The text within the code block example on the settings page will automatically be updated to reflect the changes you make in the other settings.
|
||||
|
||||
## 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:
|
||||
|
||||
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 code block` action.
|
||||
|
||||
|
||||
5. Click on the round plus button next to the found action, and assign the desired hotkey combination (e.g., `Ctrl + Shift + B` or any other combo that suits you).
|
||||
|
||||
|
||||
## Copy to Clipboard
|
||||
Instead of manually typing the code block, or setting up a hotkey, you can use the `Copy to Clipboard` button, found at the top of the `APB` settings page to quickly copy it for later pasting into Obsidian.
|
||||
|
||||
## Refreshing Notes After Changes
|
||||
To see the changes you've made in the settings reflected in your notes, you may need to switch back and forth between notes or alternatively, reload Obsidian to refresh the active note.
|
||||
|
||||
However, if a new progress bar is added to a note, it *will* display correctly, even if the existing progress bars on the same page haven't been refreshed yet.
|
||||
|
||||
{: .note }
|
||||
This will only be a problem directly after you make changes to the settings.
|
||||
|
||||
## Multiple Advanced Progress Bars
|
||||
You can also stack progress bars by adding additional bars within the same code block, see example below.
|
||||
````
|
||||
```apb
|
||||
My Title: 57/100
|
||||
Smaller Total: 2/7
|
||||
Very Large Total: 2034/2345
|
||||
```
|
||||
````
|
||||
The above stacked bars example would be rendered like this (using default dark colors & settings)
|
||||
|
||||
|
||||
|
||||
{: .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.
|
||||
|
|
|
|||
Loading…
Reference in a new issue