zettlr/zettlr-docs

This repository holds the official documentation of Zettlr

Zettlr Documentation

This repository holds the official documentation for the Zettlr markdown app. It is hosted publicly on GitHub to give you the chance to easily submit modifications and help the Zettlr documentation stay comprehensive even for new users who need a hand in getting to grips with Zettlr.

Contributions from the Community are encouraged! If you spot typos, wrong or outdated information, or have other good input to improve the documentation, we appreciate all your ideas.

How it Works

The whole documentation is written in Markdown. Therefore, to contribute you only need to know a little bit of Markdown! Simply browse the documentation, and click the "Edit on GitHub" button on the page you want to edit. Then, simply modify the page contents and create a pull request.

For advanced editing, here's the list of steps for contributing to the documentation:

1. Fork this repository.
2. Modify the Markdown source files, and other files as necessary.
3. Commit them and then open a Pull Request.

As soon as we run a new build, your changes will automatically be included and are available at https://docs.zettlr.com/.

New Pages and Changes to the Structure

New pages in our documentation will require some structural adjustments, which you need to discuss beforehand. If you have an idea on how to structure the documentation, please start a thread in the discussions tab of the main repository or join the discord server.

The Structure

These docs are multi-language. Inside the docs-subdirectory, you'll find all languages inside ISO-coded directories. Inside these, you will find one assets-folder, which contains a symbolic link to the top-level assets's app.css-file. The rest of the files are independent and unique for each language.

You can create a resources directory on the root level to store additional files that you may need, as the .gitignore file will not commit this directory.

Testing and Building

To locally test how your changes work out, you'll need to install MkDocs. MkDocs is a comprehensive library that allows for easy building of whole documentations. Please follow the instructions by the creators of MkDocs on how to set up the software on your computer.

Most of the default commands won't work with our setup, so please use the custom scripts:

serve.sh

The serve.sh-script serves a specific language for testing. Simply run:

$ ./scripts/serve.sh en

and replace "en" with an existing language code to spin up the development server. If you omit this, it will simply spin up the English language server.

build.sh

The build.sh-scripts builds the full documentation. Simply run it. It will scan the docs-directory and run the corresponding .yml-configuration file located in the config-directory.

Create More Languages

Want to add a language? Perfect, here's how you do it:

1. Copy any of the configuration files in ./config. Rename it to the corresponding ISO-code (e.g. es for Spanish, fr for French, and so on).
2. Create a new directory corresponding to the same ISO-code in ./docs.
3. Inside this directory, create an assets-subdirectory and create a symbolic link to the ./assets/app.css-CSS file. This is important so that changes to the master file are propagated to all languages, keeping it DRY.
4. Head to the ./assets/index.html-file and add your language to the bottom (simply copy one of the existing list items, the changes necessary should be self-explanatory).
5. Add your documentation and adapt the ./config/<code>.yml-configuration file as appropriate.
6. Commit via PR.

License

This documentation is licensed via the GNU GPL v3 license.

zettlr-docs's Issues

old documentation links are still active.

I happen to search zettlr documentation through google, and landed on this page
Virtual Directories

It took me a lot of time and reading through version histories and pull requests to figure out that it has been removed. Further going down, there are several confusing versions of the documentation that pops up in google search. All of them are pointing to different non-existent md file, in github like this,
Core > File List

So there is some screw up happened in maintaining them. I'm not that good at coding so I could not figure out what went wrong.

Flatpak related things

1.: The documentation has some spelling mistakes where "flatpak" is spelled "flatpack".
2.: In the german Documentation, the flatpak installation method is not mentioned.

Footnotes as files --- text for docs, "editor/working with footnotes"

The standard method for making footnotes places them at the end of the current file. To reuse the same footnote for other projects, and/or as part the Zettelkasten, creating a note-file uses the Zettlr Projects method to compile and typeset the document.

An auto-generated footnote number may easily be misidentified; it is important to always use unique references; [^unique-name]. Because Zettlr Projects processes files in the order they appear in the directory side-bar the note-file must appear last in the side-bar replacing ^ with a low-order prefix, e.g. “zunique-name.md”.

A simple example: A footnote quote from a book, ‘Robert Jones Esoteric Studies (1976)’ using initials[^JRes1976p.1] and when more than one quote starts on the same page append ‘a’ or ‘b’ . Other types of notes might be given a series number [^zn0001] or a Zettlr ID.

Using a YAML header containing title: ‘description’will show a description in the side-bar without changing its list position. Include anid: ‘zettlr-id’ and the Zettlr ID will appear beneath the description. Numbers appear before letters, do not use numeric Zettlr IDs; the note’s filename must have a low-order prefix.

Comments are another way to hide extraneous data, here a quote from a letter is referenced <!-- [[20201028210747]] zEF2MF1893p.191a.md -->. To open the file, from either a comment or the YAML header, copy the Zettlr ID to ‘Find’ menu-box.

[CALL FOR CONTRIBUTIONS] Documentation updates for Zettlr 1.7

As I've outlined on a lengthy post on reddit, I thought the upcoming 1.7 release of Zettlr would be a great opportunity to bring the documentation up to date. This will reduce the workload for further additions (because we know the documentation is up to date, this'll help our motivation in then keeping it updated further!) and also would be a nice thing to have, as the documentation becomes more and more necessary with each feature. But, as u/enabeh rightly pointed out, I didn't specify how this effort should be facilitated. So here we go!

