Documentation
FreeThe editor shows this guide as a tab inside the editor. The topic tree is on the left, the text with screenshots from the editor on the right. The docs ship inside the editor and work without internet too. Online, the editor fetches the newest version.
Where to find it
- Menu Help › Documentation
- Command palette (⌘K): Documentation: guide to WebDonkey Editor
How to do it
- Open Help › Documentation. The Documentation tab shows "Guide to WebDonkey Editor" at the top.
- Click a chapter on the left. Its text appears on the right, and its topics below it in the tree.
- Click a topic to read its page.
- A second click on the chapter you are reading folds it in or out again.
While the editor runs, the tab opens again on the page you read last, with the same search.
Layout
Topic tree on the left. Organized like the editor window, with one chapter per tool and one entry per feature. A badge behind chapters and topics shows the tier: Free, Free & Premium or Premium. On a topic the badge only shows when it differs from its chapter's.
Search. Search documentation… filters the tree by titles and texts. While you search, every chapter with hits is unfolded. If a chapter title matches, all its topics stay. With no hit it says No matching topics.
Text on the right. At the top you see the chapter or section, the tier badge and, on the right, the Online docs mark. Screenshots follow your appearance: with a dark theme you see the dark shots, with a light one the light shots. With a German interface text and screenshots are German, otherwise English.
Enlarge image. A click on a screenshot shows it large over the whole window, with its description below. Esc, a click anywhere or the X at the top right (Close) closes it again.
Links
- A link to another page of this guide opens it right in the tab.
- A link into the docs of WebDonkey or WebDonkey Pages opens the page in the browser.
- A link to a page of the app opens that page in WebDonkey.
Without internet
The complete docs ship inside the editor. Without a network you read the same pages with pictures and search. At the top right of the text it then says Offline version of … with the date of the texts, online it says Online docs.
The editor always takes the newest version it can get: first online from webdonkey.io if the answer arrives within 5 seconds, otherwise the version it last loaded online, otherwise the version that came with this release of the editor. Without a network the newer of the two local versions wins. A picture that only exists online is left out while offline.
Only if there is no version at all does it say Documentation not available with Open in browser.
What happens in the background
- Online, the editor loads the outline and the texts from webdonkey.io/docs, and when you search, all texts of your language once. All that goes out is which page you want in which language, nothing about your projects. What it has loaded online it reuses for ten minutes.
- The editor keeps the last version loaded online (outline and texts, no personal data) in the storage of its window on your Mac. A newer version replaces it.
- The docs are also in your browser: webdonkey.io/docs.
Free and Premium
The documentation is free.