Skip to content

Commit

Permalink
Proofread Reference section
Browse files Browse the repository at this point in the history
Significant changes in spell-checking.md
  • Loading branch information
canpolat committed Jul 11, 2020
1 parent 742a99a commit 6a9b0c4
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 50 deletions.
14 changes: 7 additions & 7 deletions docs/en/reference/keyboard-shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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).
Expand All @@ -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.
Expand All @@ -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.

Expand Down
24 changes: 12 additions & 12 deletions docs/en/reference/markdown-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 codethey 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 useeven 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:

Expand All @@ -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

Expand All @@ -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
Expand All @@ -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 orderas 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.

Expand Down Expand Up @@ -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/).
Loading

0 comments on commit 6a9b0c4

Please sign in to comment.