In any case, a GitHub account is required, as this is the most time-efficient variant for all of us, so if you don't have one, you can easily create one for free!

I want to help — where to start?

First, thank you for wanting to help out! To get started, the best thing is to think about what you'd like to contribute:

1. Skim through all pages in a certain language, and fix typos and grammar
2. Take one page and fully re-write it, removing outdated parts and adding missing ones
3. Add a completely new language (big shoutout on Twitter guaranteed for this!)
4. Create a new page for a missing feature (or take a feature that's grown too big out of an existing page and make a new one)
5. Localize the screenshots

For each points, read the respective headings!

1. Skim through a documentation

This is probably the easiest way to contribute (albeit possibly not the most exciting). Nevertheless, chances are that you'll learn something new, and such contributions are also the backbone of any good documentation! To do so, you can either navigate on this repository into one of the language sub-folders (each translation of the documentation resides in its own directory within the docs-subdirectory) and read through all the Markdown files here on GitHub. GitHub renders the Markdown perfectly, so you don't need to read the documentation over at docs.zettlr.com! If you're logged in, you can then directly edit a file by clicking the edit button in the top right of the file.

Then, to save the changes, you should "commit" them and open a new Pull Request — then I'll see your PR and will merge it asap so that your changes are visible on the documentation!

You can also go over to the online documentation, and, as soon as you spot something, you can also click on "Edit on GitHub" to directly edit the file, if that suits you more!

2. Re-Write a page

Rewriting a page basically works like point 1, but in this case, it would be awesome if you could announce that by commenting here (e.g. "I'm going to re-write the section on Custom CSS completely!") — this way, all other contributors will know that they can leave out that page until you announce here that your PR has been merged by me, so that other people can double-check for typos!

3. Add a new language

Adding a new language probably is the most time-consuming process, but it'll help make the documentation more inclusive, because not everybody speaks English, and this will certainly help more people to use the app productively. You can have a look over at https://translate.zettlr.com to see what languages are available for Zettlr, but you can also translate it in any other language that you're proficient in — it's up to you!

The process of how to add a new translation is outlined in the README of this repository, but as long as you create a new language sub-directory and translate the English files accordingly, I can modify your PR in case you forget something — don't be afraid to break things, because nothing you could do is unfixable, and the value of your contents outweighs any additional work I might have with it :)

4. Add a new page

This could prove useful — I haven't updated the file structure in a long time and there might be quite some instances where a new page would definitely make sense. In that case, just create a new file in the corresponding folder (maybe even a new one? In case of questions, feel free to discuss them here first!) and make sure to link it in the corresponding config file (where the navigation is created). You can also link the new file in other pages, depending on where it makes sense. The way these links work is exactly like you would create them in Zettlr, using relative paths.

5. Localize the screenshots

Maybe you've noticed that all screenshots are in English, which is because I just screengrabbed them, and placed them in the docs. However, it would be awesome to have a look at them and localize them (they're in the img subdirectory of each single translation) by simply taking the same screenshot, but with the correct localization, and simply exchange the corresponding file. And if you add new ones, please! Especially the 5-minutes-quickstart guide could certainly use a refreshment!

---

Useful Stuff

Blockquotes are used to indicate info-boxes, that is: To add some info, you can write > **Note**: Some note -- many pages make use of this, so just read through some to get to know how it'll look!

Further, make sure to use appropriate heading levels all across the documentation, because this way MkDocs (which we use to build the documentation) can generate text anchors so that we can help other people by sharing links not only to the correct file, but even to the correct heading!

Further Questions?

Just ask away!

And thanks of course for your help! :)

The description of "Enable Table Editor" is missing

In the explanation of the Editor tab, "Enable Table Editor" is missing.

https://docs.zettlr.com/en/reference/settings/#editor

Bug on hiding toolbar in distraction free mode.

Thank a lot for your work. Zettlr is amazing.

I want to hide toolbar in distraction free mode like describe in https://docs.zettlr.com/en/core/custom-css/#hide-the-toolbar-in-distraction-free . But I don’t know why, the code don’t works. However, the code to change the font works.

I am on Linux Mint 19 and zettlr 2.0.1.

Could you help me, please ?

Best regards
Lilian

zettlr's performance need to improve

I recorded a video to show the time zettlr used to open the UI window, to parse the history folders, and to render the tabs last time edited.
And I found that zettlr's performance maybe need to improve.

2023-06-05.11-24-10.1.webm

Zettlr costs 30s to launch the window, and 60s to show lasted view tabs, and 60s to render the content of tabs.

I upload a webm video, it not supported on edge now. It plays OK on chrome and firefox.

[ENHANCEMENT] Add documentation how to change header styles

I've been trying to change the size of the headers to the body font size, but I couldn't figure it out. I tried to inspect the elements, but couldn't find the obvious element/id/class. Context: I'm not a web developer, and have done any web development in a long time.

The information would fit as a subsection to Using a Custom Font with Zettlr[0], or a section directly after.

[0] https://docs.zettlr.com/en/core/custom-css/#using-a-custom-font-with-zettlr

Document doesn't respond to scrolling when the mouse is to the left of the document

Hi!

Tiny annoyance here: there is a strip between the left margin of a document and the side bar, which is white, thus not visually separated from the document itself. I often found myself trying to scroll through a document when my cursor was located on that strip without much success. It'd help if I could scroll in that case too or any visual cue about where the document ends on the left side, for example a thin line.

