Skip to content

Commit

Permalink
Proofread 'Core' section
Browse files Browse the repository at this point in the history
  • Loading branch information
canpolat committed Jul 11, 2020
1 parent ccf3cda commit afc4f7f
Show file tree
Hide file tree
Showing 10 changed files with 44 additions and 43 deletions.
4 changes: 2 additions & 2 deletions docs/en/core/autocorrect.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions docs/en/core/custom-css.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

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

Expand Down Expand Up @@ -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 {
Expand Down
20 changes: 10 additions & 10 deletions docs/en/core/editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 …

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

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

Expand All @@ -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.
4 changes: 2 additions & 2 deletions docs/en/core/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading

0 comments on commit afc4f7f

Please sign in to comment.