Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mboyov/obsidian-progressbar
Tracking tasks with a progress bar with Obsidian
https://github.com/mboyov/obsidian-progressbar
dataview metaedit obsidian obsidian-md obsidian-taskbar obsidian-tasks taskbar
Last synced: 1 day ago
JSON representation
Tracking tasks with a progress bar with Obsidian
- Host: GitHub
- URL: https://github.com/mboyov/obsidian-progressbar
- Owner: mboyov
- License: mit
- Created: 2023-12-29T22:57:11.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-10T18:44:49.000Z (3 months ago)
- Last Synced: 2024-08-10T20:09:22.601Z (3 months ago)
- Topics: dataview, metaedit, obsidian, obsidian-md, obsidian-taskbar, obsidian-tasks, taskbar
- Homepage:
- Size: 935 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Obsidian ProgressBar
Tracking tasks with a progress bar with Obsidian
Table of Contents
## About
[![Product Name Screen Shot][product-screenshot]]()
I recently started using the Obsidian software. After configuring it to my preferences, I found that I was missing a visual overview of my task progress.
After some research, I found a way to integrate it, and now I would like to share this procedure.
### Built With
[![Obsidian][Obsidian.md]][Obsidian-url]
### Prerequisites
#### Plugins
* [DataView](https://blacksmithgu.github.io/obsidian-dataview/)
* [MetaEdit](https://github.com/chhoumann/MetaEdit)
### Installation
After installing both plugins, I'll let you configure them like this:
**Dataview**
***Dataview is a live index and query engine over your personal knowledge base. You can add metadata to your notes and query them with the Dataview Query Language to list, filter, sort or group your data. Dataview keeps your queries always up to date and makes data aggregation a breeze.***
![dataview_config][dataviewconfig-screenshot]
- **To reduce the refresh time, I'll let you change the value of the 'Refresh Interval' field from 2500 to 150 milliseconds.**
***If these options are not enabled, the JavaScript code we will edit later will not be able to be interpreted.***
**MetaEdit**
By [Christian B. B. Houmann aka chhoumann](https://github.com/chhoumann/MetaEdit) MetaEdit for Obsidian
Progress Properties that automatically update properties/fields
![metaedit-config][metaeditconfig-screenshot]
I'll let you add these three fields and values as shown in the screenshot.
***It's important to maintain the association between names and types, otherwise synchronization won't be possible.***
It is now time to create your note page and add this header, specifying the property names.
![header][header-screenshot]
To finish, we will now add our dataviewjs script.
![dataviewjs][dataviewjs-screenshot]
```js
let myPage = dv.current()
let total = myPage.total;
let status = ((myPage.completed / myPage.total) * 100).toFixed();
const progress = "![pb|500](https://progressbar-guibranco.vercel.app/" + status + "/?scale=" + "100" + "&width=400)";
dv.header(3, "Objectif du jour"); dv.paragraph(progress);
```
We can now add our tasks and see the progress bar update automatically in read mode
![progressbar][progressbar-screenshot]
## Usage
```shell
git clone [email protected]:mboyov/TasksProgressBar.git
```
- In the Obsidian application, open a folder as a vault.
- Select the location where you cloned the repository.
- Trust the author and enable plugins.
Et voilà !
See the [open issues](https://github.com/mboyov/TasksProgressBar/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
v__nova - [@mboyov](https://twitter.com/mboyov) - [email protected]
Project Link: [https://github.com/mboyov/TasksProgressBar](https://github.com/mboyov/TasksProgressBar)
## Acknowledgments
* [Snifer - Tracking Project in Obsidian with ProgressBar](https://github.com/Snifer/Curso-obsidian-desde-0/blob/main/TrackingProjects%20Obsidian.md)
* [Othneil Drew - Best-README-Template ](https://github.com/othneildrew/Best-README-Template)
[contributors-shield]: https://img.shields.io/github/contributors/mboyov/TasksProgressBar.svg?style=for-the-badge
[contributors-url]: https://github.com/mboyov/TasksProgressBar/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/mboyov/TasksProgressBar.svg?style=for-the-badge
[forks-url]: https://github.com/mboyov/TasksProgressBar/network/members
[stars-shield]: https://img.shields.io/github/stars/mboyov/TasksProgressBar.svg?style=for-the-badge
[stars-url]: https://github.com/mboyov/TasksProgressBar/stargazers
[issues-shield]: https://img.shields.io/github/issues/mboyov/TasksProgressBar.svg?style=for-the-badge
[issues-url]: https://github.com/mboyov/TasksProgressBar/issues
[license-shield]: https://img.shields.io/github/license/mboyov/TasksProgressBar.svg?style=for-the-badge
[license-url]: https://github.com/mboyov/TasksProgressBar/blob/main/LICENSE.txt
[product-screenshot]: images/screenshot.png
[dataviewconfig-screenshot]: images/dataview_config.png
[metaeditconfig-screenshot]: images/metaedit_config.png
[header-screenshot]: images/header.png
[dataviewjs-screenshot]: images/dataviewjs.png
[progressbar-screenshot]: images/progressbar.png
[Obsidian.md]: https://img.shields.io/badge/Obsidian-black?logo=Obsidian&logoColor=purple
[Obsidian-url]: https://obsidian.md/
[Dataview-url]: https://blacksmithgu.github.io/obsidian-dataview/
[MetaEdit-url]: https://github.com/chhoumann/MetaEdit