-
-
Notifications
You must be signed in to change notification settings - Fork 182
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
866b08b
commit cf59186
Showing
10 changed files
with
103 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Tag Manager | ||
|
||
Zettlr features a comprehensive tagging system to add keywords to your files for a horizontal, non-hierarchical file sorting system. However, as the amount of files in your setup increases, it can become difficult to maintain overview over the tags. In addition, you may want to use some tags in a more functional way, such as `#todo` or `#needs-review`. | ||
|
||
This is why Zettlr contains a powerful tag manager that allows you to manage the tags in your setup. You can open the tag manager by going to "Zettlr" → "Manage tags…" (macOS) or "File" → "Preferences" → "Manage tags…" (Windows/Linux). | ||
|
||
![The Tag Manager Window](../img/tag_manager.png) | ||
|
||
The tag manager lists all the tags that the app has found across your files alongside a count and an [Inverse Document Frequency (IDF)](https://en.wikipedia.org/wiki/Tf%E2%80%93idf#Inverse_document_frequency) score. The IDF score is reversely proportional to the amount of files a tag occurs in and offers an informational score as to how important a tag is. The lower the number, the less important the keyword likely is for differentiating files from each other. Usually, functional tags will have a very small IDF score, while rarely used tags will have a high score. | ||
|
||
## Sorting and Filtering Tags | ||
|
||
You have various options of viewing your tags. First, you can filter the tags with the input field on top of the list. This can help you find tags you need more quickly. | ||
|
||
Then, you can sort the table based on columns. For example, by clicking on the "IDF" column label, Zettlr will toggle between listing files with the scores ascending and descending. Likewise with the "Count", "name", and "Color" columns. | ||
|
||
## Assigning Colors to Tags | ||
|
||
In the middle of the tag manager, you will find a "color" column. You can use this to denote "special" tags that will give files that contain this tag a special color in appropriate places such as the file list. | ||
|
||
For example, you might want to include a "todo" tag or a "needs review" tag. In order to do this, follow these steps: | ||
|
||
1. Assign the tag to at least one file so that it shows up in the tag manager. | ||
2. Then open the tag manager and search for the tag you want to assign a color to. | ||
3. Click "Assign color" to be able to choose a color. | ||
4. Optionally, write a short description into the corresponding field that will be shown when you move your mouse over a color indicator in, e.g., the file list | ||
|
||
To remove the color association from a tag, simply click "Remove color". | ||
|
||
When you are finished, click "Save" to close the tag manager and apply the changes. | ||
|
||
## Renaming Tags | ||
|
||
Lastly, the tag manager allows you to rename tags in bulk. For example, if you have used a given tag frequently, but decided it should be named differently, you can click "Rename tag". Insert the new tag in the text field and confirm by clicking on "Rename". | ||
|
||
Then, Zettlr will first determine how many files will be affected and give you a final confirmation window that asks you if you really want to replace the provided tag across all of the affected files. Click "Cancel" to abort the process. | ||
|
||
After clicking on "Yes", Zettlr will immediately begin replacing the tags in all affected files. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Writing Statistics | ||
|
||
Zettlr offers a set of basic writing statistics that can help you understand the way you write. There are statistics based on how much you write day to day as well as general statistics on the Workspaces and files you have open in the app. | ||
|
||
The app continuously tracks how many words and characters you type throughout the day. These statistics are relatively simple and are not intended to be precise. They merely serve as indicators for your broad writing behavior and should not be taken as anything more than that. | ||
|
||
## How Zettlr Tracks Your Writing | ||
|
||
Zettlr uses a very simple algorithm to remember how many words and characters you write throughout the day. It starts when you open a document. As the app opens a document, it calculates how many words and characters are contained therein and notes these numbers. Then, when you save a document – either using autosave or manually pressing <kbd>Cmd</kbd>/<kbd>Ctrl</kbd>+<kbd>S</kbd> – the app will calculate the new word and character counts. What it will track is the difference between these two numbers. It records only positive values, so if you deleted more words than you added, it will not subtract any values from the recorded ones. | ||
|
||
This strategy is fairly simple and straight forward, but comes with some caveats: | ||
|
||
* If you paste large amounts of text, this can inflate your statistics unnaturally | ||
* The counters are designed to be fast, not precise, so they employ very basic heuristics and may not accurately reflect especially character counts in non-latin scripts such as Arabic, Tamil, Chinese, or Japanese. | ||
* Up until November 2024, Zettlr only tracked word counts, not character counts, so there will be a difference in historic data | ||
|
||
!!! tip | ||
|
||
If you want to adapt your writing statistics manually after the fact, you can modify the file `stats.json` in the app's data directory. Note that Zettlr must be closed before you can adapt the file, otherwise the app will overwrite your changes. You can find the data directory in the [setup instructions](../getting-started/setup.md). | ||
|
||
## Viewing Writing Statistics | ||
|
||
To access the writing statistics, click the "View Stats" button in the left section of the toolbar. This will open a popover that contains several pieces of information. First a few counts: the amount of words you have written in the last 30 days, your rolling daily average over the past 30 days, and the amount of words you have written today. | ||
|
||
As an additional motivation to get writing, the popover also includes a message indicating if you haven't gotten close to your own rolling average, getting close, or if you have surpassed your average writing statistics. | ||
|
||
Lastly, the popover contains a small graph that plots the amount of words over the past 30 days to give you a visual impression of your writing performance. Next to this graph, you will find a button that when clicked will open the full statistics window. | ||
|
||
## The Stats Window | ||
|
||
The statistics window contains a lot of comprehensive data on your files and your writing process. It is also the window that includes the [graph view](../advanced/graph.md). | ||
|
||
![The Statistics Window](../img/stats_window.png) | ||
|
||
The first view of the statistics window shows the calendar. It is focused on the running year and gives you an overview over your entire year of writing. It shows you days on which you have not opened the app in gray, and then uses colors to convey the amount of words you have written. Zettlr uses light blue for days on which you have written less than your daily average, purple for days where you have surpassed the daily average, and red for days where you managed to write more than double the amount of daily average words. | ||
|
||
Using the buttons below the heading, you can navigate through all the years for which there is data. | ||
|
||
The second view in the window includes the same information, but as graphs, indicating either per month or per year how much you have written. | ||
|
||
The third view contains data on the files you have loaded into the app. It shows you a variety of summary statistics on the files, folders, and your largest and smallest files. | ||
|
||
The fourth view contains the graph view. [Refer to its dedicated section in this documentation to learn more](../advanced/graph.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters