Skip to content

Commit

Permalink
Update english documentation for 1.7
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanlesage committed Jul 8, 2020
1 parent f2f04ce commit 9a1228b
Show file tree
Hide file tree
Showing 36 changed files with 310 additions and 635 deletions.
46 changes: 29 additions & 17 deletions assets/app.css
Original file line number Diff line number Diff line change
@@ -1,31 +1,39 @@
/* Override directives for readthedocs */

/*
* General branding: Let's use the Zettlr green instead of the default blue

/**
* Branding: Zettlr green: #1cb27e
* Shade color (darker green): #127e58
*/

.section a {
text-decoration: underline;
color: #404040;
/* Main section links */
section.wy-nav-content-wrap a {
color: #1cb27e;
}
section.wy-nav-content-wrap a { color: black;}/*rgb(28, 178, 126); }*/
nav.wy-nav-top a, nav.my-nav-top a:active { color: white; }
.wy-side-nav-search a, .wy-side-nav-search a:visited { color: white; }

section.wy-nav-content-wrap a:hover {
color: rgb(28, 178, 126);
text-decoration: underline;
color: #127e58;
}

nav.wy-nav-top a,
nav.my-nav-top a:active {
color: white;
}

.wy-side-nav-search a,
.wy-side-nav-search a:visited {
color: white;
}

/*
* Blockquotes are "misused" as info blocks
*/
div[role="main"] blockquote {
color: white;
border: 1px solid #4f6e4f;
color: #ffffff;
border: 1px solid #127e58;
border-radius: 5px;
padding: 10px;
background-color: #80b480;
background-color: #1cb27e;
position: relative;
padding-left: 30px;
}
Expand All @@ -39,7 +47,7 @@ div[role="main"] blockquote::before {
position: absolute;
top: 10px;
left: 10px;
color: #4f6e4f;
color: #127e58;
font-style: normal;
content: "\f05a";
}
Expand All @@ -53,12 +61,16 @@ div[role="main"] blockquote p { margin-bottom: 0px; }
/*
* Links in these boxes should have different colours.
*/
div[role="main"] blockquote a { color: rgb(87, 87, 87); }
div[role="main"] blockquote a:hover {
color: rgb(87, 87, 87);
div[role="main"] blockquote a {
color: #ffffff;
text-decoration: underline;
}

div[role="main"] blockquote a:hover {
color: #ffffff;
text-decoration: none;
}

/*
* Mobile ready navbar
*/
Expand Down
20 changes: 15 additions & 5 deletions config/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,33 @@ extra_css:
- assets/app.css
nav:
- Welcome: index.md
- Setup: install.md
- Quick Start: 5-minutes.md
- First Steps:
- Setup: install.md
- Installing Pandoc: installing-pandoc.md
- Installing LaTeX: installing-latex.md
- Getting Started: get-started.md
- Get involved: get-involved.md
- FAQ: faq.md
- Concepts:
- File management: concepts/roots.md
- Context: concepts/context.md
- WYSIWYM: concepts/wysiwym.md
- Guides:
- Zettlr as a note taking app: guides/guide-notes.md
- Zettlr as a Zettelkasten: guides/guide-zettelkasten.md
- Zettlr as an IDE: guides/guide-ide.md
- Core:
- The Editor: core/editor.md
- Document Tabs: core/tabs.md
- The File List: core/file-list.md
- AutoCorrect and MagicQuotes: core/autocorrect.md
- Searching: core/search.md
- Importing: core/import.md
- Exporting: core/export.md
- Table Editor: core/tables.md
- Custom CSS: core/custom-css.md
- Localisation: core/localisation.md
- Attachment Sidebar: core/attachments.md
- Sidebar: core/attachments.md
- Academic Tools:
- Citations: academic/citations.md
- Projects: academic/projects.md
Expand All @@ -41,8 +53,6 @@ nav:
- Markdown Basics: reference/markdown-basics.md
- Settings: reference/settings.md
- Spell Checking: reference/spell-checking.md
- Get involved: get-involved.md
- FAQ: faq.md
theme:
name: readthedocs
custom_dir: ../theme_override
Expand Down
69 changes: 0 additions & 69 deletions docs/en/5-minutes.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/en/academic/citations.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
# Citing with Zettlr

Starting with version `1.0.0`, it's possible to cite sources directly using Zettlr. This feature makes writing academic papers a lot easier than in the past, because you don't need to circumvent the Zettlr export function to actually cite academic papers anymore!

Citing in Zettlr is done using `citeproc-js`, a library that works exactly like, for instance, pandoc's citeproc-engine, or Zotero. So what you will be seeing in Zettlr matches what Zotero's Word or LibreOffice plugins generate. Zettlr's citation engine is composed of three components: A CSL JSON or BibTex library which contains all items that can be cited, optionally a CSL Stylesheet which can alter Zettlr's default citation style (which is the [American Psychological Association's 6th edition](https://www.apastyle.org/manual/index), short: APA), and a preview engine. This guide will help you enable citations and produce beautifully looking files (not just PDF!) that contain correct and consistent citations.

> Beginning from `1.3.0`, you can also use BibTex libraries to cite.
## Enabling Citations in Zettlr

There are two different engines that belong to the realm of citing: the previews (citations can be previewed just as images or links) and the actual process of generating citations (which happens only on export). Both of these functions are triggered by selecting a citation library that contains references. Without such a library, Zettlr will still "preview" citations (so that you can see what will trigger pandoc's citeproc), but Zettlr won't replace the citation's contents with a generated citation. Also, if you do not specify such a library, Zettlr will _not_ run Pandoc with its citeproc-engine, and therefore will not parse the citations.
Expand Down
4 changes: 3 additions & 1 deletion docs/en/academic/pomodoro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ The **yellow** number indicates the duration of a _short_ break that will divide

The **green** number tells Zettlr, how long a _long_ break should be. After every four tasks, there will be such a long break. The default duration is 20 minutes.

Below, you can decide whether or not a sound should be played each time a phase has ended. The slider below the checkbox adjusts the volume. (_Attention_: This is not your system volume, so if your system's volume is only at 20 percent, even a volume of 100 percent inside Zettlr will only sound as loud as 20 percent!)
Below, you can decide whether or not a sound should be played each time a phase has ended. Adjust the volume with the slider (0 % means the sound will be muted).

> This is not your system volume, so if your system's volume is only at 20 percent, even a volume of 100 percent inside Zettlr will only sound as loud as 20 percent.
Click on **Start** to begin the timer. Then, the circle will be filled with the color of the current phase (either red, yellow, or green). Once it is full, the next phase will begin.

Expand Down
6 changes: 2 additions & 4 deletions docs/en/academic/presentations.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# Presentations

Since version `0.19.0`, Zettlr is able to export your Markdown files directly as presentation files using the [reveal.js](https://revealjs.com/#/)-framework. `reveal.js` is a lightweight solution for creating super compatible presentations using plain `HTML` and `JavaScript`. Therefore, these presentations can be shown on _all_ computers that run a browser — nowadays this means: they run on _every_ computer.
Zettlr is able to export your Markdown files directly as presentation files using the [reveal.js](https://revealjs.com/#/)-framework. `reveal.js` is a lightweight solution for creating presentations using plain HTML and JavaScript. Therefore, these presentations can be shown on _all_ computers that run a browser — nowadays this means: they run on _every_ computer.

For exporting Markdown files to `reveal.js`, you have to make sure Pandoc is installed on your computer. Head over to the [section on exporting](../core/export.md) to see how to install pandoc.

If you first want to be impressed by an actual export from Zettlr into `reveal.js`, please have a look [at the demonstration presentation](https://zettlr.com/slides.revealjs.htm)! You can also read [the source file](https://www.zettlr.com/themes/zettlr/assets/slides.md) while following the instructions on this page.
For exporting Markdown files to `reveal.js`, you have to make sure Pandoc is installed on your computer. Head over to the [Pandoc setup guide](../installing-pandoc.md) to see how to install pandoc.

## Pre-considerations

Expand Down
4 changes: 2 additions & 2 deletions docs/en/academic/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To build a project, Zettlr will follow the steps described below to generate you

First, Zettlr will take the project directory and crunch the whole contents into a one-dimensional array. This means that **all subfolders and all files in it will be flattened down into a simple list.** What does that mean? Simply have a look at the file list. Internally, before exporting your files, Zettlr will arrange the files _exactly_ as in the preview pane. Therefore, if you check out your preview list, you will know exactly which file will come after which. This is by design so you don't have a nightmarish discovery once you've handed in a paper and realise a full folder with three chapters has been left out.

> Please note that Zettlr will use _all_ subdirectories! This is meant as a convenience for people writing huge projects that they can use as many subdirectories as they want. Therefore, the preview list will be exactly exported as is (all directories will simply be omitted). So please do not create a second level subdirectory, crunch your notes in it and then wonder how your notes got into the final manuscript. If you want to use additional files that shouldn't be exported, simply create two more folders inside your project directory. In one you can then put all your working files, while you can convert the other into the project that can be exported.
> Please note that Zettlr will use _all_ subdirectories. This is meant as a convenience for people writing huge projects that they can use as many subdirectories as they want. Therefore, the preview list will be exactly exported as is (all directories will simply be omitted). So please do not create a second level subdirectory, crunch your notes in it and then wonder how your notes got into the final manuscript. If you want to use additional files that shouldn't be exported, simply create two more folders inside your project directory. In one you can then put all your working files, while you can convert the other into the project that can be exported.
After your files have been read, a small number of modifications to them is being made (all paths are normalised so that Pandoc and LaTeX may find all your images) before they are concatenated together. Then this huge file is written to disk into a temporary file.

Expand All @@ -47,4 +47,4 @@ Once your project has been exported, it is automatically opened with your defaul
## Removing Projects

To remove a project, simply right click it and choose to remove the project. What will be removed is plain and simple the settings file that indicates that your directory should be treated as a project (called `.ztr-project`). Therefore, if you remove a project, you actually only remove the settings of the project. If you re-create the project, the file will be present once again, but with the default settings. So remember, removing projects will finally delete your settings and you have to set them anew.
To remove a project, simply right click it and choose to remove the project. What will be removed is plain and simple the settings file that indicates that your directory should be treated as a project (called `.ztr-project`). Therefore, if you remove a project, you actually only remove the settings of the project. If you re-create the project, the file will be present once again, but with the default settings. So remember, removing projects will finally delete your settings and you have to set them anew.
4 changes: 2 additions & 2 deletions docs/en/academic/zkn-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Zettlr will automatically try to find an ID for a file by searching through its

Once the problem of Identification was solved, another occurred: How to link files across the app without jeopardising the above-mentioned aims of Zettlr to make files application-independent? Many apps, such as nvALT or The Archive implement an internal linking system that makes it possible to reference files from each other to make navigation through the system as easy as possible. Zettlr also includes such a system.

An internal link is written with the syntax of `[[This is the link]]`. If you `Alt`- or `Ctrl`-click a link, it will trigger **two** distinct functions. First, it will try to find an exact match of the link's contents in the app. This means that it tries to find a file that reports that the content perfectly matches it. Such an exact match can be found in two ways: First, if the contents of the link (in the above example "This is the link") **exactly** matches a filename, excluding its extension, the appropriate file will report that it is indeed an exact match. The above example would exactly match the files `This is the link.md`, `This is the link.markdown` and `This is the link.txt`. Note that the filename matching is done **case-insensitive**. macOS for instance is by default case insensitive (so `filename.md` would match the same file as `FILENAME.MD`). The second way that such a link may yield an exact match would be if the link's contents contain an ID in the format `[[<your-id>]]`. If any file has the ID `<your-id>`, Zettlr will also yield an exact match. **If an exact match is found somewhere in the system, an Alt-Click on an internal link will immediately open the first matched file**. This means that you can use such links to navigate through your system. You could, for example, accommodate this by creating index files that contain internal links to several files, and in each file, place a link that back-links to the respective index file.
An internal link is written with the syntax of `[[This is the link]]`. If you `Cmd`- or `Ctrl`-click a link, it will trigger **two** distinct functions. First, it will try to find an exact match of the link's contents in the app. This means that it tries to find a file that reports that the content perfectly matches it. Such an exact match can be found in two ways: First, if the contents of the link (in the above example "This is the link") **exactly** matches a filename, excluding its extension, the appropriate file will report that it is indeed an exact match. The above example would exactly match the files `This is the link.md`, `This is the link.markdown` and `This is the link.txt`. Note that the filename matching is done **case-insensitive**. macOS for instance is by default case insensitive (so `filename.md` would match the same file as `FILENAME.MD`). The second way that such a link may yield an exact match would be if the link's contents contain an ID in the format `[[<your-id>]]`. If any file has the ID `<your-id>`, Zettlr will also yield an exact match. **If an exact match is found somewhere in the system, an Alt-Click on an internal link will immediately open the first matched file**. This means that you can use such links to navigate through your system. You could, for example, accommodate this by creating index files that contain internal links to several files, and in each file, place a link that back-links to the respective index file.

The second function triggered by such a link is a global search inside your currently selected directory. It will merely take the link contents, place it in your search field and automatically "press Enter", to initiate the search. This way you can not only open exact files, but also find all other files that link to the file you just opened. So a link in the format `[[<your-id>]]` would open that specific file and also search for all files that link back to this file.

### Tagging

Tagging may be the easiest form of internal searching. If you `Alt`- or `Ctrl`-Click on a tag, this will simply render a search for all files in your current directory that are tagged with this tag. As tags in the form `#keyword` are not used anywhere in the markdown syntax, using this approach enables Zettlr to use such tags as the perfect means to create a tagging system.
Tagging may be the easiest form of internal searching. If you `Cmd`- or `Ctrl`-Click on a tag, this will simply render a search for all files in your current directory that are tagged with this tag. As tags in the form `#keyword` are not used anywhere in the markdown syntax, using this approach enables Zettlr to use such tags as the perfect means to create a tagging system.
Loading

0 comments on commit 9a1228b

Please sign in to comment.