|
1 | 1 | ## Introduction |
2 | 2 | WorkFlow Tracker is a lite plugin that track your edits on each note and automatically record these edits statistics to your periodic note, like your daily note. |
3 | 3 |
|
4 | | - |
| 4 | + |
5 | 5 |
|
6 | | -You can customize which data to be recorded in [[#Supported regular expressions]] below. |
7 | 6 |
|
8 | | -You can also customize how the data to be recorded, like inserting a table or a list(Alpha testing) to the specified position of your note. |
9 | 7 |
|
10 | | - |
11 | 8 |
|
| 9 | +## Core Features |
| 10 | +- Tracking the number of edits, editied words per note. This will reflect on the status bar at the bottom of note. |
| 11 | +- Record the modified data automatically when the note is closed. Alternatively, use command or button to record all notes. The tracker will be set to 0 once the note is recorded. |
| 12 | +- (planned) Display changes in a svg style to show the original contents v.s. modified contents. |
| 13 | +-  |
| 14 | +- Customization of which data to be recorded, see in [[#Supported regular expressions]] below. |
| 15 | +- Customization of how the data to be recorded, like inserting a table or a list to the specified position of your note. (Currently only have one option to insert to the bottom) |
12 | 16 |
|
13 | 17 | ### How does this plugin collect data? |
14 | 18 | > All statics are fetched by diectly reading the Obsidian data, without adding additional thread to record the data, which means that enabling the recording will bring almost no performance loss or extra RAM occupation. |
15 | 19 |
|
16 | 20 | We fetch the edit statistcs by access the history field of Obsidian editor, which is the place to store the undo/redo history of Obsidian. No extra history database is created, thus don't worry about the burdens in large vault. |
17 | | - |
| 21 | +## Settings |
| 22 | + |
18 | 23 | ## Supported regular expressions |
19 | 24 | | Regular Expression | Description | |
20 | 25 | | ------------------- | ------------------- | |
|
0 commit comments