Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pyrochlore/obsidian-tracker

A plugin tracks occurrences and numbers in your notes
https://github.com/pyrochlore/obsidian-tracker

chart daily-notes obsidian obsidian-md obsidian-plugin quantified-self tag-evaluation

Last synced: 2 days ago
JSON representation

A plugin tracks occurrences and numbers in your notes

Awesome Lists containing this project

README 

        
# Obsidian Tracker Plugin



![GitHub release](https://img.shields.io/github/v/release/pyrochlore/obsidian-tracker)






This is an [Obsidian](https://obsidian.md/) plugin that helps you collect data from notes and represent it comprehensively.



[Here](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Examples.md) is a table containing simplified examples showing what you can track.



## What's New



Version 1.15.0



- Fix: Minor spelling error in Examples.md

- Added new expression functions - First and Last

- Updated dates in examples to fix plots

- Respect thresholds in scaled months

- Update dependencies



Version 1.14.0



- Update dependencies

- Prevent overlapping external labels in pie chart

- Enable Stacked Bar Chart



Version 1.13.3



- Update dependencies

- Fix typo in FinanceTracker.md

- Fix typo in TestExpression.md

- Update main.ts - use new format for {{average}}



Version 1.13.2



- Update dependencies

- Fix typo in README.md

- Change streak counts to terminate on falsey values rather than null



Version 1.13.1



- Fix packaging script



Version 1.13.0



- Add support for inline dataview fields (including emoji support for values)

- Update dependencies



Version 1.12.0



- Add aspect ratio parameter for graphs

- Reorganize release notes in readme to be in descending order (latest release first)



Version 1.11.0



- Add support for checkboxes in new properties added in Obsidian 1.4

- Fix typos in documentation and examples



Version 1.10.9



- Replace tab characters by spaces

- Accept more unicode characters in dvField

- Allow emojis in the folder path

- Fixed bugs



Version 1.10.8



- Fixed startDate/endDate misread as a relative date



Version 1.10.7



- Allow using html image tags as emoji inputs



Version 1.10.6



- Fixed the coloring for missing data in the month view



Version 1.10.5



- Allow using a relative date value in `initMonth` in the month view



Version 1.10.4



- Allow using a regular expression as a key of the parameter `textValueMap`

- Add a parameter `shiftOnlyValueLargerThan` to determine when to do `valueShift`

- Fixed bugs reported by users

- Fixed typo in plugin settings



Version 1.10.3



- Allow using the parameter `fitPanelWidth` with the output type `month` and `pie`

- Fixed the resizing and positioning of the chart tooltip



Version 1.10.2



- Fixed plugin not rendering on some macOS machines



Version 1.10.1



- Fixed 'failed to load plugin' on iOS



Version 1.10.0



- Add annotation mode for month view ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestCalendar.md))

- Add parameters `xAxisTickInterval`, `yAxisTickInterval`, `xAxisTickLabelFormat` and `yAxisTickLabelFormat` for the line and bar chart ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestAxisIntervalAndFormat.md))

- Allow using regular expression in parameter `dateFormatPrefix` and `dateFormatSuffix` ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestDateFormats.md))

- Add parameters `file`, `specifiedFilesOnly`, `fileContainsLinkedFiles`, and `fileMultiplierAfterLink` to retrieve data from specified files ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestSpecifiedFiles.md))

- Add a parameter `textValueMap` to convert texts or emojis to specified values ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestTextValueMap.md))

- Fixed bugs

- Enhanced error messages



## !!! Breaking Changes !!!



From version 1.9.0, template variables, e.g. '{{sum}}', are deprecated. Instead, Tracker provide operators (+, -, *, /, %) and functions (dataset(), sum(), maxStreak(), ......etc) to help us do data processing. For users having code blocks from previous version, please replace '{{sum}}' by '{{sum()}}' or '{{sum(1)}}' by '{{sum(dataset(1))}}'. More information about the new expressions could be found [here](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Expressions.md).



## Usage



1. Have some targets you want to track in daily notes.

2. Add a new note for displaying the tracker.

3. Add tracker code blocks manually ([examples](https://github.com/pyrochlore/obsidian-tracker/tree/master/examples)) or using [commands](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Commands.md).

4. Switch the document view mode to 'Preview', then the code block will get rendered.



For more use cases, please download and open the [examples](https://github.com/pyrochlore/obsidian-tracker/tree/master/examples) folder in obsidian with this plugin installed and enabled.



## More Details You May Want to Know



- [Installation](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Installation.md): Install the plugin from Obsidian or install it manually

- [Concepts](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Concepts.md): Explain how this plugin works and what to setup

  - [Target Evaluation](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/TargetEvaluation.md)

  - [Input Parameters](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/InputParameters.md)

  - [Expressions](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Expressions.md)

- [Examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Examples.md)

- [Plugin Settings](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Settings.md)

- [Release Notes](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/ReleaseNotes.md)

- [Road Map](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/RoadMap.md)

- [Frequently Asked Questions](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Questions.md)



## Support



- If you like this plugin or want to support further development, you can [Buy Me a Coffee](https://www.buymeacoffee.com/pyrochlore).

- Please report bugs and request features in [GitHub Issues](https://github.com/pyrochlore/obsidian-tracker/issues)