Again, just a small thing, otherwise great app!

spell check

Extract from documentation - "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."

Does it means that i can't use the specific dictionary? Maybe there are some work-around?

BBT citation pattern variables are documented

The zettlr docs state that

There are two undocumented behaviours in BetterBibTex. First, the available variables you can use to generate your own citation IDs. They are only documented in the JabRef documentation, which you can find here. The second behaviour is that BetterBibTex will automatically use letters from a to z to make citations from the same author in the same year unique (e.g. you'll have something like Harvey2005a, Harvey2005b, Harvey2005c, and so forth).

but this is not the case; both the letter-postfix ("a letter postfix (a, b, c, etc) in case of a clash (this part is always added, you can’t disable it, although you can change it to Zotero-style numeric)") and all the pattern fields are documented at https://retorque.re/zotero-better-bibtex/citation-keys/.

Clarifying behaviour of citations in Zettlr vs Pandoc

I was revising the documentation for academic/citations.md and was confused by a point that was made.

In regular Mardown-Pandoc, with an author-date style CSL, [@heroux2020] would render as (Héroux et al. 2020) and @heroux2020 would render as Héroux et al. (2020). However, in the documentation, it is recommended to simply type @ to enter the citation and to enclose the citation in square brackets if there is a need to specify pages or chapters, etc. However, the current default behaviour of Zettlr is as follows:

• I type @
• I get presented with available references
• I select my reference and hit Enter (e.g. @heroux2020)
• The selected reference is automatically encased in square brackets (e.g. [@heroux2020])

Thus, to reference and name the author (e.g. Héroux et al (2020)), the user has to move over the Zettlr-rendered citation and remove the square brackets. This will likely confuse new users.

Based on the documentation, the reference preview provided by Zettlr is primary to ensure the reference has been recognised. It may not render properly, but the exported version created by Pandoc and citeproc will be properly formatted. Thus, I suspect it will not be worthwhile to modify how the citations are rendered in the editor. Rather, the documentation should be corrected to make the current behaviour clear. If the latter option is preferred, I am happy to tackle this and make a pull-request.

please mention possibility of YAML headers

Hi

Could you please add somewhere an explicit mention of YAML frontmatters? I am now using them very often to add title to my individual notes, with a modified tex template, so that the title appears when exporting to pdf.
I found about them by following a long sequence of links. Having them mentionned with a link to the way they can be used in pandoc would be nice.

Thanks.

Error: pandoc-citeproc has been disabled because it is deprecated upstream!

The docs suggest a brew install pandoc-citeproc as a dependency to use Pandoc with Zettlr, however once downloaded, brew throws the following error:
Error: pandoc-citeproc has been disabled because it is deprecated upstream!

Is this dependency necessary? If not, I will make a PR to remove that command from the docs.

"Save" silently fails!!

When I press CTRL-S Zettlr writes to the file system, but it does not always write what is in the editor's buffer. This is a massive problem!

Attached is a screen capture shows:

• I manually add "AAAA" to the start of my "00150-petrenko..." file
• I press CTRL-S, and you can see the timestamp update in file explorer, changing from 2:14 to 2:19
• I also use "File|Save", just to give you a visual indicator. As an aside I'm quite sure that "File|Save" sometimes does NOTHING at all, but CTRL-S always writes the file (although perhaps with the wrong content).
• I open the "saved" file in a text editor, but you can see that the "AAAA" text is missing from the file.

broken-save.mp4

Not in the video, but I then closed Zettlr and silently lost the "AAAA" change.

I had Autosave set to "Immediately", and suspect that this is somehow related. I noticed that after a fresh reboot of Zettlr that the file was being saved almost after every keystroke, which was not the case when I made the video.

Zettlr Version: 3.0.0 (UUID: 6c414122-4a3a-48c7-a6f3-cec55b393258)
System: win32 10.0.19042 (architecture: x64)

... as downloaded from https://www.zettlr.com/download

"Guide: Zettlr as Zettelkasten" / "Step 1"

This section in the docs about "Zettelkasten" is inconsistent and incomplete.

https://docs.zettlr.com/en/guides/guide-zettelkasten/#step-1-adjust-the-settings

Most of the mentioned settings do not exist in the current 1.8.9 release (Debian 11 via AppImage).

Undo breaks checkbox rendering

Description:

When trying out the interactive demo, I used Cmd + Z to undo something I had tried, and going further back it shows the following behaviour:

1. I check the boxes and then uncheck then - work fine
2. I check the boxes, click off and then undo - the boxes disappear - they reappear on redo.

When done with undo it does remove the checkboxes, there is no interaction.

Version: 1.7
OS: OSX 10.15.5, Macbook Pro 15" 2019

Markdown support for Pug and SCSS

Hi!
It would be useful the Markdown support for Pug and SCSS templating modes.

Thanks!

Regards from Lima, Perú.

Active Search avoids saving Files

Hi Zettlr Community,

I'm just about to dive into Zettlr.

Found a anoying behavior, which is possibly unintended: While the search pane is active, it's not possible to save changes in open files.
[Ctrl]+[s] doesn't work as same as the command from file menu doesn't.
No error or warning gets displayed - just nothing happens.

Interessting: closing the edited file leads to a Want-to-save-changes dialog.
Confirming with [Yes] closes the file and saves the changes.

That's all for this time - seeing more to come. ^^

Greetings from GER
Jens

Zettlr Version: 3.0.2 (UUID: cdc66a8c-5b7a-42a0-816c-82b1825b3b47)

System: win32 10.0.19045 (architecture: x64)

Build Dependencies
This build was compiled using
Node.js v18.15.0
Electron v25.9.0
Chrome v114.0.5735.289
v8 engine v11.4.183.29-electron.0
Zlib v1.2.13
OpenSSL v1.1.1

Compress Images with pngquant

Some Images on the Website (like the first one on the Homepage) are quite heavy. It would make sense to reduce the image size with an compressor like pngquant (the size on the mentioned one could be reduced from 2.5 MB to 71 KB)

Create page from an internal link

Would it be possible for Zettlr to be able to create pages from internal links?

I got this idea from Bryan Jenks (https://www.youtube.com/watch?v=zIh1S7ra3aI). Basically, he uses tags as umbrella categories, and [[links]] for the ability to associate ideas/topics with pages that can then be created as "hubs" for those links.

For example, if I do a lot of research into AI, I might make a lot of notes talking about [[ChatGPT]] or [[OpenAI]]. If I do that in a regular note, the page doesn't yet exist. But if I ctrl-click on it, it brings me to the search window. In Obsidian (and Roam, from what I understand), it will create a new page with that name. Then that new page can be used as a hub or page to collect all the information for that topic. The links point to the page and can be followed from any of the notes that [[link]] to it, and the page serves as the hub for the topic, linking to other notes, other websites, etc.

I think this is a really interesting and powerful way to work, especially when combined with the Map Viewer in Obsidian (or in Zettlr). It allows you to see how many pages are linking to a certain topic; at some point, that topic page will need to be created (because with so many links, it must be important to your work/research/studies/etc.

So basically, when I ctrl-click on an [[link]] that doesn't exist, I want Zettlr to create a page with that name instead of bringing up the search. In this case, the file wouldn't need to be named with a ZKID because each of these pages would be a unique topic. Would that be possible?

Thanks very much for your time and any thoughts and feedback.

Why insisting on US spelling?

Given I have every language preference I can find set to en_GB, why does Zettlr insist on using US Spelling checks?

Actual behaviour:

Also, the tiny little box in the bottom-right of second image that says "US" can be clicked to change the language, but the choice doesn't seem to have an effect, doesn't seem to be stored, and likes to revert to "Auto"

Thanks for listening. I hope this helps.

Zettlr Version: 3.0.0 (UUID: 6c414122-4a3a-48c7-a6f3-cec55b393258)

System: win32 10.0.19042 (architecture: x64)

Catalan Translation -Pull Request

Hi everyone,

I discovered Zettlr some months ago, and I was really impressed with the program. Congrats, you are doing a really nice job here! I decided to continue with the Catalan translation of the program, which is already complete (the translation server made things really easy, thanks a lot!). As I really appreciate the documentation, I decided to try tho translate it too (that's a little bit more tricky I have to say, but it worked). Right now the "Welcome" and "First steps" sections are done (and working on my computer!), so I'm thinking to make the (probably minor for you, huge for me) step and make a pull request. Here are some minor issues I'm not quite sure how you deal with it:

0. You make Pull request for partial translations too, isn't it? Or do you recommend to wait until is mature or done? Anything special (hints) I need to know, and it's not in the documentation?
1. The "emoji" Catalan flag (at the end of assets/index.html) appears as a black flag (with Firefox 84.0.1). I took it from here https://emojipedia.org/flag-for-catalonia-esct/ (which also appears as black flag or as a question mark flag). I don't know any easy solution for that except put Catalan without a flag (for me will be ok).
2. I copied from the English version and commented all the entries in config/ca.yml which are not yet translated. This is a way to track what is already done and what needs to be done. Do you normally do the things like this or is there another way?
3. I just made a Symlink to the docs/ca/img folder from the English one. In this way images (in English) will appear, when needed (I don't plan to translate images right now). Is this good? Would it be better to just copy them?
4. Should I add a Message in the welcome page, commenting something like "this is an ongoing translation, check other languages, you can collaborate ..."?
5. How do you coordinate in other languages? Do you use the issue system here or the ones in every fork (or do you use telepathy, or you don't talk at all?)

[Feature Request] Choose PDF reader

In regarding open PDF files: It would be nice to be able to choose in settings between:

• open file in build-in PDF reader (is it even possible?)
• open file in system-default PDF reader
• choose a PDF reader

Thanks in advance :)

[Proposal] Keeping translations up-to-date

The English version of the documentation is changing over time and it is not easy to keep track of all changes that need to be reflected in various translations. Sometimes, the translation is so old that a whole file needs a walk-through, but often, only a couple of sentences change...

I thought it may be useful to have a way to keep track of incremental updates. Probably, there are tools out there to do this easily, but I don't know any of them. So, I wrote a hack-y Powershell script to output the changes in documentation.

The idea is to do some comparisons file by file. For each file, I find the latest commit hashes for the English and translated version (for each language). Then I check if the English version has been updated since that last commit on the translated file. If there is a diff, then I display it as a change, otherwise, I document that there are no changes.

Below is a table showing the diffs for French translation files. Unfortunately, GitHub does not seem to provide a way to compare two versions of a single file, so I included a Git command to see the diff locally. When you issue the Git command, the diff for the English version will be displayed in the configured external diff tool. This way one can see what needs an update.

File	Translated version	English version	?	Git command to get the diff
/core/export.md	48f3bc7	afc4f7f	±	git difftool -y 48f3bc7 afc4f7f -- docs/en/core/export.md
/concepts/roots.md	Not Found	8125fa4	☉	N/A - no existing translation
/faq.md	01d2e71	2d99339	±	git difftool -y 01d2e71 2d99339 -- docs/en/faq.md
/core/file-list.md	8dafd45	afc4f7f	✓	No change between versions
/concepts/wysiwym.md	Not Found	9a1228b	☉	N/A - no existing translation
/core/search.md	48f3bc7	afc4f7f	±	git difftool -y 48f3bc7 afc4f7f -- docs/en/core/search.md
/core/attachments.md	48f3bc7	9a1228b	±	git difftool -y 48f3bc7 9a1228b -- docs/en/core/attachments.md
/core/import.md	c0a6b7a	9a1228b	✓	No change between versions
/core/math.md	6f5d3e8	6f5d3e8	✓	No change between versions
/core/localisation.md	6f5d3e8	afc4f7f	✓	No change between versions
/guides/guide-zettelkasten.md	48f3bc7	ccf3cda	±	git difftool -y 48f3bc7 ccf3cda -- docs/en/guides/guide-zettelkasten.md
/academic/projects.md	48f3bc7	742a99a	±	git difftool -y 48f3bc7 742a99a -- docs/en/academic/projects.md
/reference/keyboard-shortcuts.md	Not Found	6a9b0c4	☉	N/A - no existing translation
/get-involved.md	1116a0d	023e038	±	git difftool -y 1116a0d 023e038 -- docs/en/get-involved.md
/core/custom-css.md	7765a61	afa8763	±	git difftool -y 7765a61 afa8763 -- docs/en/core/custom-css.md
/academic/custom-templates.md	48f3bc7	742a99a	±	git difftool -y 48f3bc7 742a99a -- docs/en/academic/custom-templates.md
/reference/markdown-basics.md	5e64283	6a9b0c4	±	git difftool -y 5e64283 6a9b0c4 -- docs/en/reference/markdown-basics.md
/core/editor.md	6f5d3e8	d3392c9	±	git difftool -y 6f5d3e8 d3392c9 -- docs/en/core/editor.md
/academic/pomodoro.md	48f3bc7	742a99a	±	git difftool -y 48f3bc7 742a99a -- docs/en/academic/pomodoro.md
/reference/spell-checking.md	48f3bc7	6a9b0c4	±	git difftool -y 48f3bc7 6a9b0c4 -- docs/en/reference/spell-checking.md
/installing-latex.md	Not Found	023e038	☉	N/A - no existing translation
/install.md	c3f66d3	023e038	±	git difftool -y c3f66d3 023e038 -- docs/en/install.md
/concepts/context.md	Not Found	9a1228b	☉	N/A - no existing translation
/core/tabs.md	1c3f001	afc4f7f	✓	No change between versions
/index.md	6f5d3e8	616b743	✓	No change between versions
/core/print-preview.md	d8faf21	220162a	✓	No change between versions
/academic/readability.md	48f3bc7	742a99a	±	git difftool -y 48f3bc7 742a99a -- docs/en/academic/readability.md
/installing-pandoc.md	Not Found	023e038	☉	N/A - no existing translation
/core/tables.md	48f3bc7	afc4f7f	±	git difftool -y 48f3bc7 afc4f7f -- docs/en/core/tables.md
/guides/guide-ide.md	7765a61	ccf3cda	±	git difftool -y 7765a61 ccf3cda -- docs/en/guides/guide-ide.md
/reference/settings.md	48f3bc7	6a9b0c4	±	git difftool -y 48f3bc7 6a9b0c4 -- docs/en/reference/settings.md
/academic/presentations.md	48f3bc7	742a99a	±	git difftool -y 48f3bc7 742a99a -- docs/en/academic/presentations.md
/assets/app.css	48f3bc7	33c431f	✓	No change between versions
/core/autocorrect.md	6be9f1f	bd1f1ee	±	git difftool -y 6be9f1f bd1f1ee -- docs/en/core/autocorrect.md
/academic/citations.md	48f3bc7	742a99a	±	git difftool -y 48f3bc7 742a99a -- docs/en/academic/citations.md
/get-started.md	Not Found	c16ce75	☉	N/A - no existing translation
/academic/zkn-method.md	48f3bc7	22d8ba7	±	git difftool -y 48f3bc7 22d8ba7 -- docs/en/academic/zkn-method.md
/core/yaml-frontmatter.md	f205013	19cf428	±	git difftool -y f205013 19cf428 -- docs/en/core/yaml-frontmatter.md
/guides/guide-notes.md	41d6ed7	ccf3cda	±	git difftool -y 41d6ed7 ccf3cda -- docs/en/guides/guide-notes.md

The docs mention "snippets", but now this feature is known as "file information"

For example, following directions on https://docs.zettlr.com/en/guides/guide-notes/ to configure Zettlr, step 1 tells you to turn off "Snippets"

According to the changelog this setting was renamed in 1.3.0 https://github.com/Zettlr/Zettlr/blob/e298734de1d992482dfc0e6c7a63b1631ce25180/CHANGELOG.md#130

This was confusing, and there are other mentions of "snippets" in the docs

Update 1.8.0-1 problems

Trying to make a local update on a Fedora system shows me thiese error messages:

sudo dnf update ./Zettlr-1.8.0-x86_64.rpm
Letzte Prüfung auf abgelaufene Metadaten: vor 2:45:10 am Sa 28 Nov 2020 05:44:58 CET.
Abhängigkeiten sind aufgelöst.
=============================================================================================================================================================================
 Package                                Architecture                           Version                                    Repository                                    Size
=============================================================================================================================================================================
Aktualisieren:
 zettlr                                 x86_64                                 1.8.0-1                                    @commandline                                  63 M

Transaktionsübersicht
=============================================================================================================================================================================
Aktualisieren  1 Paket

Gesamtgröße: 63 M
Ist dies in Ordnung? [j/N]: j
Pakete werden heruntergeladen:
Transaktionsüberprüfung wird ausgeführt
Transaktionsprüfung war erfolgreich.
Transaktion wird getestet
Fehler: Transaktionstest fehlerhaft:
  Datei /usr/lib/.build-id/05/8ff997210dbf35812226cfddcc6a0153403b0c aus der Installation von zettlr-1.8.0-1.x86_64 kollidiert mit der Datei aus dem Paket rocketchat-3.0.7-1.x86_64
  Datei /usr/lib/.build-id/40/4c5b8e93610df54df2ff8d00c57c0c5d747895 aus der Installation von zettlr-1.8.0-1.x86_64 kollidiert mit der Datei aus dem Paket rocketchat-3.0.7-1.x86_64
  Datei /usr/lib/.build-id/4a/8424afcc5d50633140eca2e5a4951fbf369fad aus der Installation von zettlr-1.8.0-1.x86_64 kollidiert mit der Datei aus dem Paket rocketchat-3.0.7-1.x86_64
  Datei /usr/lib/.build-id/57/84a955e496fff7bae3f27c6ec35b6fe0785fe1 aus der Installation von zettlr-1.8.0-1.x86_64 kollidiert mit der Datei aus dem Paket rocketchat-3.0.7-1.x86_64
  Datei /usr/lib/.build-id/81/376033606562c7dec0b49517873b73b53707b8 aus der Installation von zettlr-1.8.0-1.x86_64 kollidiert mit der Datei aus dem Paket rocketchat-3.0.7-1.x86_64
  Datei /usr/lib/.build-id/89/061e81ab30b06a099609996580cecb0ec62492 aus der Installation von zettlr-1.8.0-1.x86_64 kollidiert mit der Datei aus dem Paket rocketchat-3.0.7-1.x86_64
  Datei /usr/lib/.build-id/b8/84b9c74fb300aff58bde097335f593b5091172 aus der Installation von zettlr-1.8.0-1.x86_64 kollidiert mit der Datei aus dem Paket rocketchat-3.0.7-1.x86_64
  Datei /usr/lib/.build-id/d3/0f70aae2bc65a1777132aa828fcbc9959aaf67 aus der Installation von zettlr-1.8.0-1.x86_64 kollidiert mit der Datei aus dem Paket rocketchat-3.0.7-1.x86_64

Link to a file with round brackets in its name is falsely resolved

file: c:\temp\Test(2023).txt

test mit brackets

this will result in an error looking for a link to:
file://C:/temp/Test(2023.txt)
with the closing bracket in the wrong place

Clojure Fenced Code Block Dialect

Hi,

Please can you consider adding Clojure as a fenced code block recongised syntax.

https://codemirror.net/mode/clojure/index.html

Thank you.

-=david=-

Add additional programming language highlighting

Could you kindly add Octave (Matlab)? Thank you.

Add information on migrating Zettlr notes to a new computer or OS-install.

Perhaps this information is there and it's just not labeled clearly, but after perusing and then searching the docs, I can't find any information on what I would need to do to move my Zettlr workspaces and files to a new computer or OS-installation. Obviously, I can copy the folders over and, in the new Zettlr install, load the folders using File > Open Workspace … I'm assuming this is the process, but it's left implicit in the documentation and it seems like a good idea to add assurances that things like file links and other relational information would be preserved. I'm not bothered by Zettlr's lack of mobile or sync functionality, a la Obsidian, but I'd at least like clear instructions on how to take my library of files with me when I permanently move to a new device.

I'd be happy to write the English-language documentation blurb for this if someone is willing to confirm that I have the details right and/or explain the optimal migration process.

Document Tab Behaviour

Until now I haven't had the time to update the docs to document the tab behaviour; if someone wants to do this, it's up for grabs! Otherwise I'll see to possibly adding it next week or so!

Win11 Export Error

When I tried to export the markdown file, the application reported an error: ERR_ FILE_ NOT_ FOUND (-6) loading
And no matter where I put the file, it will report this error
My computer system is Win11

Export via pandoc fails on Ubuntu 20.04 LTS

Exporting to any format fails; error can be reproduced. Couldn't find any similar issue in list :-/

Installed is pandoc 2.11.3.1

xxx@xxxx-desktop:/$ sudo find -iname pandoc
./opt/Zettlr/resources/pandoc
./usr/share/doc/pandoc
./usr/share/pandoc
./usr/bin/pandoc

Installed is texlive with all options and packages. Xelatex is installed as well as xetex

xxx@xxxx-desktop:/$ sudo find -iname xelatex
./usr/share/doc/texlive-doc/generic/e-french/test/XeLaTeX
./usr/share/doc/texlive-doc/xelatex
./usr/share/texlive/texmf-dist/tex/xelatex
./usr/bin/xelatex

=====

xxxx@xxxx-desktop:/$ sudo find -iname xetex
./usr/lib/python3/dist-packages/docutils/writers/xetex
./usr/share/doc/texlive-doc/xetex
./usr/share/texmf/fonts/misc/xetex
./usr/share/texlive/texmf-dist/fonts/misc/xetex
./usr/share/texlive/texmf-dist/tex/xetex
./usr/bin/xetex
./var/lib/texmf/web2c/xetex

Pandoc Command is unaltered:
pandoc "$infile$" -f markdown $outflag$ $tpl$ $toc$ $tocdepth$ --citeproc --bibliography "$bibliography$" $cslstyle$ $standalone$ --pdf-engine=xelatex --mathjax -o "$outfile$"

path to pandoc or Xelatex is not altered (left to standard)

Debug Info (part)
General Information
Zettlr Version: 1.8.4
.....
System: linux 5.4.0-58-generic (architecture: x64)
...
Node.js v12.18.3
Electron v11.1.1
Chrome v87.0.4280.88
v8 engine v8.7.220.29-electron.0
Zlib v1.2.11
OpenSSL v1.1.1
Current System Load
CPU Load: 0.75 %
Resident Set Size: 265.34 MB
C++ memory for JS Objects: 45.78 MB
Heap: 31.25 from 37.02 MB (Limit: 4194.05 MB)
Renderer flags
/opt/Zettlr/Zettlr
--type=renderer
--field-trial-handle=4473874597339068839,230464262735397459,131072
--enable-features=WebComponentsV0Enabled
--disable-features=CookiesWithoutSameSiteMustBeSecure,SameSiteByDefaultCookies,SpareRendererForSitePerProcess
--lang=de
--app-path=/opt/Zettlr/resources/app.asar
--node-integration
--no-sandbox
--no-zygote
--background-color=#fff
--enable-spellcheck
--enable-websql
--disable-electron-site-instance-overrides
--num-raster-threads=4
--enable-main-frame-before-activation
--renderer-client-id=4
--no-v8-untrusted-code-mitigations
--shared-files=v8_context_snapshot_data:100
.......
PANDOC_PATH: /opt/Zettlr/resources/pandoc

Error message:

Working with multiple cursors in Linux

The documentation claims that in Linux to use Code Mirror's multiple selection you have to use alt. While alt is the multiple selection modifier, to create multiple cursors you have to use ctrl either alone or with ctrl+alt

The current explanation is incorrect and incomplete for Linux. Also have to account that multiple selection works on a per line basis. And a markdown paragraph can be both a really long line or multiple lines. Given that neither Markdown nor Zettlr enforces neither definition, this can create the impression that multi cursor doesn't work.

Zettlr install command is deprecated

I followed the install command of doc, when I run brew cask install zettlr, terminal says brew cask install command is deprecated. Use brew install [--cask] instead.

[Feature] Open linked file with corresponding app instead of browser

I really like the ability to add non markdown files to folder and see them in the sidebar (as attachments).

However, if I add a link to say a pdf file or a LibreOffice file for example, when CTRL+clicking the link it tries to open the file in my web browser.
If I click on the file directly in the sidebar it opens the file with the correct corresponding app (PDF viewer or LibreOffice in my examples).

It would be nice that Zettlr could distinguish, in links, URLs which need to be opened with a web browser from other file types which must be opened with other apps.

[fr] Expand UX for headings folding

Use case:

I fold many (all) nodes for a big picture overview.
I go to another document B to copy paste things.
I go back to document A... and all my nodes are unfolded. What an unpleasant surprise.

Suggestion 1: remember the folded state of nodes.
Suggestion 2: commands to fold all/ unfold all. This would also mitigate the need for Suggestion 1, as it would not be a hassle to do this.

[ENHANCEMENT] Better documenting custom fonts/CSS

Description

Zettlr's docs should better explain how to create your own CSS customizations.

Proposed Changes

I just downloaded Zettlr to see how it worked, and compare it against Typora (another WYSIWYG Markdown editor). I didn't like the initial appearance, but found several roadblocks to customizing the styles.

• The docs at https://docs.zettlr.com/en/core/custom-css/#custom-css are quite incomplete. It explains how all rules are rooted at body/body.dark. and supplies a list of all classes, but does not specify what rules exist, or what hierarchy the elements form.
  • (I don't know if this needs explaining. When customizing websites, I'm used to using Developer Tools to figure things out.)
  • There is a large "grab bag" of pre-written GUI tweaks. Maybe these could be program options instead, I'm not sure.
  • Without F12, I don't know what elements I can style, how they're arranged in a tree, or what existing rules exist.
• https://docs.zettlr.com/en/core/custom-css/#custom-css should explain how to open developer tools.
  • Currently, that link doesn't mention developer tools at all. I had to search to find a different doc page, https://docs.zettlr.com/en/get-involved/#devtools-development-tools, which mentions you need to enable "debug-mode". I searched the docs, but couldn't find how to enable debug mode. I eventually discovered it's via Preferences, Advanced tab (where it's called "debug mode" without a hyphen).

---

Copied from Zettlr/Zettlr#982.

Disable cursor blinking

Is it possible to get a setting for disabling the blinking of the cursor?

I found this old reddit thread but the provided solution does not work (anymore).

Change in how the documentation is structured for Exporting, Defaults, and Academic Tools

This is related to my doc update about word, odt, pptx exports in the defaults documentation. I feel that perhaps it should be placed under another file instead, perhaps in Export or under Academic Tools.

Overall, I think the files could be organized differently and that the page titles could be more clear. I think it could also be a good idea to have a central table of contents page within each of the categories that describes what each page is about. Because I find myself having to click through all the pages back and forth trying to find the information I want. I think the documentation is fine if you know what you need to search for, but if you're not familiar with pandoc or more technical things, then you wouldn't think to check pages like Defaults and Assets Managers for answers to your problems.

I think Presentantations could be renamed to HTML Presentation, to make it clear that it's not for Powerpoint presentations. Similarly, Custom Templates could include LaTeX in the page name. Or a clear note at the top to say which types of export the current page applies to.

Under Exporting, it might make sense to have a section that is more clear about if you need defaults, a template, or a reference doc based on which type of export you want. Right now it just gives a link to defaults or template page without saying which one you would need for a specific type of export.

For example something like this, including the links to the pages:

Export Options based on File Type

HTML, PDF, LaTeX, RTF, HTML presentations (and the others):

• Defaults file in Assets Manager
• Custom LaTeX templates
• YAML

Word, ODT, Powerpoint presentations:

• Defaults file in Assets Manager
• custom Reference Document
• YAML (I don't actually know if this works for word export)

I don't know enough about how all the other types of export work to write a clear summary of what needs to be done for them, but I could help edit the pages to make things more clear if someone else is able to provide the info.

Open second tab when no document is open

Possible bug:
Open program with no document open.
Open a document from the left side panel
Attempt to open a second document with Ctrl Left Click
The new doc opens in the one tab

Work around:
Before opening the new document, edit the one open document.
Then Ctrl Left Click to open second document and it goes into a new tab
Simply Saving the first document without editing does not work.

It seems that Ctrl Click should open a new doc in a new tab without editing the first document.

I'm running the Debian version on Linux Mint 18.3

Consider front matter in project metadata

I find front matter very convenient, because you spot them on first sight and they are easily changeable while also being very expandable (e.g. author + affiliation).

It would be great, if the font matter given in a markdown file within a Zettlr project would be considered for the project export. So, I would like to give title, author etc. in the front matter and not in the project settings.

Thanks for providing this cool editor!

Cheers,

Adrian

Image links are broken in the pomodoro timer section

Allow more precise searching when clicking links

When I Cmd-click a link, it triggers a search for the unquoted string in the link, not the exact link text "[[...]]]". An example is provided here. Thanks!

Outdated documentation

I have just installed Zettlr, so I am reading quite a lot of documentation.

The docs are a bit outdated, making learning a bit more difficult than it should. I will add here all the pages that should be revised:

1. https://docs.zettlr.com/en/academic/citations/
   The citation database is no longer in "Export", it has its own tab: easy once spotted, but quite disorienting at first.

Editing tables created prior to adopting Zettlr

I have a bunch of tables created in some editor and would like to see or edit them in Zettlr after importing the document, is there a way? Thanks

.deb install fails on Debian 11 bullseye - hoping for snap or flatpak

CORRECTION: Somehow I ended up in the wrong place. Issue has already been reported:
Zettlr/Zettlr#2464 (comment)

Hello,

Thank you all for giving us Zettlr.
Unfortunately, I was not successful installing the Zettlr .deb on Debian 11 bullseye because of a missing dependency:

user@computer:~$ sudo dpkg -i Zettlr-1.8.9-amd64.deb 
[sudo] password for user: 
Selecting previously unselected package zettlr.
(Reading database ... 183947 files and directories currently installed.)
Preparing to unpack Zettlr-1.8.9-amd64.deb ...
Unpacking zettlr (1.8.9) ...
dpkg: dependency problems prevent configuration of zettlr:
 zettlr depends on libappindicator3-1; however:
  Package libappindicator3-1 is not installed.

dpkg: error processing package zettlr (--install):
 dependency problems - leaving unconfigured
Processing triggers for hicolor-icon-theme (0.17-2) ...
Processing triggers for shared-mime-info (2.0-1) ...
Processing triggers for gnome-menus (3.36.0-1) ...
Processing triggers for desktop-file-utils (0.26-1) ...
Processing triggers for mailcap (3.69) ...
Errors were encountered while processing:
 zettlr

For now, I am using Zettlr as an AppImage.
But I should be grateful if in the short term you could make Zettlr available as either a snap or a flatpak.
I think this would help with adoption, too, seeing that Obsidian has both snap and flatpak versions.

Regards

Cmd/Ctrl-Clicking tags not working

Hey there. I recently upgraded Zettlr for Mac to version 2.2.5. Unfortunately, I seem to have lost a functionality in the new version that worked fine in earlier ones. When I try Cmd-clicking a #tag, either from the tag cloud or from an open note, the search function doesn't work. The program brings up the "Full-Text Search" bar on the left side of the screen, but doesn't transfer the tag text into the search box or actually run the tag search.

Again, this function worked fine when I was using an older version of Zettlr. I'm not sure if I'm doing something wrong or if the v2.2.5 has a bug in it or something. But can you please help me fix this?

[COLLAB // FRENCH] Keeping the Translation updated

The french translation is (very good but) a bit old. Let's share here the files/folders we are working on, in order to avoid to work on the same files.
I am starting on the first file "citations.md" and I will continue with the other files of the "academic" folder.