diff --git a/docs/en/reference/keyboard-shortcuts.md b/docs/en/reference/keyboard-shortcuts.md index b9f5602e..1e442a1e 100755 --- a/docs/en/reference/keyboard-shortcuts.md +++ b/docs/en/reference/keyboard-shortcuts.md @@ -6,8 +6,8 @@ For remembering them easier, here are some thoughts we've put into assigning the 1. **Common shortcuts**: Some shortcuts are so common that they don't fit into our shortcut system, but everybody will recognise them. One example is the preferences shortcut (`Cmd/Ctrl+,`), another the shortcut to finish editing a footnote (`Shift+Enter`). We try to use as many of these shortcuts as possible to reduce friction. 2. **High-priority shortcuts**: You will be using these shortcuts _a lot_ while using the app. These are generally `Cmd/Ctrl` and one single letter. While naming the shortcuts we try to stick to the English names of the command that it triggers (**N**ew, **R**emove, **F**ind, etc). Sometimes this is not possible (for instance the Distraction Free mode is triggered via `Cmd/Ctrl+J`, because `Cmd/Ctrl+D` is already taken by the editor). -3. **Alternative actions**: We take the semantic meaning of the `Alt`-key serious. Therefore, take a high-priority shortcut, add an `Alt` to it and you normally tend to trigger an alternative action on the same target. Notable exceptions to this are the developer panel (opens with `Cmd/Ctrl+Alt+I`, while `Cmd/Ctrl+I` makes text Italic). -4. **Alternative targets**: In case you want to perform the same _action_, but on a different target, try using a `Shift`-key. Throughout most of the app, `Shift`-commands will change the target from the currently selected file to the currently selected directory. The search also utilises this (`Cmd/Ctrl+F` searches the file, while `Cmd/Ctrl+Shift+F` searches the whole directory). +3. **Alternative actions**: We take the semantic meaning of the `Alt` key seriously. Therefore, take a high-priority shortcut, add an `Alt` to it and you normally tend to trigger an alternative action on the same target. Notable exceptions to this are the developer panel (opens with `Cmd/Ctrl+Alt+I`, while `Cmd/Ctrl+I` makes text italic). +4. **Alternative targets**: In case you want to perform the same _action_, but on a different target, try using a `Shift` key. Throughout most of the app, `Shift` commands will change the target from the currently selected file to the currently selected directory. The search also utilises this (`Cmd/Ctrl+F` searches the file, while `Cmd/Ctrl+Shift+F` searches the whole directory). > Actions in the editor that involve the mouse generally require to press `Cmd/Ctrl` while clicking, for instance following links in the editor. @@ -42,7 +42,7 @@ For remembering them easier, here are some thoughts we've put into assigning the * `F5`: Reload the graphical user interface. * `Cmd+Alt+I` (macOs) `Ctrl+Shift+I` (Windows/Linux): Open the Chrome developer tools. -## Textfield-related app-wide shortcuts +## Textfield related app-wide shortcuts * `Cmd/Ctrl+Z`: Undo * `Cmd/Ctrl+Shift+Z`: Redo @@ -51,7 +51,7 @@ For remembering them easier, here are some thoughts we've put into assigning the * `Cmd/Ctrl+V`: Paste * `Cmd/Ctrl+A`: Select all text -## Editor-related shortcuts +## Editor related shortcuts * `Cmd/Ctrl+Alt+C`: Copy as HTML. If there is a selection, it will be converted to HTML and not copied as plain text. This allows you to paste it, e.g., into word processors. * `Cmd/Ctrl+Shift+C`: (Un-)Comment the given text selection (or add a new HTML comment at cursor position). @@ -65,7 +65,7 @@ For remembering them easier, here are some thoughts we've put into assigning the * `Cmd/Ctrl+F`: Opens the search popup inside the editor that has currently focus (either the main editor or a Quicklook window). * `Ctrl+Alt+F` (Windows/Linux) `Cmd+Alt+R` (macOS): Insert a new footnote at the current cursor position. * `Cmd/Ctrl+L`: Generate a new ID using the generator pattern from the settings dialog and insert it at the current cursor position. -* `Cmd/Ctrl+0`: Re-set the font-size of the editor to standard. +* `Cmd/Ctrl+0`: Re-set the font size of the editor to standard. * `Cmd/Ctrl+[1-9]`: Select the tab number 1 to 9. * `Ctrl+Tab`: Select the next tab. * `Ctrl+Shift+Tab`: Select the previous tab. @@ -87,14 +87,14 @@ These shortcuts work in each table editor once you enter the edit mode by clicki * `Arrow Up/Arrow Down`: Move to the same column in the previous/next row. No new rows will be added if you are in the first or last row. * `Arrow Left/Arrow Right`: Move the cursor left/right. If the cursor is at the beginning/end of the cell's contents, move to the previous/next cell. -## Preview-related shortcuts +## Preview related shortcuts * `Arrow Up`: Open the previous file. * `Arrow Down`: Open the next file. * `Cmd/Ctrl+Arrow Up`: Jump to the top of the list. * `Cmd/Ctrl+Arrow Down`: Jump to the bottom of the list. -## Popup-related shortcuts +## Popup related shortcuts * `ESC`: If any text field inside the popup has focus, pressing Escape will close the popup. diff --git a/docs/en/reference/markdown-basics.md b/docs/en/reference/markdown-basics.md index abb5134d..c2682ab1 100755 --- a/docs/en/reference/markdown-basics.md +++ b/docs/en/reference/markdown-basics.md @@ -12,11 +12,11 @@ Just like many other apps, Zettlr makes use of `Markdown`, originally invented b ## A brief history -Since the personal computer became widely available in the 1990s, there were two groups of formats existing side-by-side: word processor documents, such as `.doc`, or `.odt` and code documents, such as `.js`, `.cpp` or `.py`. Both groups of documents contain human-readable text, but there was one simple, yet huge difference: While JavaScript-files or C++-files contained plain text (i.e. only the text that you would see when you open such a file), word processor documents contained a _lot_ more stuff. Word processor documents always hold information about the page size (e.g., A4 or letter), how different blocks should be formatted (e.g., the font of headings or how much blockquotes are indented). If you open a Word/Office-document on your PC right now, you can see what I mean: You immediately see what is a heading based on the font-size font-weight of its text. +Since the personal computer became widely available in the 1990s, there were two groups of formats existing side-by-side: word processor documents, such as `.doc`, or `.odt` and code documents, such as `.js`, `.cpp` or `.py`. Both groups of documents contain human readable text, but there was one simple, yet huge difference: While JavaScript files or C++ files contained plain text (i.e., only the text that you would see when you open such a file), word processor documents contained a _lot_ more stuff. Word processor documents always hold information about the page size (e.g., A4 or letter), how different blocks should be formatted (e.g., the font of headings or how much blockquotes are indented). If you open a Word/Office document on your PC right now, you can see what I mean: You immediately see what is a heading based on the font size and font weight of its text. -For a long time, both these groups of documents stayed as distinct as would their users. Most office-workers only know how to use Microsoft Word or Excel, maybe also LibreOffice-implementations, while close to nobody coming from a STEM-background would voluntarily use Word or similar software. Those scientists have chosen a different path: they developed a programming language called LaTeX, which allows them to create neatly formatted PDF-files from a bunch of code---they follow the same workflow as researchers from the arts and humanities or regular administrative officers, but use different documents for that. +For a long time, both these groups of documents stayed as distinct as would their users. Most office workers only know how to use Microsoft Word or Excel, maybe also LibreOffice implementations, while close to nobody coming from a STEM background would voluntarily use Word or similar software. Those scientists have chosen a different path: they developed a programming language called LaTeX, which allows them to create neatly formatted PDF files from a bunch of code—they follow the same workflow as researchers from the arts and humanities or regular administrative officers, but use different documents for that. -When Markdown was inaugurated by John Gruber in 2004, it was basically like saying: "Why not both?" Markdown combines both the clear reading experience from word processor documents with the benefits of software code documents, which is both versatile and easy to use---even for people that only know how to operate Word or Writer. One small example: While in word processors you would create a heading by typing "some text" and then selecting the `Heading 1` format from some menu, in Markdown you would simply type `# some text`, where the hashtag-symbol tells you immediately: "This is a first level heading!" +When Markdown was inaugurated by John Gruber in 2004, it was basically like saying: "Why not both?" Markdown combines both the clear reading experience from word processor documents with the benefits of software code documents, which is both versatile and easy to use—even for people that only know how to operate Word or Writer. One small example: While in word processors you would create a heading by typing "some text" and then selecting the `Heading 1` format from some menu, in Markdown you would simply type `# some text`, where the hashtag-symbol tells you immediately: "This is a first level heading!" At first, Markdown was basically a small script John Gruber wrote for himself to yield these benefits, and it contained a lot of inconsistencies and didn't support many different elements. But over the years, progress was made. Two dates are notable: @@ -37,7 +37,7 @@ Today, several implementations of the Markdown syntax coexist. The most notewort Zettlr itself implements a mixture of different dialects. The editor itself highlights only GitHub flavoured Markdown (plus some Markdown extensions for Zettelkasten elements and other conveniences. The Zettelkasten elements are described in the respective [chapter on the Zettelkasten method](../academic/zkn-method.md), the others are described below). If you export your documents to HTML and don't have Pandoc installed, Zettlr will convert your documents using the _GitHub flavoured Markdown syntax_. If available, Zettlr uses Pandoc for exports, which itself reads your Markdown documents using its _Pandoc Markdown syntax_. -But Zettlr doesn't confine you to writing Markdown. If you wish, you can also add `LaTeX`-commands. These commands are correctly interpreted when you convert to PDF. These are omitted when you convert to DOCX or ODT. And they are retained when you convert to HTML. Of course, you can at any position use plain HTML-code as well. +But Zettlr doesn't confine you to writing Markdown. If you wish, you can also add `LaTeX` commands. These commands are correctly interpreted when you convert to PDF. These are omitted when you convert to DOCX or ODT. And they are retained when you convert to HTML. Of course, you can at any position use plain HTML code as well. ## Markdown 101: The most important codes @@ -54,9 +54,9 @@ Headings are straightforward. They must be put on their own line and have to be - `##### Heading text` — yields a heading of fifth order - `###### Heading text` — yields a heading of sixth order -### Inline-formatting +### Inline formatting -Of course, just as in word processors you can use inline-formatting, such as **bold** or _italic_ text, or `monospaced` (code) text. +Of course, just as in word processors you can use inline formatting, such as **bold** or _italic_ text, or `monospaced` (code) text. - `**your text**` — yields bold text - `_your text_` — yields italic text @@ -73,25 +73,25 @@ Sometimes, you may want to emphasise a whole block of text (such as a longer quo ### Links and images -Links are inline-elements and images are block elements, so they follow the same semantics as the elements discussed above. Yet they deserve a little bit more attention, because they offer you more options. +Links are inline elements and images are block elements, so they follow the same semantics as the elements discussed above. Yet they deserve a little bit more attention, because they offer you more options. -Links are set using the following syntax: `[This text will appear in your final document](http://this-is-your-actual-link.tld)` Zettlr will automatically convert this syntax to a clickable link (follow the link target by clicking on it while holding down the `ALT`- or `Ctrl`-key) for the ease of access (and to shorten those rather long links). +Links are set using the following syntax: `[This text will appear in your final document](http://this-is-your-actual-link.tld)` Zettlr will automatically convert this syntax to a clickable link (follow the link target by clicking on it while holding down the `ALT` or `Ctrl` key) for the ease of access (and to shorten those rather long links). Images work exactly like links, except they start with an exclamation mark (!). Images of course also need a path, because you won't store them in a plain text document. Therefore you can use three different approaches to linking images in your document: -1. Use an absolute web-URL, such as https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Markdown-mark.svg/1000px-Markdown-mark.svg.pngMarkdown. +1. Use an absolute web URL, such as https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Markdown-mark.svg/1000px-Markdown-mark.svg.pngMarkdown. 2. Use an absolute path to a file on your own computer, such as `C:\Users\user-name\Pictures\my-image.jpg`. 3. Use a relative path to a file on your own computer, such as `../img/my-image.png`. > **Tip**: You can provide a default image path in the "Editor" tab in the preferences, which Zettlr will always use when you paste an image into the editor. -The relative path is always relative to the document in which you place it. The directory `..` tells Zettlr to look for the image in the parent directory (i.e. to traverse up one directory). If you store your documents in a cloud and access them on different devices, you would naturally use relative image paths, because the absolute paths will definitely differ (especially if you work with two different operating systems). +The relative path is always relative to the document in which you place it. The directory `..` tells Zettlr to look for the image in the parent directory (i.e., to traverse up one directory). If you store your documents in a cloud and access them on different devices, you would naturally use relative image paths, because the absolute paths will definitely differ (especially if you work with two different operating systems). > **Tip**: Try to insert images and links always using their shortcuts, `Cmd/Ctrl+K` for links and `Cmd/Ctrl+Shift+I` for images. If you have a valid path in your clipboard, it will even automatically insert it for you, making your life easy. The best way to insert a link, for instance, would therefore be to first copy the link to your clipboard, then select the text you want to link and third press `Cmd/Ctrl+K`. Then the selected text will become the displayed link text and the link from your clipboard will be used as the link target. ### Footnotes -Footnotes are what most researchers in arts and humanities are of course interested in. So here some general rules for inserting footnotes and how Zettlr interacts with them. According to standard Markdown syntax, footnotes require two elements: First the reference somewhere in the text in the format `[^x]`. The `x` stands for a unique identifier. Basically, you can use anything you want, as long as this identifier is not used by a second footnote as well. But normally, you will want to stick with ascending numbers. (Also: These numbers don't have to be in order—as long as you export your Markdown document, Pandoc will automatically re-number the footnotes correctly. So if you decide to delete a footnote later on, don't worry that the numbers won't neatly match up in your document anymore.) +Footnotes are what most researchers in arts and humanities are of course interested in. So here some general rules for inserting footnotes and how Zettlr interacts with them. According to standard Markdown syntax, footnotes require two elements: First the reference somewhere in the text in the format `[^x]`. The `x` stands for a unique identifier. Basically, you can use anything you want, as long as this identifier is not used by a second footnote as well. But normally, you will want to stick with ascending numbers. (Also: These numbers don't have to be in order; as long as you export your Markdown document, Pandoc will automatically re-number the footnotes correctly. So if you decide to delete a footnote later on, don't worry that the numbers won't neatly match up in your document anymore.) The second element footnotes require is a block element, the footnote _reference text_. It is always in the following format: `[^x]: Your reference text.` As you can see, the identifier is a replica of your reference that appears in the text, only now it is followed by a colon. It is common sense that you put your references in a list at the very end of your document. Yet, this jumping back and forth between the reference text and your footnote reference is cumbersome, and therefore Zettlr tries to ease your life. Move your mouse over a footnote reference to see the footnote text. Click it while holding down `Cmd` or `Ctrl` to edit the footnote. Press `Shift+Return` to save your changes. @@ -169,4 +169,4 @@ In addition to GitHub flavored markdown extensions (marked with "(extension)" in ## Resources on Markdown -Do you want to learn _all_ about Markdown? That is great! A good resource that covers all elements is to be found on [Learn X in Y minutes](https://learnxinyminutes.com/docs/markdown/). If you want to get used to writing clean and unambiguous Markdown, [view the specifications by CommonMark](https://spec.commonmark.org/0.28/). Also, there's a "book" on the GitHub flavoured Markdown syntax. [View it here](https://gitbookio.gitbooks.io/markdown/content/). +Do you want to learn _all_ about Markdown? That is great! A good resource that covers all elements is to be found on [Learn X in Y minutes](https://learnxinyminutes.com/docs/markdown/). If you want to get used to writing clean and unambiguous Markdown, [view the specifications by CommonMark](https://spec.commonmark.org/current/). Also, there's a "book" on the GitHub flavoured Markdown syntax. [View it here](https://gitbookio.gitbooks.io/markdown/content/). diff --git a/docs/en/reference/settings.md b/docs/en/reference/settings.md index 424c5260..3b1c5d90 100755 --- a/docs/en/reference/settings.md +++ b/docs/en/reference/settings.md @@ -1,6 +1,6 @@ # Settings -Zettlr offers you a plethora of options to customise your experience with the app. It comes with three different settings-dialogs that will be explained in detail here, so you know which option does what. +Zettlr offers you a plethora of options to customise your experience with the app. It comes with three different settings dialogs that will be explained in detail here, so you know which option does what. ## General Preferences @@ -22,7 +22,7 @@ You can display the general preference dialog using either the shortcut `Cmd/Ctr In the general tab you find options that you might want to adjust if you begin using Zettlr to fit it to your needs. The application language is pretty self-explanatory. -The “Night Mode” and “File information”-checkboxes control the display. The “Night Mode” is simply the dark theme Zettlr is capable of (and which you might want to control using the shortcut `Cmd/Ctrl+Alt+L` instead). Check the “File information”-checkbox to display meta information in the file list (although you can control this behaviour as well using its respective shortcut `Cmd/Ctrl+Alt+S`). +The “Night Mode” and “File information” checkboxes control the display. The “Night Mode” is simply the dark theme Zettlr is capable of (and which you might want to control using the shortcut `Cmd/Ctrl+Alt+L` instead). Check the “File information” checkbox to display meta information in the file list (although you can control this behaviour as well using its respective shortcut `Cmd/Ctrl+Alt+S`). If you check “Hide directories during global search,” Zettlr will not display directories while performing a search. by selecting “Always load remote changes to the current file”, Zettlr will not ask you whether you’d like to replace the file in the editor. @@ -46,7 +46,7 @@ Last but not least Zettlr can automatically switch to light or dark mode dependi ![settings_editor.png](../img/settings_editor.png) -The editor tab controls most functionality of the editor. As Markdown allows both asterisks and underscores to make text bold and italic, you can choose your favourite flavour here. The **default image path** is a path you can use to tell Zettlr where it should put your images when you paste them from clipboard. It can be absolute or relative. If you provide the name `assets`, Zettlr would put images by default into the `assets` subdirectory of the directory where your file is. You can even tell it to use a directory relative to the parent directory, e.g. `../assets`. Remember that you can always select the directory for an image on a case-by-case basis. +The editor tab controls most functionality of the editor. As Markdown allows both asterisks and underscores to make text bold and italic, you can choose your favourite flavour here. The **default image path** is a path you can use to tell Zettlr where it should put your images when you paste them from clipboard. It can be absolute or relative. If you provide the name `assets`, Zettlr would put images by default into the `assets` subdirectory of the directory where your file is. You can even tell it to use a directory relative to the parent directory, e.g., `../assets`. Remember that you can always select the directory for an image on a case-by-case basis. The indentation refers to the amount of spaces inserted when you, e.g., increase the level of lists. @@ -54,7 +54,7 @@ The algorithm for the readability mode that Zettlr should use when you toggle th Further, you can **mute non-focused lines** while you are in the distraction free mode. This means that Zettlr dims all lines except the one where your cursor is. The next option allows you to **automatically close certain character pairs**. -The third option only applies to users using a keyboard that features the `Home` and `End` keys. If you press them, the default CodeMirror behaviour is to move the cursor to the beginning or end respectively of a whole paragraph (i.e.: the beginning and end of a _logical_ line). If you want CodeMirror to only move to the beginning and end of the _visible_ line, make sure to turn off this option. If you make use of the hard-wrap feature of Markdown, and always manually wrap a paragraph, this setting won't have any effect for you. +The third option only applies to users using a keyboard that features the `Home` and `End` keys. If you press them, the default CodeMirror behaviour is to move the cursor to the beginning or end respectively of a whole paragraph (i.e., the beginning and end of a _logical_ line). If you want CodeMirror to only move to the beginning and end of the _visible_ line, make sure to turn off this option. If you make use of the hard-wrap feature of Markdown, and always manually wrap a paragraph, this setting won't have any effect for you. ### Export @@ -64,7 +64,7 @@ The export tab allows you to tweak all preferences concerning how your files are Selecting "Remove ZKN IDs from files" makes Zettlr remove all IDs that it finds in your files prior to export. "Remove tags from files" does the same but with tags. -> We recommend leaving the option to remove Zettelkasten IDs from your files off unless you know what you are doing. Some websites produce links that contain 14 consecutive digits, and Zettlr will only stroll through the files removing everything your ID regular expression will detect, so it may break links! +> We recommend leaving the option to remove Zettelkasten IDs from your files off unless you know what you are doing. Some websites produce links that contain 14 consecutive digits, and Zettlr will only stroll through the files removing everything your ID regular expression will detect, so it may break links! One way to work around this may be to use an ID pattern that is unique enough (e.g., with a specific prefix) that Zettlr will not remove anything else. Specifying a pattern and a regular expression is explained in the next section. Below these options you can choose what to do with internal links (by default they are encapsulated in `[[` and `]]`). The first option completely removes them, the second only removes the link formatting, while the last option leaves them alone. @@ -80,7 +80,7 @@ The CSL JSON database field can be used to open a literature database. Zettlr wi In this tab you can customise the way Zettlr works with your existing Zettelkasten system. In most cases you won't need to touch these options, except you want to use a custom system. -You have four options that are important for Zettelkästen: The ID regular expression, the link start and ending, and the generator pattern. +You have four options that are important for Zettelkasten: The ID regular expression, the link start and ending, and the generator pattern. #### The ID RegEx @@ -94,19 +94,19 @@ The braces around the `\d{14}` create a so-called "capturing group". A capturing #### The Internal Links -The internal links are explained pretty quick: Simply choose how you'd like to write internal links. The default are Wiki-Style-Links: [[your-link]]. You could also use curly brackets: {{your-link}}. Or you could use exclamation marks: !your-link!. Whatever suits you! +There is a quick explanation for the internal links: Simply choose how you'd like to write internal links. The default are Wiki style links: `[[your-link]]`. You could also use curly brackets: `{{your-link}}`. Or you could use exclamation marks: `!your-link!`. Whatever suits you! -The internal links are used for two things: First, if they either contain an existing file name or an existing ID, clicking them will directly open the respective file (identified either by its name without the extension, or by its ID). Second, if they don't contain any of that, they won't open any file, but they will work as a search function, so `Cmd/Ctrl`-clicking them will start a search — this is great for saving searches you do often! +The internal links are used for two things: First, if they either contain an existing file name or an existing ID, clicking them will directly open the respective file (identified either by its name without the extension, or by its ID). Second, if they don't contain any of that, they won't open any file, but they will work as a search function, so `Cmd/Ctrl` clicking them will start a search — this is great for saving searches you do often! > Note that files will not assume any link as an ID. If a file finds an ID that is surrounded by the internal link formatting, it will not use this ID. #### The ID Generator -The last field in the Zettelkasten tab in the preferences window concerns the way the IDs are generated. It is a simple string that may contain variables that are replaced when an ID is generated. Currently, you have the current year, month, day, hour, minute, and second available. The default ID generator pattern is: `%Y%M%D%h%m%s`, which means it will replace `%Y` with the current year (4 digits), `%M` with the current month (with leading zeroes), and so forth. You could also include some static part in your IDs, if you wish. So with the ID pattern set to `%Y-%M-%D_%h:%m:%s` Zettlr would generate an ID like this: `2018-10-12_12:03:56`. You can also reuse the variables in your pattern, e.g. to use only seconds as your ID. You could use something like this: `%s%s%s` and would get `565656`. +The last field in the Zettelkasten tab in the preferences window concerns the way the IDs are generated. It is a simple string that may contain variables that are replaced when an ID is generated. Currently, you have the current year, month, day, hour, minute, and second available. The default ID generator pattern is: `%Y%M%D%h%m%s`, which means it will replace `%Y` with the current year (4 digits), `%M` with the current month (with leading zeroes), and so forth. You could also include some static part in your IDs, if you wish. So with the ID pattern set to `%Y-%M-%D_%h:%m:%s` Zettlr would generate an ID like this: `2018-10-12_12:03:56`. You can also reuse the variables in your pattern, e.g., to use only seconds as your ID. You could use something like this: `%s%s%s` and would get `565656`. Always remember to adapt your regular expression so that it matches what the ID generator spits out. To successfully identify the ID with the pattern, `%Y-%M-%D_%h:%m:%s`, Zettlr would need the following regular expression: `(\d{4}-\d{2}-\d{2}_\d{2}:\d{2}:\d{2})`. If you use `%uuid4`, you can use the following RegEx: `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}`. -You can test both the generation of IDs and the detection of them by clicking the Test-button below the text fields. Zettlr will then generate an ID and immediately tries to match it using your custom regular expression. Whether or not Zettlr was able to detect the ID will be indicated. +You can test both the generation of IDs and the detection of them by clicking the Test button below the text fields. Zettlr will then generate an ID and immediately tries to match it using your custom regular expression. Whether or not Zettlr was able to detect the ID will be indicated. ### Display @@ -114,13 +114,13 @@ You can test both the generation of IDs and the detection of them by clicking th This tab controls how the editor displays certain elements. Zettlr uses a semi-preview approach to Markdown and only renders some elements. On this tab you can control which elements will be rendered. -> The iFrame-setting controls whether or not to render iFrames (for instance, YouTube-videos are embedded iFrames). +> The iFrame setting controls whether or not to render iFrames (for instance, YouTube videos are embedded iFrames). -Additionally you can constrain the size of images, which is especially beneficial if you use a lot of portrait oriented images. The horizontal slider controls the maximum amount of width images are allowed to occupy. Setting this to 50 %, for instance, will keep images at half the width of the text body. 100 % disables this (images will never be wider than 100 % of the text body width). +Additionally you can constrain the size of images, which is especially beneficial if you use a lot of portrait oriented images. The horizontal slider controls the maximum amount of width images are allowed to occupy. Setting this to 50%, for instance, will keep images at half the width of the text body. 100% disables this (images will never be wider than 100% of the text body width). The vertical slider controls the maximum height of the images relative to the window size. 50 percent would mean that images will never be higher than half of the window's total size. 100 percent disables this behaviour. Unlike the width, images may very well exceed 100 percent of the viewport if they are large and thin. -Last but not least you can determine which date you would like to see in the file metadata in the file list. This does not affect the sorting, if you’d like to sort by date. To change the time after which Zettlr should sort your files, please refer to the general tab. +Last but not least, you can determine which date you would like to see in the file metadata in the file list. This does not affect the sorting, if you’d like to sort by date. To change the time after which Zettlr should sort your files, please refer to the general tab. ### Theme @@ -136,7 +136,7 @@ With the introduction of the user dictionary, the spellchecking functionality ha > **Tip**: To disable spell checking, uncheck all dictionaries. To install additional dictionaries, refer to the [localisation manual](../core/localisation.md). -Finally, the list on the right hand side of the tab displays all the words you've added to your custom dictionary. Click them to remove them from your user dictionary. +Finally, the list on the right hand side of the tab displays all the words you've added to your custom dictionary. You can remove an item from your custom dictionary by clicking on it. ### AutoCorrect @@ -152,15 +152,15 @@ The last thing you can tweak is the replacement table to the right: These are si ![settings_advanced.png](../img/settings_advanced.png) -The advanced tab contains options that are helpful for advanced users. +The advanced tab contains options that are helpful for advanced tasks. -The “pattern for new filenames” is what the textfield will look like when you create a new file. It will be prepopulated by whatever you type here. You can make use of the variables below (the ID following the pattern you have selected in the Zettelkasten-tab, year, month, day, hour, minute and second). If you tick the checkbox, Zettlr will not even ask you for a filename when you create a new file, which might speed up your workflow. +The “pattern for new filenames” is what the textfield will look like when you create a new file. It will be prepopulated by whatever you type here. You can make use of the variables below (the ID following the pattern you have selected in the Zettelkasten tab, year, month, day, hour, minute and second). If you tick the checkbox, Zettlr will not even ask you for a filename when you create a new file, which might speed up your workflow. -The **pandoc- and xelatex-text fields** are used in case Zettlr is unable to locate any of these two programs. As you know, Zettlr uses both to export your files. In rare cases it may be that Zettlr is unable to find them, although you installed them properly. If that happens, simply enter the **full, absolute path** to both programs in the textfields to help Zettlr find them. +The **pandoc and xelatex text fields** are used in case Zettlr is unable to locate any of these two programs. As you know, Zettlr uses both to export your files. In rare cases, it may be that Zettlr is unable to find them, although you installed them properly. If that happens, simply enter the **full, absolute path** to both programs in the textfields to help Zettlr find them. The **debug option** is used to control whether or not you are able to "reload" the graphical user interface (GUI) by pressing `F5` and display the Chrome developer tools to inspect what the app is doing. Naturally, you would want to do this as a developer. -You can also help Zettlr by **subscribing to beta releases**. When you tick this option, Zettlr will notify you about new beta releases as well. You can then decide whether to use the beta version, or not. Activate **RMarkdown file support** to enable the detection of `.rmd`-files used for R-Markdown. It is inactive by default, as some other programs (for instance, by Adobe) also use this extension to store binary data, which would cause problems. +You can also help Zettlr by **subscribing to beta releases**. When you tick this option, Zettlr will notify you about new beta releases in addition to normal releases. You can then decide whether to use the beta version, or not. Activate **RMarkdown file support** to enable the detection of `.rmd` files used for R-Markdown. It is inactive by default, as some other programs (for instance, by Adobe) also use this extension to store binary data, which would cause problems. The text area to the right controls what files will be displayed in the **attachment** sidebar. It is simply a comma-separated list of all file extensions you would like to have at your disposal. The initial list should contain most extensions you might be using. @@ -176,13 +176,13 @@ The **Pandoc command** gives you full control over the export engine. The comman - `$tocdepth$`: A flag indicating the level up to which a table of contents should be generated. - `$tpl$`: A template directive for pandoc. -> **Attention**: Many of these variables are tailored to the needs of pandoc. Of course, you can completely switch the program by replacing `pandoc` with the name of your desired exporting engine, but please beware that it will need to know how to parse pandoc flags. +> **Attention**: Many of these variables are tailored to the needs of Pandoc. Of course, you can completely switch the program by replacing `pandoc` with the name of your desired exporting engine, but please beware that it will need to know how to parse Pandoc flags. ## PDF Preferences ![The Font tab of the PDF Settings dialog](../img/pdf_settings_font.png) -We've moved the PDF Preferences to another dialog because there are many you can use. These options control how the LaTeX-engine will render your files on PDF-exporting. They do not have any effect on all other export formats. You can bring up the dialog using either its shortcut `Cmd/Ctrl+Alt+,` or using the respective menu entry. The PDF options are also divided by tabs. Currently, there are three: +We've moved the PDF Preferences to another dialog because there are many you can use. These options control how the LaTeX engine will render your files when exporting to PDF. They do not have any effect on all other export formats. You can bring up the dialog using either its shortcut `Cmd/Ctrl+Alt+,` or using the respective menu entry. The PDF options are also divided by tabs. Currently, there are three: * Metadata: This controls the metadata field of PDF files. * Page: Adjust the layout of pages using this tab. @@ -198,9 +198,9 @@ In this tab you can control the layout of the page. These options work just as y ### Font -Here you can control how the font is displayed. The main font is the font used for all text. The LaTeX-engine will fetch this directly, so the name you type here must match exactly a font installed on your computer. **If the LaTeX-engine is unable to locate the font, it will spit out an error. To know whether you've encountered such an error or another error that does not relate to the font, simply search for the font name you typed here in the error message. If your font name appears, there is a high chance that the font is called differently. Then please open your operating system's font preferences and check the name.** +Here you can control how the font is displayed. The main font is the font used for all text. The LaTeX engine will fetch this directly, so the name you type here must match exactly a font installed on your computer. **If the LaTeX engine is unable to locate the font, it will spit out an error. To know whether you've encountered such an error or another error that does not relate to the font, simply search for the font name you typed here in the error message. If your font name appears, there is a high chance that the font is called differently. Then please open your operating system's font preferences and check the name.** -The font-size should be rather obvious. The line height specifies the spacing between lines (this only applies to paragraphs). For instance a line height of 150 percent would create a space of half a line between the lines (i.e. each line is followed by a space 50 percent of a normal line height before the next line begins). +The font size should be rather obvious. The line height specifies the spacing between lines (this only applies to paragraphs). For instance a line height of 150 percent would create a space of half a line between the lines (i.e., each line is followed by a space 50 percent of a normal line height before the next line begins). ## Manage Tags @@ -208,6 +208,6 @@ The font-size should be rather obvious. The line height specifies the spacing be The tags dialog does not have a shortcut associated, so you'll need to call it using the respective menu item. Here you can assign colours and descriptions to tags. -To add a new tag-colour-relationship, simply press the `+`-button at the bottom of the dialog. In the first field, enter your tag without the preceding hashtag symbol (e.g. if you wanted to assign a colour to the hashtag `#todo`, simply enter `todo`). Next, choose a colour to be assigned to that tag. If you click the second bar after the tag name field, a color picker should appear that lets you choose a colour. In the third field, you can enter a short description for that tag. This description will be shown if you hover over the tag symbols in the file list. +To add a new tag-colour-relationship, simply press the `+` button at the bottom of the dialog. In the first field, enter your tag without the preceding hashtag symbol (e.g., if you wanted to assign a colour to the hashtag `#todo`, simply enter `todo`). Next, choose a colour to be assigned to that tag. If you click the second bar after the tag name field, a color picker should appear that lets you choose a colour. In the third field, you can enter a short description for that tag. This description will be shown if you hover over the tag symbols in the file list. -If you want to remove a tag-colour-association, simply click the `-`-button at the end of such a tagline (pun intended). +If you want to remove a tag-colour-association, simply click the `-` button at the end of such a tagline (pun intended). diff --git a/docs/en/reference/spell-checking.md b/docs/en/reference/spell-checking.md index 1a85c065..758684ff 100755 --- a/docs/en/reference/spell-checking.md +++ b/docs/en/reference/spell-checking.md @@ -4,7 +4,7 @@ As with all modern writing app, Zettlr features a powerful spell checking engine ## Activate spell checking -To activate spell checking, open the preferences using either the menu item, the toolbar button or pressing `Cmd/Ctrl+,`. In the Editor tab, you can then select all dictionaries you would like to activate. To the left there is a list displaying all available dictionaries. Click one to move it to the right, where green ribbons indicate all active dictionaries. Click one of these green ribbons to deactivate the dictionary again. +To activate spell checking, open Preferences using either the menu item, the toolbar button or pressing `Cmd/Ctrl+,`. In the Spellchecking tab, you can then select all dictionaries you would like to activate. Yuo can activate/deactivate a dictionary using the toggle switch next to its name. You can filter the list of available dictionaries by typing a search key into the upper text field. Zettlr will automatically hide all dictionaries whose name does not contain your search string. Remove any letters from the search field to display all dictionaries again. @@ -12,7 +12,7 @@ After saving the settings with your new spell checking configuration, Zettlr wil ## Deactivate spell checking -To deactivate spell checking again, simply remove all active dictionaries by clicking all green ribbons on the right side of the Editor tab in the preferences window. If there are none activated, Zettlr won't attempt to perform spell checking on your texts. +To deactivate spell checking again, simply deactivate all dictionaries via their toggle swtiches. If there are no dictionaries are activated, Zettlr won't attempt to perform spell checking on your texts. ## Custom Dictionary @@ -20,14 +20,14 @@ From version `1.3.0` onward, Zettlr supports adding certain words to your user d ## Add new Dictionaries -While Zettlr ships with several dictionaries on install, you may want to add new dictionaries for languages that you write in. To add such dictionaries, you'll need to search for hunspell-compatible dictionaries. Basically, these consist of folders containing two files -- a `.dic`-file and an `.aff`-file. The `.dic`-file contains all words in a language with so-called affixes, e.g. small flags that tell the algorithm that a certain word, for instance, may also feature a different ending (take for instance the word ending -- while the stem is "end", there may be both the words "ends", and "ending" available in the language -- the affix flag would then indicate "this word can also have the `-ing`-ending!"). The `.aff`-file contains the definitions of these flags. +While Zettlr ships with several dictionaries on install, you may want to add new dictionaries for languages that you write in. To add such dictionaries, you'll need to search for Hunspell compatible dictionaries. Basically, these consist of folders containing two files – a `.dic` file and an `.aff` file. The `.dic` file contains all words in a language with so-called affixes, e.g., small flags that tell the algorithm that a certain word, for instance, may also feature a different ending (take for instance the word "ending" – while the stem is "end", there may be both the words "ends", and "ending" available in the language – the affix flag would then indicate "this word can also have the `-ing` ending!"). The `.aff` file contains the definitions of these flags. -So to add these dictionaries, go online to search for some. A good starting point is [this repository by the GitHub user wooorm](https://github.com/wooorm/dictionaries), which features a lot of languages. Simply download one of the folders to your computer. Then, in Zettlr, click File -> "Import Dictionary …". This will open up your computer's file browser with the `dict`-folder in Zettlr open. Copy the whole dictionary folder that you just downloaded into the `dict`-folder. Then you can select this dictionary from the settings. +So to add these dictionaries, go online to search for some. A good starting point is [this repository by the GitHub user wooorm](https://github.com/wooorm/dictionaries), which features a lot of languages. Simply download one of the folders to your computer. Then, in Zettlr, click File -> "Import Dictionary …". This will open up your computer's file browser with the `dict` folder in Zettlr open. Copy the whole dictionary folder that you just downloaded into the `dict` folder. Then you can select this dictionary from the settings. Bear in mind that Zettlr will perform some basic tests to determine whether or not a dictionary is valid. To have Zettlr display the dictionary and being able to select it, the dictionary must follow the following rules: -1. The folder containing the `.dic`- and `.aff`-files must be named using the corresponding [BCP-47 tag](https://tools.ietf.org/html/bcp47) of the language the dictionary contains. Although you may not be aware of the term "BCP-47", it's simply the common language tag, so for instance a German dictionary would be named `de-DE` (for German German) or `de-CH` (for Swiss German), or simply `it` (for Italian). A complete [list of all available languages can be found here](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). -2. Inside this folder, at least two files must be present: a `.dic`-file and a `.aff`-file. These must be named either using the BCP-47 tag of the folder, or `index.dic`/`index.aff`. +1. The folder containing the `.dic` and `.aff` files must be named using the corresponding [BCP-47 tag](https://tools.ietf.org/html/bcp47) of the language the dictionary contains. Although you may not be aware of the term "BCP-47", it's simply the common language tag, so for instance, a German dictionary would be named `de-DE` (for German German) or `de-CH` (for Swiss German), or simply `it` (for Italian). A complete [list of all available languages can be found here](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). +2. Inside this folder, at least two files must be present: a `.dic` file and an `.aff` file. These must be named either using the BCP-47 tag of the folder, or `index.dic`/`index.aff`. 3. The dictionary folder may contain other files (such as a list of authors, or a LICENSE). These will be ignored. To sum up, Zettlr will make sure a dictionary is valid by checking that the following paths exist: @@ -35,4 +35,4 @@ To sum up, Zettlr will make sure a dictionary is valid by checking that the foll - `bcp-47/bcp-47.dic` and `bcp-47/bcp-47.aff` _or_ - `bcp-47/index.dic` and `bcp-47/index.aff` -> Attention: The hunspell algorithms implemented in JavaScript are still not as powerful as the main algorithm used by LibreOffice, so it may very well be that some dictionaries simply prove to be too large to be loaded. If Zettlr hangs after loading a dictionary, simply force-quit the app and make sure the dictionary is deselected. \ No newline at end of file +> Attention: The Hunspell algorithms implemented in JavaScript are still not as powerful as the main algorithm used by LibreOffice, so it may very well be that some dictionaries simply prove to be too large to be loaded. If Zettlr hangs after loading a dictionary, simply force-quit the app and make sure the dictionary is deselected. \ No newline at end of file