From afc4f7fe6d57e4e7b7c8a9da73380c9e67720c02 Mon Sep 17 00:00:00 2001 From: Eren Inan Canpolat Date: Thu, 9 Jul 2020 20:20:06 +0200 Subject: [PATCH] Proofread 'Core' section --- docs/en/core/autocorrect.md | 4 ++-- docs/en/core/custom-css.md | 6 +++--- docs/en/core/editor.md | 20 ++++++++++---------- docs/en/core/export.md | 4 ++-- docs/en/core/file-list.md | 10 +++++----- docs/en/core/localisation.md | 2 +- docs/en/core/search.md | 20 ++++++++++---------- docs/en/core/tables.md | 10 +++++----- docs/en/core/tabs.md | 3 ++- docs/en/core/yaml-frontmatter.md | 8 ++++---- 10 files changed, 44 insertions(+), 43 deletions(-) diff --git a/docs/en/core/autocorrect.md b/docs/en/core/autocorrect.md index 632c2c52..7c17b797 100644 --- a/docs/en/core/autocorrect.md +++ b/docs/en/core/autocorrect.md @@ -8,12 +8,12 @@ AutoCorrect works by constantly checking what you type and, as soon as it encoun Zettlr comes with a predefined set of replacements for AutoCorrect that covers the most common replacements, such as replacing two dashes (--) with an en-dash (–). You can add, modify, and remove replacements in the preferences. The left column contains characters the application will search for, whereas the right column contains the respective replacements. -AutoCorrect comes in two flavors: You can either choose the "Word" mode, or the "LibreOffice" mode – depending on whether you are more accustomed to Microsoft Word or LibreOffice. The two modes differ in how they are triggered. The Word-mode is generally more aggressive and will immediately attempt to replace every sequence of characters it encounters. The LibreOffice mode requires you to press either Space or Enter before it attempts to replace something. You can always undo a replacement by pressing the Backspace key. +AutoCorrect comes in two flavors: You can either choose the "Word" mode, or the "LibreOffice" mode – depending on whether you are more accustomed to Microsoft Word or LibreOffice. The two modes differ in how they are triggered. The Word mode is generally more aggressive and will immediately attempt to replace every sequence of characters it encounters. The LibreOffice mode requires you to press either Space or Enter before it attempts to replace something. You can always undo a replacement by pressing the Backspace key. > We recommend the LibreOffice mode, as it allows you to selectively prevent a replacement by pressing `Shift+Space` instead of just `Space` and `Shift+Enter` instead of just `Enter`. ## MagicQuotes -MagicQuotes is an extension that helps you write typographically correct quotation marks, instead of the default (" and '). You can either choose them from a dropdown list, or select a pre-defined set for a few languages by pressing the corresponding button in the preferences. Selecting the first option (or the "None"-option button) restores the default quotation marks. +MagicQuotes is an extension that helps you write typographically correct quotation marks, instead of the default (" and '). You can either choose them from a dropdown list, or select a pre-defined set for a few languages by pressing the corresponding button in the preferences. Selecting the first option (or the "None" option button) restores the default quotation marks. > MagicQuotes is automatically active as long as AutoCorrect is active. If you choose to deactivate AutoCorrect, this also deactivates MagicQuotes. To selectively disable MagicQuotes while keeping the AutoCorrect functionality, set the MagicQuotes to the default quotation marks. diff --git a/docs/en/core/custom-css.md b/docs/en/core/custom-css.md index f9f4f463..c5a5d176 100755 --- a/docs/en/core/custom-css.md +++ b/docs/en/core/custom-css.md @@ -8,7 +8,7 @@ If you are unfamiliar with CSS, but don't want to simply copy & paste the guides ## Writing CSS for Zettlr -The styles of Zettlr are divided into both geometry and the actual theme, so you may want to stick with only changing the design of elements _without_ changing **any** geometry. Playing around with the geometry may be fun, but it may yield completely random behaviour, as some parts of the app depend upon the correct sizes of elements. In case you made a mistake, don't worry: Simply remove the `custom.css`-file from the data directory of Zettlr. You can find the data directory of your own system by looking at the paths provided in [the setup guide](../install.md). +The styles of Zettlr are divided into both geometry and the actual theme, so you may want to stick with only changing the design of elements _without_ changing **any** geometry. Playing around with the geometry may be fun, but it may yield completely random behaviour, as some parts of the app depend upon the correct sizes of elements. In case you made a mistake, don't worry: Simply remove the `custom.css` file from the data directory of Zettlr. You can find the data directory of your own system by looking at the paths provided in [the setup guide](../install.md). Classes and IDs in Zettlr are always namespaced to the respective components (unless they're global), so to really override a rule you will have to use the complete namespace (you can also use the `!important` override rule, but this is widely regarded as bad practice). @@ -18,7 +18,7 @@ Everything is always namespaced to the `body`, which has a class `.dark` if the Zettlr's styles are subject to constant changes. While they should remain fairly stable, changes can be introduced in any version, and therefore, instead of providing you with ready-made examples, this page covers how you can find the correct selectors easily. -First of all, make sure to enable the debug mode in the advanced [preferences](../reference/settings.md) in order to enable the Develop-menu. Next, open the developer tools from within this menu and make sure to select the "Element" tab. +First of all, make sure to enable the debug mode in the advanced [preferences](../reference/settings.md) in order to enable the Develop menu. Next, open the developer tools from within this menu and make sure to select the "Elements" tab. ![Zettlr with the developer tools open](../img/zettlr_developer_tools.png) @@ -46,7 +46,7 @@ In case you do not like the default font delivered with Zettlr, or need to chang - In case your font is **sans serif**, such as Arial or Helvetica, please use `sans-serif` - In case you want to switch to the classic **monospace**, please use the placeholder `monospace` -The placeholder will make sure that even if your font cannot be found, an equivalent font will be used. It serves as a fallback. Also, if your font name contains spaces, make sure to surround it with quotation marks, e.g. `"Times New Roman"`. +The placeholder will make sure that even if your font cannot be found, an equivalent font will be used. It serves as a fallback. Also, if your font name contains spaces, make sure to surround it with quotation marks, e.g., `"Times New Roman"`. ```css body #editor .CodeMirror { diff --git a/docs/en/core/editor.md b/docs/en/core/editor.md index 730f6d59..5fe57f87 100755 --- a/docs/en/core/editor.md +++ b/docs/en/core/editor.md @@ -6,14 +6,14 @@ In this document, you will learn about writing Markdown, available commands, som ## Writing Markdown -The idea behind Zettlr is to remove unnecessary markup and styling from your writing process. During the writing process, what matters is the _content_ you produce, not the form in which it is presented. Therefore Zettlr lets you write `Markdown`-files. Markdown is a very simple markup language that only contains a small amount of formatting symbols that you may already know. In recent years, more and more apps have discovered the power of Markdown, and even WhatsApp uses it to enable simple formatting of messages. +The idea behind Zettlr is to remove unnecessary markup and styling from your writing process. During the writing process, what matters is the _content_ you produce, not the form in which it is presented. Therefore Zettlr lets you write `Markdown` files. Markdown is a very simple markup language that only contains a small amount of formatting symbols that you may already know. In recent years, more and more apps have discovered the power of Markdown, and even WhatsApp uses it to enable simple formatting of messages. -A Markdown-Document only consists of pure text and comes with a lot of benefits: +A Markdown document only consists of pure text and comes with a lot of benefits: -* Markdown is **platform independent**. Any Markdown file written on macOS can—without any conversion—be edited on Windows and Linux alike. All you need is a text editor. And with "Notepad" (Windows), "TextEdit" (macOS) or "GEdit" (Ubuntu) every operating system already has one built-in. +* Markdown is **platform independent**. Any Markdown file written on macOS can —without any conversion— be edited on Windows and Linux alike. All you need is a text editor. And with "Notepad" (Windows), "TextEdit" (macOS) or "GEdit" (Ubuntu) every operating system already has one built-in. * Markdown's syntax is designed in such a way that **even without any syntax highlighting, you get the idea of a Markdown document**. Even without styling, it is easy to spot all headings, because they have leading hash signs (#), lists are indicated with bullets or numbers and emphasised text is encapsulated in underscores or asterisks. -* Markdown is an **open source standard**, meaning everybody can implement it into software (just as we did!) and begin building upon it. This also means that you can **expect most apps to understand it**. -* As Markdown is so simple and does not add any formatting by itself, any app can introduce a different way of previewing. **There are tons of Markdown apps that use different approaches to writing**. If Zettlr doesn't fit you, you can always choose from a plethora of different free, open source apps. +* Markdown has an **open informal specification**, meaning everybody can implement it into software (just as we did!) and begin building upon it. As it stands today, you can **expect most apps to understand it**. +* As Markdown is so simple and does not add any formatting by itself, any app can introduce a different way of previewing. **There are tons of Markdown apps that use different approaches to writing**. If Zettlr doesn't fit your needs, you can always choose from a plethora of different free, open source apps. * Markdown documents only contain the bare necessity of formatting to help apps understand it. Therefore **Markdown documents are approximately ten times smaller than conventional word processor formats**! * And many more … @@ -25,7 +25,7 @@ Editing text with Zettlr is simple. Just create a new file or select an existing * `Cmd/Ctrl+B`: Make text **bold** * `Cmd/Ctrl+I`: _Emphasize_ text -* `Cmd/Ctrl+K`: Create a new `[link](https://www.zettlr.com)`. Selected text will become the description—you only need to add the URL. And if there is a valid URL in the clipboard, Zettlr even takes it as a URL, meaning you don't have to do anything on your own! +* `Cmd/Ctrl+K`: Create a new `[link](https://www.zettlr.com)`. Selected text will become the description —you only need to add the URL. And if there is a valid URL in the clipboard, Zettlr even takes it as a URL, meaning you don't have to do anything on your own! * `Cmd/Ctrl+Shift+I`: Insert an image. If you selected text, it will become the description of the image. Just add a path to your image, or copy a path to an image before. Then, Zettlr will automatically add the clipped path! * `Tab`: Indent any given list one level. * `Shift-Tab`: Un-indent a list one level. @@ -34,7 +34,7 @@ Of course, all other default shortcuts that work on any text editor will also wo ## Preserving Formats During Copy & Paste -Of course it's mandatory that you can also work with formatted text. For instance, you might want to paste formatted text from a Word document or a webpage. To do so, simply copy such text and paste it. Zettlr will automatically detect that it's formatted text and convert it before inserting it. If you don't want to paste the text with formattings but as plain text, hold down `Shift` when pasting. This will tell Zettlr not to convert the text to Markdown. +Of course it's mandatory that you can also work with formatted text. For instance, you might want to paste formatted text from a Word document or a web page. To do so, simply copy such text and paste it. Zettlr will automatically detect that it's formatted text and convert it before inserting it. If you don't want to paste the text with formattings but as plain text, hold down `Shift` when pasting. This will tell Zettlr not to convert the text to Markdown. Next, at some point you want to copy some text from Zettlr but in a way that other apps can understand its format. To copy the text not as Markdown, but with a common format, you need to select `Copy as HTML`. The shortcut is `Cmd/Ctrl+Alt+C`. @@ -47,11 +47,11 @@ Because CodeMirror is so powerful, there are also other great options that you c * Press `Cmd` (macOS) or `Alt` (Windows/Linux) and click somewhere in the text. Now you will have **two cursors** at your disposal! This is mostly useful if you are about to write some text several times to save time. To leave that multi-cursor-mode, just click anywhere in the text without the modifier keys pressed. * Press `Cmd` (macOS) or `Alt` (Windows/Linux) and select some text. Now you can **select several portions of text** at once. This is useful if you want to create two or more links at once: Just select the portions of text that should serve as the description of these links and press `Cmd/Ctrl+K` to transform all the selections into links — at once! This works with all other commands like making text bold or italic, or creating quotes. * If you have nothing selected, pressing `Cmd/Ctrl+X` will **cut the full line**. Pressing `Cmd/Ctrl+V` afterwards will **insert this whole line above the line, in which your cursor is**. -* CodeMirror **auto-closes quotes and brackets** to save you time! Whenever you type a "- or a (-character, it will present you with the closing character automatically. And when you are done with your quote, just type " or ), it will _not add the character a second time_ but just "jump" over it! This also works with selected text. If you have something selected and press one of these characters, it will encapsulate your selection with the character pair. +* CodeMirror **auto-closes quotes and brackets** to save you time! Whenever you type a `"` or a `(` character, it will present you with the closing character automatically. And when you are done with your quote, just type `"` or `)`, it will _not add the character a second time_ but just "jump" over it! This also works with selected text. If you have something selected and press one of these characters, it will encapsulate your selection with the character pair. ## Emacs and Vim Editing Modes -Some people prefer a different way to insert text into the editor, and therefore like to use vim- or Emacs-keybindings. This input mode can be activated in the [settings](../reference/settings.md) and allows you to insert text differently than normal. This setting is recommended for advanced users only. +Some people prefer a different way to insert text into the editor, and therefore like to use Vim or Emacs key bindings. This input mode can be activated in the [settings](../reference/settings.md) and allows you to insert text differently than normal. This setting is recommended for advanced users only. ## Spellchecking @@ -69,4 +69,4 @@ Footnotes are a notoriously difficult thing in Markdown, because they require so 1. You can use a shortcut to place footnotes: `Cmd+Alt+R` (macOS only) or `Ctrl+Alt+F` (macOS/Windows/Linux). 2. The reference text (that is, the content of the footnote) will be displayed at the bottom end of the editor window when you hover over a footnote. -3. If you `Cmd`- or `Ctrl`-Click a footnote anchor somewhere in your text, a popup will show up that lets you edit the footnote in place. After you are finished editing your footnote, simply press `Shift+Enter` to close the popup and replace the text of the footnote. +3. If you `Cmd` or `Ctrl` click a footnote anchor somewhere in your text, a popup will show up that lets you edit the footnote in place. After you are finished editing your footnote, simply press `Shift+Enter` to close the popup and replace the text of the footnote. diff --git a/docs/en/core/export.md b/docs/en/core/export.md index 72646efa..8b4fea96 100755 --- a/docs/en/core/export.md +++ b/docs/en/core/export.md @@ -22,9 +22,9 @@ The second method to export files is to export whole [projects](../academic/proj Zettlr needs to know where to store your exported files. There are two options that you have: exporting them to your **temporary directory**, or to the **file's directory**. Both have their advantages and disadvantages. -> You can set the corresponding [setting](../reference/settings.md) in the Export-tab. +> You can set the corresponding [setting](../reference/settings.md) in the Export tab. -Exporting to the temporary directory allows you to export a file multiple times without you having to worry to remove the file again afterwards, because your temporary directory is regularly emptied by your computer. As Zettlr opens the file immediately with the default application (e.g. Word for `.docx`-files), you can use the "Save as …"-option to save the file to another location as soon as you are happy with the result. +Exporting to the temporary directory allows you to export a file multiple times without you having to worry about removing the file again afterwards, because your temporary directory is regularly emptied by your computer. As Zettlr opens the file immediately with the default application (e.g., Word for `.docx` files), you can use the "Save as …" option to save the file to another location as soon as you are happy with the result. If you don't worry about having exported files in between your Markdown files, you can also tell Zettlr to save the file in your current directory. Please note that Zettlr will always overwrite exported files without asking for a confirmation. diff --git a/docs/en/core/file-list.md b/docs/en/core/file-list.md index e8f5d12c..9a3a6274 100755 --- a/docs/en/core/file-list.md +++ b/docs/en/core/file-list.md @@ -12,7 +12,7 @@ The file list shows you all directories and files inside the directory that is c If you turned off the meta information, both directories and files will be shown as one-liners. If you display the *file information*, you will see additional information: directories will show you the amount of children they have. The files, on the other hand, show their last modification date. If they contain an ID or tags, this information will be displayed after the modification date. Hovering over the tag counter, you can see a small tooltip that shows you all tags that are in the file. -> You can toggle the file information via the "View" menu, by pressing `Cmd/Ctrl+Alt+S`, or the relevant setting in the preferences dialog under the General section +> You can toggle the file information via the "View" menu, by pressing `Cmd/Ctrl+Alt+S`, or the relevant setting in the preferences dialog under the General tab ### Meta Information on Files @@ -37,7 +37,7 @@ If you want to sort directories, you can do this from within the file list. Simp ![sorting_indicators.png](../img/sorting_indicators.png) -Also you can traverse the directory tree by clicking on the directories. A simple click will select the directory, while an `ALT`-click will select its parent directory. This is useful if you have to switch directories often, but prefer the thin mode of the sidebar and don't want to switch to the tree view repeatedly. +Also you can traverse the directory tree by clicking on the directories. A simple click will select the directory, while an `ALT` click will select its parent directory. This is useful if you have to switch directories often, but prefer the thin mode of the sidebar and don't want to switch to the tree view repeatedly. ## Structural implications @@ -49,12 +49,12 @@ As the file list flattens your complex directory tree, it has to make some assum 1. The currently selected directory will be on top of the list of files. Always. 2. All files that are inside this directory are placed directly beneath this directory name. -3. All subdirectories that are _inside_ this directory will always be at the bottom of the file list, i.e. _after_ the files in the selected directory. +3. All subdirectories that are _inside_ this directory will always be at the bottom of the file list, i.e., _after_ the files in the selected directory. 4. If directories are empty, they will be placed immediately after each other with no files in between. So what is important to remember is: All directories will be displayed as if they reside on the very same level; as if they weren't nested. To identify which directories contain which, please refer to the tree view. -> If you do not like the "natural" sorting of Zettlr (so that 10 comes after 2), you can switch to "ASCII" sorting in the settings (so that 2 comes after 10). +> If you do not like the "natural" sorting of Zettlr (so that 10 comes after 2), you can switch to "ASCII" sorting in the General tab of the settings dialog (so that 2 comes after 10). ## Actions in the file list @@ -64,7 +64,7 @@ You can move your files into different locations. Just drag them from the file l If you drag a file outside of the app, you are able to share the file with other programs. To cancel this dragging-out, simply release the mouse over your app again. -> To drag out a file into other applications, make sure to **hold the `Ctrl`-key or the `Alt`-key before dragging your file!** This will tell Zettlr that you don't want to move the file within Zettlr, but outside of the app. +> To drag out a file into other applications, make sure to **hold the `Ctrl` key or the `Alt` key before dragging your file!** This will tell Zettlr that you don't want to move the file within Zettlr, but outside of the app. ## Search Heatmap diff --git a/docs/en/core/localisation.md b/docs/en/core/localisation.md index 8c1ea316..c05735a7 100755 --- a/docs/en/core/localisation.md +++ b/docs/en/core/localisation.md @@ -27,7 +27,7 @@ Of course, you may want to install new dictionaries for languages you write in t To enable spell-checking for a specific language, simply open the user dictionary folder by selecting `File`->`Import Dictionary …` from the menu. Zettlr will then open up the folder in which you need to place the dictionary files. -The dictionary consists of two files, one is a `.dic`-file, and the other is an `.aff`-file. They need to be placed inside a folder that is named after the language you want to import. Let us assume you want to import the dictionary for Portuguese. You need to grab it from some repository, for instance [the GitHub user wooorm has an extensive set](https://github.com/wooorm/dictionaries/tree/main/dictionaries). Then you simply need to make sure the folder is named `pt-PT` and the two files are named `pt-PT.dic` and `pt-PT.aff`. Other files inside the directory will be ignored by Zettlr. As soon as you have placed your files inside the `dict`-directory, open the preferences and Zettlr should list your newly imported dictionary! +The dictionary consists of two files, one is a `.dic` file, and the other is an `.aff` file. They need to be placed inside a folder that is named after the language you want to import. Let us assume you want to import the dictionary for Portuguese. You need to grab it from some repository, for instance [the GitHub user wooorm has an extensive set](https://github.com/wooorm/dictionaries/tree/main/dictionaries). Then you simply need to make sure the folder is named `pt-PT` and the two files are named `pt-PT.dic` and `pt-PT.aff`. Other files inside the directory will be ignored by Zettlr. As soon as you have placed your files inside the `dict` directory, open the preferences and Zettlr should list your newly imported dictionary! > **Hint:** Zettlr tries to translate the language strings automatically, but in some cases it may happen that Zettlr does not contain translations for specific languages. In this case, Zettlr will fallback to the language code and display it as, e.g., `pt-PT`. diff --git a/docs/en/core/search.md b/docs/en/core/search.md index 31b490f1..817d69ea 100644 --- a/docs/en/core/search.md +++ b/docs/en/core/search.md @@ -1,6 +1,6 @@ # Searching -One of the huge benefits of switching to Markdown to write documents is, that the documents themselves are searchable through your operating system's built-in search (e.g. Cortana on Windows, Spotlight on macOS or Dash on Linux systems). But of course it helps a lot if you don't have to leave the program when you are searching for something. That's where the search comes in! There are basically three distinct search functions: A fast filtering function that you use every time you select another directory in the list on the left, a document-wide search and a global search. +One of the huge benefits of switching to Markdown to write documents is, that the documents themselves are searchable through your operating system's built-in search (e.g., Cortana on Windows, Spotlight on macOS or Dash on Linux systems). But of course it helps a lot if you don't have to leave the program when you are searching for something. That's where the search comes in! There are basically three distinct search functions: A fast filtering function that you use every time you select another directory in the list on the left, a document-wide search and a global search. ## Filtering files @@ -10,7 +10,7 @@ The first function has already been mentioned on multiple occasions. As the prev If you are searching for specific phrases or words inside your currently opened file, just press `Cmd/Ctrl+F`. A small popup will open underneath the magnification symbol providing you with the common search and replace options. Just type something and hit `Enter` repeatedly to cycle through the matches. Press `ESC` or click outside the popup to close the search. -> **Tip**: You can also make use of powerful regular expressions for searching. Zettlr by default performs a default search, but when a regular expression is detected (i.e. your search is encapsulated with slashes), it will perform a RegExp-search. Once Zettlr has detected a regular expression, the search field will change its font to monospace to help you write your regular expression. To search for all digits, for instance, you'd search for `/\d+/`. [Learn more about JavaScript regular expressions here](https://codeburst.io/javascript-learn-regular-expressions-for-beginners-bb6107015d91). +> **Tip**: You can also make use of powerful regular expressions for searching. Zettlr by default performs a default search, but when a regular expression is detected (i.e., your search is encapsulated with slashes), it will perform a RegEx search. Once Zettlr has detected a regular expression, the search field will change its font to monospace to help you write your regular expression. To search for all digits, for instance, you'd search for `/\d+/`. [Learn more about JavaScript regular expressions here](https://codeburst.io/javascript-learn-regular-expressions-for-beginners-bb6107015d91). If you press `Enter` while the replace input is focused, Zettlr will replace the current search result and automatically highlight the next occurrence of your search term. Hit `Enter` repeatedly to replace multiple occurrences. If you want to replace all occurrences at once, you can hit `Alt+Enter` while the replace input has focus. @@ -20,28 +20,28 @@ Of course, you can also use the search in Quicklook windows. Therefore, just cli ## Searching globally -The most important aspect of searching is, in fact, the global search which you can trigger by hitting `Cmd/Ctrl+Shift+F`. The search input in the toolbar will receive focus, letting you search a specific subset of files in your root directory: Only those currently visible in the pane. That means you can choose which files will be searched by selecting an appropriate directory in the list---use the filtering function to your benefit! +The most important aspect of searching is, in fact, the global search which you can trigger by hitting `Cmd/Ctrl+Shift+F`. The search input in the toolbar will receive focus, letting you search a specific subset of files in your root directory: Only those currently visible in the pane. That means you can choose which files will be searched by selecting an appropriate directory in the list -use the filtering function to your benefit! If you want to search _all_ files at once, select a root directory. If you only want to search in a specific directory, select that before searching. In most cases you have an idea where the text you need is located. For instance, if you are searching for a quote on a certain issue that can be cited in scientific research you may not want to search through all your thoughts and ideas, but limit your search to the directory where you store your excerpts of scientific texts and papers. The search itself is rather powerful. You can make use of several different operators to specify exactly what you are searching for: -* **AND-operator:** Type `Boat Ship` to only display the files that contain _both_ the term "boat" and the term "ship". Each space is interpreted as "AND". -* **OR-operator:** Type `Boat | Ship` (| is the Pipe-operator, inserted by `Alt+7` on macOS or `AltGr+<` on other systems) to select all files that contain _either_ the word "boat" _or_ the word "ship" -* **Exact-Match-operator:** Type `"Boat Ship"` to search your files for that exact phrase. -* **NOT-operator:** Typ `!Boat` to search only for files _not_ containing that term. Works with exact matches as well: `!"Boat Ship"` would exclude all files containing the exact phrase "Boat Ship". +* **AND operator:** Type `Boat Ship` to only display the files that contain _both_ the term "boat" and the term "ship". Each space is interpreted as "AND". +* **OR operator:** Type `Boat | Ship` (| is the Pipe-operator, inserted by `Alt+7` on macOS or `AltGr+<` on other systems) to select all files that contain _either_ the word "boat" _or_ the word "ship" +* **Exact-Match operator:** Type `"Boat Ship"` to search your files for that exact phrase. +* **NOT operator:** Type `!Boat` to search only for files _not_ containing that term. Works with exact matches as well: `!"Boat Ship"` would exclude all files containing the exact phrase "Boat Ship". -> **Attention**: While the AND-, OR-, and Exact-Match-operators work by assigning weights (a file that fulfills all search criteria will be coloured bright, while files which do not match all search terms have a faded background), the NOT-operator definitely excludes files. So while a search for `boat ship` would also include files containing only one of the two terms (albeit with a much lower weight), a search for `!boat ship` will definitely exclude all files containing the word boat. +> **Attention**: While the `AND`, `OR`, and `Exact-Match` operators work by assigning weights (a file that fulfills all search criteria will be coloured bright, while files which do not match all search terms have a faded background), the `NOT` operator definitely excludes files. So while a search for `boat ship` would also include files containing only one of the two terms (albeit with a much lower weight), a search for `!boat ship` will definitely exclude all files containing the word boat. Of course, you can chain all of these operators. So you could search for `"Boat Ship" | vessel captain` to display only files that either contain the exact phrase "Boat Ship" or the word "vessel", and which also include the word "captain". Don't worry if you do not remember the complete word you are searching for: Zettlr will try to match your search terms also to partial words, so the word "trooper" would also match "Stromtrooper" as well as "Troopership" as would the phrase "Boat Ship" also match a "Steamboat Ship". **Searches are also case-insensitive**. So you don't have to worry about little typos you may have in some files. -While Zettlr is searching, it will display a search indicator to the right of the search box. Once it is done, it will colour all of your files. The more green-ish they are, the more relevant they are (i.e. the more high-quality matches have been found inside that file). This is kind of a **heat map for search results** letting you easily identify the relevant files for your search. +While Zettlr is searching, it will display a search indicator to the right of the search box. Once it is done, it will colour all of your files. The more green-ish they are, the more relevant they are (i.e., the more high-quality matches have been found inside that file). This is kind of a **heat map for search results** letting you easily identify the relevant files for your search. > Please note that Zettlr will hide all files in which the search terms did never match, as well as all directories. -To achieve better results, Zettlr will weigh different types of matches differently. For instance, an exact match in the title can be a sign that the file is highly relevant to you. Therefore, Zettlr will weigh this heavier than other matches. Also, if a search term has matched case-sensitive, this match will receive a higher score than if the term has only matched case-insensitive (i.e. there was a difference in capitalisation). +To achieve better results, Zettlr will weigh different types of matches differently. For instance, an exact match in the title can be a sign that the file is highly relevant to you. Therefore, Zettlr will weigh this heavier than other matches. Also, if a search term has matched case-sensitive, this match will receive a higher score than if the term has only matched case-insensitive (i.e., there was a difference in capitalisation). To find the exact place where your search matched, select a file and Zettlr will automatically highlight all matches in bright yellow easy to find. Also, the scrollbar to the very right of the window will be showing markers to indicate at which positions in the document your search terms occur. diff --git a/docs/en/core/tables.md b/docs/en/core/tables.md index 88a677bc..6b425be5 100644 --- a/docs/en/core/tables.md +++ b/docs/en/core/tables.md @@ -1,6 +1,6 @@ # Tables in Zettlr -Markdown tables are a notoriously difficult thing. Due to the nature of Markdown to be as simple as possible, complexity is what suffers most. Markdown is the perfect choice for writing text and most of what we use during writing (e.g. links, images, headings, or quotes) is handled perfectly in Markdown. Yet, from time to time, we also want to include some data in our works, or tables are simply a better way of visualising ideas. +Markdown tables are a notoriously difficult thing. Due to the nature of Markdown to be as simple as possible, complexity is what suffers most. Markdown is the perfect choice for writing text and most of what we use during writing (e.g., links, images, headings, or quotes) is handled perfectly in Markdown. Yet, from time to time, we also want to include some data in our works, or tables are simply a better way of visualising ideas. ## Introduction to Tables @@ -45,13 +45,13 @@ Obviously, writing Markdown tables is sometimes unavoidable, but always painful. While Zettlr maintains a strict policy on [WYSIWYG](https://en.wikipedia.org/wiki/WYSIWYG) ("What You See Is What You Get"), as it tends to blur your perception of what you are actually writing, tables are exempt from this policy. Because even though the [WYSIWYM](https://en.wikipedia.org/wiki/WYSIWYM) ("What You See Is What You Mean") approach is superior to WYSIWYG, there's simply no use in applying this to tables. -Therefore, to aid you with writing tables, Zettlr is now shipping with a powerful table editor that brings to you everything you need to not completely lose your mind while creating tables in your documents. With the table editor, the above-mentioned table looks like this: +Therefore, to aid you with writing tables, Zettlr is now shipping with a powerful table editor that brings to you everything you need to not completely lose your mind while creating tables in your documents. With the table editor, the above mentioned table looks like this: ![A table as displayed by the table editor](../img/zettlr_table.png) Much better, am I right? Zettlr's table editor takes all Markdown tables found in your document, converts them into an HTML representation with editable content cells, and displays these instead of the underlying Markdown. This completely hides the Markdown source, but as we said, in this case this approach is much more favourable. -You can **enter the editing mode** simply by clicking into any of the cells inside the table and adding your content. The active cell will be highlighted for you. Additionally, the keyboard navigation that you know from famous word processors has also been implemented so that you can use `Tab`, `Return`, and the Arrow keys to navigate the table. Additionally, adding and removing columns and rows is also possible with the table editor's **edge buttons**. These are buttons that will appear when you hover over the table and let you perform various actions on the table. +Table editor needs to be enabled in Preferences, under the `Editor` tab. When enabled, it will recognize the tables in the active document and make them easily editable. You can **enter the editing mode** simply by clicking into any of the cells inside the table and adding your content. The active cell will be highlighted for you. Additionally, the keyboard navigation that you know from famous word processors has also been implemented so that you can use `Tab`, `Return`, and the Arrow keys to navigate the table. Additionally, adding and removing columns and rows is also possible with the table editor's **edge buttons**. These are buttons that will appear when you hover over the table and let you perform various actions on the table. > Attention! When you activate the table by clicking inside one of the cells, you are entering the edit mode. To save your changes, make sure to **click outside of the table once you are done**, to exit the editing mode! Only then will the changes you've made to the table be applied to the underlying Markdown table. @@ -75,7 +75,7 @@ Another goodie of the table editor are its so-called **edge buttons**. These are ![The table editor's edge buttons](../img/table_with_edge_buttons.png) -They are transparent at the beginning to not cover up the content of your table. Move your cursor over an edge button to make it opaque. The buttons should be rather self-explanatory. The four `(+)`-buttons at the center of the edges of the table will **add a row or column respectively** at the indicated position. So click the left add button to prepend a column to the left side of the currently active cell, and click the bottom add button to append a row below the currently active cell. +They are transparent at the beginning to not cover up the content of your table. Move your cursor over an edge button to make it opaque. The buttons should be rather self-explanatory. The four `(+)` buttons at the center of the edges of the table will **add a row or column respectively** at the indicated position. So click the left add button to prepend a column to the left side of the currently active cell, and click the bottom add button to append a row below the currently active cell. At the top of each table, there are two additional button groups. The left button group contains three buttons that **align the currently active table column** left, center or right. Click one of the buttons to apply the alignment. The change will be displayed immediately for your visual confirmation. @@ -89,7 +89,7 @@ The right button group contains two buttons for **removing the currently active Until now we've only covered basic tables. But what if you need to display more complex tables? Then, even the table editor is at its end. Cells spanning multiple rows or columns are simply impossible given the limited syntax of Markdown tables. To add these, you'll have to use native HTML or LaTeX commands. These give you the maximum amount of freedom to do whatever you like. -Always remember: Tables in Markdown are used as an _aid_ to your _writing_. This means if you are dealing with complex datasets which you need to add to a paper, e.g. in the sources section, there are great tools out there to [transform your RDataset](https://tex.stackexchange.com/questions/364225/export-tables-from-r-to-latex) or Stata datafile into LaTeX or HTML. +Always remember: Tables in Markdown are used as an _aid_ to your _writing_. This means if you are dealing with complex datasets which you need to add to a paper, e.g., in the sources section, there are great tools out there to [transform your RDataset](https://tex.stackexchange.com/questions/364225/export-tables-from-r-to-latex) or Stata datafile into LaTeX or HTML. One idea to insert datasets into your papers without much copying and pasting would be to combine several features of Zettlr: diff --git a/docs/en/core/tabs.md b/docs/en/core/tabs.md index 4983549a..5bdbeefa 100644 --- a/docs/en/core/tabs.md +++ b/docs/en/core/tabs.md @@ -1,6 +1,7 @@ # Document Tabs -Zettlr offers to open multiple documents at the same time in tabs. +Zettlr allows opening multiple documents at the same time in tabs. + These tabs have similarities with tabs in other applications, but some of their features differ from tabs in browser for example. All tabs are restored when you reopen the application. diff --git a/docs/en/core/yaml-frontmatter.md b/docs/en/core/yaml-frontmatter.md index 7f983477..b37f982c 100644 --- a/docs/en/core/yaml-frontmatter.md +++ b/docs/en/core/yaml-frontmatter.md @@ -56,11 +56,11 @@ author: affiliation: University Y ``` -> Note the indentation of the property `affiliation`: It aligns with the `name`-property. Indentation of YAML values is important and thus you should take care. +> Note the indentation of the property `affiliation`: It aligns with the `name` property. Indentation of YAML values is important and thus you should take care. ### Variable `keywords` -The `keywords`-variable contains keywords, or tags, that can be used by Pandoc to fill in, e.g., the PDF keywords field (note: if you use the default template for PDF exports, the PDF keywords field is controlled in the [PDF settings](../reference/settings.md#pdf-preferences)). +The `keywords` variable contains keywords, or tags, that can be used by Pandoc to fill in, e.g., the PDF keywords field (note: if you use the default template for PDF exports, the PDF keywords field is controlled in the [PDF settings](../reference/settings.md#pdf-preferences)). These keywords can be used to circumvent one restriction of the common in-text tags Zettlr supports: You can define arbitrary keywords that can also include spaces. These keywords are recognized by Zettlr and added to the list of tags of the file. @@ -70,7 +70,7 @@ This variable controls the language output for Pandoc citeproc. This is most use If you do not set this variable, the language of references will be taken from the default language field in the CSL style used, which might be undesirable in case your text is in a different language. -Valid values for this field are [BCP-47](https://tools.ietf.org/html/bcp47) compatible language identifiers (e.g. `en-US`, `de-AT`, or `it`). +Valid values for this field are [BCP-47](https://tools.ietf.org/html/bcp47) compatible language identifiers (e.g., `en-US`, `de-AT`, or `it`). ### Variable `nocite` @@ -82,4 +82,4 @@ Use this variable to define a heading for your list of references. This has the ### Variable `notes-after-punctuation` -This can be used to direct citeproc to move footnotes with your citations after punctuation (e.g. if you cite `something [@citekey].`, it will become `something.[^1]` in the output). +This can be used to direct citeproc to move footnotes with your citations after punctuation (e.g., if you cite `something [@citekey].`, it will become `something.[^1]` in the output).