|
1 | | -# Obsidian Tracker Plugin |
2 | | - |
3 | | - |
4 | | - |
5 | | -<img src="https://raw.githubusercontent.com/pyrochlore/obsidian-tracker/master/docs/images/screenshot_v1.9.png" width="800"> |
6 | | - |
7 | | -This is an [Obsidian](https://obsidian.md/) plugin that helps you collect data from notes and represent it comprehensively. |
8 | | - |
9 | | -[Here](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Examples.md) is a table containing simplified examples showing what you can track. |
10 | | - |
11 | | -## What's New |
12 | | - |
13 | | -Version 1.15.0 |
14 | | - |
15 | | -- Fix: Minor spelling error in Examples.md |
16 | | -- Added new expression functions - First and Last |
17 | | -- Updated dates in examples to fix plots |
18 | | -- Respect thresholds in scaled months |
19 | | -- Update dependencies |
20 | | - |
21 | | -Version 1.14.0 |
22 | | - |
23 | | -- Update dependencies |
24 | | -- Prevent overlapping external labels in pie chart |
25 | | -- Enable Stacked Bar Chart |
26 | | - |
27 | | -Version 1.13.3 |
28 | | - |
29 | | -- Update dependencies |
30 | | -- Fix typo in FinanceTracker.md |
31 | | -- Fix typo in TestExpression.md |
32 | | -- Update main.ts - use new format for {{average}} |
33 | | - |
34 | | -Version 1.13.2 |
35 | | - |
36 | | -- Update dependencies |
37 | | -- Fix typo in README.md |
38 | | -- Change streak counts to terminate on falsey values rather than null |
39 | | - |
40 | | -Version 1.13.1 |
41 | | - |
42 | | -- Fix packaging script |
43 | | - |
44 | | -Version 1.13.0 |
45 | | - |
46 | | -- Add support for inline dataview fields (including emoji support for values) |
47 | | -- Update dependencies |
48 | | - |
49 | | -Version 1.12.0 |
50 | | - |
51 | | -- Add aspect ratio parameter for graphs |
52 | | -- Reorganize release notes in readme to be in descending order (latest release first) |
53 | | - |
54 | | -Version 1.11.0 |
55 | | - |
56 | | -- Add support for checkboxes in new properties added in Obsidian 1.4 |
57 | | -- Fix typos in documentation and examples |
58 | | - |
59 | | -Version 1.10.9 |
60 | | - |
61 | | -- Replace tab characters by spaces |
62 | | -- Accept more unicode characters in dvField |
63 | | -- Allow emojis in the folder path |
64 | | -- Fixed bugs |
65 | | - |
66 | | -Version 1.10.8 |
67 | | - |
68 | | -- Fixed startDate/endDate misread as a relative date |
69 | | - |
70 | | -Version 1.10.7 |
71 | | - |
72 | | -- Allow using html image tags as emoji inputs |
73 | | - |
74 | | -Version 1.10.6 |
75 | | - |
76 | | -- Fixed the coloring for missing data in the month view |
77 | | - |
78 | | -Version 1.10.5 |
79 | | - |
80 | | -- Allow using a relative date value in `initMonth` in the month view |
81 | | - |
82 | | -Version 1.10.4 |
83 | | - |
84 | | -- Allow using a regular expression as a key of the parameter `textValueMap` |
85 | | -- Add a parameter `shiftOnlyValueLargerThan` to determine when to do `valueShift` |
86 | | -- Fixed bugs reported by users |
87 | | -- Fixed typo in plugin settings |
88 | | - |
89 | | -Version 1.10.3 |
90 | | - |
91 | | -- Allow using the parameter `fitPanelWidth` with the output type `month` and `pie` |
92 | | -- Fixed the resizing and positioning of the chart tooltip |
93 | | - |
94 | | -Version 1.10.2 |
95 | | - |
96 | | -- Fixed plugin not rendering on some macOS machines |
97 | | - |
98 | | -Version 1.10.1 |
99 | | - |
100 | | -- Fixed 'failed to load plugin' on iOS |
101 | | - |
102 | | -Version 1.10.0 |
103 | | - |
104 | | -- Add annotation mode for month view ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestCalendar.md)) |
105 | | -- 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)) |
106 | | -- Allow using regular expression in parameter `dateFormatPrefix` and `dateFormatSuffix` ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestDateFormats.md)) |
107 | | -- 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)) |
108 | | -- Add a parameter `textValueMap` to convert texts or emojis to specified values ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestTextValueMap.md)) |
109 | | -- Fixed bugs |
110 | | -- Enhanced error messages |
111 | | - |
112 | | -## !!! Breaking Changes !!! |
113 | | - |
114 | | -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). |
115 | | - |
116 | | -## Usage |
117 | | - |
118 | | -1. Have some targets you want to track in daily notes. |
119 | | -2. Add a new note for displaying the tracker. |
120 | | -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). |
121 | | -4. Switch the document view mode to 'Preview', then the code block will get rendered. |
122 | | - |
123 | | -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. |
124 | | - |
125 | | -## More Details You May Want to Know |
126 | | - |
127 | | -- [Installation](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Installation.md): Install the plugin from Obsidian or install it manually |
128 | | -- [Concepts](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Concepts.md): Explain how this plugin works and what to setup |
129 | | - - [Target Evaluation](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/TargetEvaluation.md) |
130 | | - - [Input Parameters](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/InputParameters.md) |
131 | | - - [Expressions](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Expressions.md) |
132 | | -- [Examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Examples.md) |
133 | | -- [Plugin Settings](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Settings.md) |
134 | | -- [Release Notes](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/ReleaseNotes.md) |
135 | | -- [Road Map](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/RoadMap.md) |
136 | | -- [Frequently Asked Questions](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Questions.md) |
137 | | - |
138 | | -## Support |
139 | | - |
140 | | -- If you like this plugin or want to support further development, you can [Buy Me a Coffee](https://www.buymeacoffee.com/pyrochlore). |
141 | | -- Please report bugs and request features in [GitHub Issues](https://github.com/pyrochlore/obsidian-tracker/issues) |
| 1 | +# Obsidian Tracker Plugin |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +<img src="https://raw.githubusercontent.com/pyrochlore/obsidian-tracker/master/docs/images/screenshot_v1.9.png" width="800"> |
| 6 | + |
| 7 | +This is an [Obsidian](https://obsidian.md/) plugin that helps you collect data from notes and represent it comprehensively. |
| 8 | + |
| 9 | +[Here](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Examples.md) is a table containing simplified examples showing what you can track. |
| 10 | + |
| 11 | +## What's New |
| 12 | + |
| 13 | +Version 1.15.1 |
| 14 | + |
| 15 | +- Fix: Added DatasetName as title for calendar in annotation mode |
| 16 | +- Fix: Resolve scaling issue when navigating between monthly views |
| 17 | +- Update dependencies |
| 18 | + |
| 19 | +Version 1.15.0 |
| 20 | + |
| 21 | +- Fix: Minor spelling error in Examples.md |
| 22 | +- Added new expression functions - First and Last |
| 23 | +- Updated dates in examples to fix plots |
| 24 | +- Respect thresholds in scaled months |
| 25 | +- Update dependencies |
| 26 | + |
| 27 | +Version 1.14.0 |
| 28 | + |
| 29 | +- Update dependencies |
| 30 | +- Prevent overlapping external labels in pie chart |
| 31 | +- Enable Stacked Bar Chart |
| 32 | + |
| 33 | +Version 1.13.3 |
| 34 | + |
| 35 | +- Update dependencies |
| 36 | +- Fix typo in FinanceTracker.md |
| 37 | +- Fix typo in TestExpression.md |
| 38 | +- Update main.ts - use new format for {{average}} |
| 39 | + |
| 40 | +Version 1.13.2 |
| 41 | + |
| 42 | +- Update dependencies |
| 43 | +- Fix typo in README.md |
| 44 | +- Change streak counts to terminate on falsey values rather than null |
| 45 | + |
| 46 | +Version 1.13.1 |
| 47 | + |
| 48 | +- Fix packaging script |
| 49 | + |
| 50 | +Version 1.13.0 |
| 51 | + |
| 52 | +- Add support for inline dataview fields (including emoji support for values) |
| 53 | +- Update dependencies |
| 54 | + |
| 55 | +Version 1.12.0 |
| 56 | + |
| 57 | +- Add aspect ratio parameter for graphs |
| 58 | +- Reorganize release notes in readme to be in descending order (latest release first) |
| 59 | + |
| 60 | +Version 1.11.0 |
| 61 | + |
| 62 | +- Add support for checkboxes in new properties added in Obsidian 1.4 |
| 63 | +- Fix typos in documentation and examples |
| 64 | + |
| 65 | +Version 1.10.9 |
| 66 | + |
| 67 | +- Replace tab characters by spaces |
| 68 | +- Accept more unicode characters in dvField |
| 69 | +- Allow emojis in the folder path |
| 70 | +- Fixed bugs |
| 71 | + |
| 72 | +Version 1.10.8 |
| 73 | + |
| 74 | +- Fixed startDate/endDate misread as a relative date |
| 75 | + |
| 76 | +Version 1.10.7 |
| 77 | + |
| 78 | +- Allow using html image tags as emoji inputs |
| 79 | + |
| 80 | +Version 1.10.6 |
| 81 | + |
| 82 | +- Fixed the coloring for missing data in the month view |
| 83 | + |
| 84 | +Version 1.10.5 |
| 85 | + |
| 86 | +- Allow using a relative date value in `initMonth` in the month view |
| 87 | + |
| 88 | +Version 1.10.4 |
| 89 | + |
| 90 | +- Allow using a regular expression as a key of the parameter `textValueMap` |
| 91 | +- Add a parameter `shiftOnlyValueLargerThan` to determine when to do `valueShift` |
| 92 | +- Fixed bugs reported by users |
| 93 | +- Fixed typo in plugin settings |
| 94 | + |
| 95 | +Version 1.10.3 |
| 96 | + |
| 97 | +- Allow using the parameter `fitPanelWidth` with the output type `month` and `pie` |
| 98 | +- Fixed the resizing and positioning of the chart tooltip |
| 99 | + |
| 100 | +Version 1.10.2 |
| 101 | + |
| 102 | +- Fixed plugin not rendering on some macOS machines |
| 103 | + |
| 104 | +Version 1.10.1 |
| 105 | + |
| 106 | +- Fixed 'failed to load plugin' on iOS |
| 107 | + |
| 108 | +Version 1.10.0 |
| 109 | + |
| 110 | +- Add annotation mode for month view ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestCalendar.md)) |
| 111 | +- 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)) |
| 112 | +- Allow using regular expression in parameter `dateFormatPrefix` and `dateFormatSuffix` ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestDateFormats.md)) |
| 113 | +- 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)) |
| 114 | +- Add a parameter `textValueMap` to convert texts or emojis to specified values ([examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/examples/TestTextValueMap.md)) |
| 115 | +- Fixed bugs |
| 116 | +- Enhanced error messages |
| 117 | + |
| 118 | +## !!! Breaking Changes !!! |
| 119 | + |
| 120 | +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). |
| 121 | + |
| 122 | +## Usage |
| 123 | + |
| 124 | +1. Have some targets you want to track in daily notes. |
| 125 | +2. Add a new note for displaying the tracker. |
| 126 | +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). |
| 127 | +4. Switch the document view mode to 'Preview', then the code block will get rendered. |
| 128 | + |
| 129 | +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. |
| 130 | + |
| 131 | +## More Details You May Want to Know |
| 132 | + |
| 133 | +- [Installation](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Installation.md): Install the plugin from Obsidian or install it manually |
| 134 | +- [Concepts](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Concepts.md): Explain how this plugin works and what to setup |
| 135 | + - [Target Evaluation](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/TargetEvaluation.md) |
| 136 | + - [Input Parameters](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/InputParameters.md) |
| 137 | + - [Expressions](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Expressions.md) |
| 138 | +- [Examples](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Examples.md) |
| 139 | +- [Plugin Settings](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Settings.md) |
| 140 | +- [Release Notes](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/ReleaseNotes.md) |
| 141 | +- [Road Map](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/RoadMap.md) |
| 142 | +- [Frequently Asked Questions](https://github.com/pyrochlore/obsidian-tracker/blob/master/docs/Questions.md) |
| 143 | + |
| 144 | +## Support |
| 145 | + |
| 146 | +- If you like this plugin or want to support further development, you can [Buy Me a Coffee](https://www.buymeacoffee.com/pyrochlore). |
| 147 | +- Please report bugs and request features in [GitHub Issues](https://github.com/pyrochlore/obsidian-tracker/issues) |
0 commit comments