diff --git a/assets/app.css b/assets/app.css index 4d47a357..dc20b77a 100644 --- a/assets/app.css +++ b/assets/app.css @@ -16,20 +16,22 @@ section.wy-nav-content-wrap a:hover { } /* Keyboard shortcuts */ -kbd { - background-color: #f0f0f0; +/* + The selector comes from the readthedocs theme CSS file to match specificity + and successfully overwrite their styles. +*/ +.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd, +.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd { + display: inline-block; + min-width: 20px; + background-color: #fbfbfb; color: #666; border: 1px solid #c7c6c6; - border-radius: 4px; - font-size: 60%; - cursor: default; - min-width: 26px; /* line-height + border bottom */ - line-height: 24px; + border-radius: 3px; text-align: center; - display: inline-block; - padding: 0px 5px; - margin: 0 4px; - box-shadow: 1px 2px 0 0.5px #8685857e; + padding: 1px 3px; + vertical-align: middle; + box-shadow: inset 0px -1px 0 #c4c4c4; } nav.wy-nav-top a, diff --git a/config/en.yml b/config/en.yml index fc0bb281..1cae7e16 100644 --- a/config/en.yml +++ b/config/en.yml @@ -41,12 +41,14 @@ nav: - Table Editor: core/tables.md - Print and Preview: core/print-preview.md - Exporting: core/export.md + - Writing Statistics: core/writing-statistics.md - Advanced Usage: - YAML Frontmatter: advanced/yaml-frontmatter.md - Assets Manager: advanced/assets-manager.md - Defaults Files: advanced/defaults-files.md - Custom Templates: advanced/custom-templates.md - Custom CSS: advanced/custom-css.md + - Tag Manager: advanced/tag-manager.md - Projects: advanced/projects.md - Pomodoro Timer: advanced/pomodoro.md - Zettelkasten Methods: advanced/zkn-method.md diff --git a/docs/en/advanced/tag-manager.md b/docs/en/advanced/tag-manager.md new file mode 100644 index 00000000..60e22e58 --- /dev/null +++ b/docs/en/advanced/tag-manager.md @@ -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. diff --git a/docs/en/core/user-interface.md b/docs/en/core/user-interface.md index 346996d9..0c246404 100644 --- a/docs/en/core/user-interface.md +++ b/docs/en/core/user-interface.md @@ -48,7 +48,7 @@ The file manager has three modes that you can choose in the preferences: * **Expanded**: Same as the thin mode, but both the folder and file lists will be shown at the same time. Makes most sense if you have a wide monitor. * **Combined** (default): This is a more classic mode that will show both folders and files interleaved. It shows you less file information at a glance, but is much faster to navigate. -At the top of the file manager, you can find a filter textbox that you can use to quickly search for files and folders inside your workspaces. You can search for any metadata here, including the file or folder name, the file title, or keywords you use inside your files. You can focus the textbox by pressing `Cmd/Ctrol+Shift+T`. +At the top of the file manager, you can find a filter textbox that you can use to quickly search for files and folders inside your workspaces. You can search for any metadata here, including the file or folder name, the file title, or keywords you use inside your files. You can focus the textbox by pressing Cmd/Ctrl+Shift+T. !!! tip @@ -66,13 +66,13 @@ Editor panes will automatically close once you have closed the last open documen ## Opening new Windows -You can not only split the editor area into multiple parts to view several documents at once, but you can also create additional windows. For this, simply press `Cmd/Ctrl+Shift+N`. You can open as many windows as you like, and split their editor area as finely grained as you want. +You can not only split the editor area into multiple parts to view several documents at once, but you can also create additional windows. For this, simply press Cmd/Ctrl+Shift+N. You can open as many windows as you like, and split their editor area as finely grained as you want. There are other windows, too, which are introduced in the corresponding sections: * The [**settings window**](../reference/settings.md) * The [**assets manager**](../advanced/assets-manager.md) -* The [**statistics window**](#TODO) -* The [**tag manager**](#TODO) +* The [**statistics window**](../core/writing-statistics.md) +* The [**tag manager**](../advanced/tag-manager.md) This concludes the introduction to the user interface. We recommend you follow the guides in the tutorial to learn and experience Zettlr's UI more practically. After you are done going through the tutorial, you can come back here and learn about the various functions in the "Basic Usage" section. diff --git a/docs/en/core/writing-statistics.md b/docs/en/core/writing-statistics.md new file mode 100644 index 00000000..b4c78399 --- /dev/null +++ b/docs/en/core/writing-statistics.md @@ -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 Cmd/Ctrl+S – 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). diff --git a/docs/en/guides/journal-latex-template.md b/docs/en/guides/journal-latex-template.md index 2b8a28bc..6e209187 100644 --- a/docs/en/guides/journal-latex-template.md +++ b/docs/en/guides/journal-latex-template.md @@ -83,7 +83,7 @@ zettlr: !!! note - Note that you may receive some errors while trying to export, indicating missing packages. [Read this to know how to fix them](../getting-started/installing-latex/#installing-additional-packages). + Note that you may receive some errors while trying to export, indicating missing packages. [Read this to know how to fix them](../getting-started/installing-latex.md#installing-additional-packages). Afterward, your PDF should open with the contents, but you may notice that there are tons of sample code still in there. This is what we now have to get to: diff --git a/docs/en/img/stats_window.png b/docs/en/img/stats_window.png new file mode 100644 index 00000000..b0ccf85f Binary files /dev/null and b/docs/en/img/stats_window.png differ diff --git a/docs/en/img/tag_manager.png b/docs/en/img/tag_manager.png new file mode 100644 index 00000000..ea9bd6f4 Binary files /dev/null and b/docs/en/img/tag_manager.png differ diff --git a/docs/en/index.md b/docs/en/index.md index afcd78c4..5375588b 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -1,6 +1,6 @@ # Welcome -This User Manual is the official documentation for Zettlr. Here you can find detailed descriptions for every feature and how you can tweak those to match your needs. Consult this manual any time you are stuck. You can open this manual from within the app by pressing `F1` or clicking on the menu item 'Help' → 'Open user manual' (internet connection required). +This User Manual is the official documentation for Zettlr. Here you can find detailed descriptions for every feature and how you can tweak those to match your needs. Consult this manual any time you are stuck. You can open this manual from within the app by pressing F1 or clicking on the menu item 'Help' → 'Open user manual' (internet connection required). !!! note diff --git a/docs/en/reference/settings.md b/docs/en/reference/settings.md index 03dcf78f..ae030e66 100755 --- a/docs/en/reference/settings.md +++ b/docs/en/reference/settings.md @@ -25,7 +25,7 @@ In the general tab you find options that you might want to adjust if you begin u Application language -: Sets the language the application will be displayed in. Your changes are applied after a restart. Note that not all translations are complete, so you may see English strings in some places. If you want to improve a translation, [here we explain how](../getting-started/get-involved/#translating-the-app). +: Sets the language the application will be displayed in. Your changes are applied after a restart. Note that not all translations are complete, so you may see English strings in some places. If you want to improve a translation, [here we explain how](../getting-started/get-involved.md#translating-the-app). Dark mode