Writerside Help

TL;DR blocks

Use the <tldr> element to provide a list of quick facts about the contents of a topic or chapter. Give your readers some basic info to start using and exploring the feature on their own without having to read into the detailed description. For example, you can specify the main shortcut, command, action, or the location of the settings.

Put it among the first elements in a topic or chapter and wrap each fact with <p>. See the example below the title of this topic.

<tldr> <p>Shortcut: <shortcut>Ctrl+Space</shortcut></p> <p>Configure: <ui-path>Settings / Preferences | Editor | Code Completion</ui-path></p> </tldr>

A topic or chapter can have only one TL;DR block. Try not to overuse them: keep facts as brief as possible and do not add more than three in one TL;DR block.

Last modified: 17 November 2023