Document

From SweepMe! Wiki
Jump to navigation Jump to search

The widget "Document" can be used to add a manual, a documentation or any other information to the Dashboard. It displays a text in different formats. Add it via the menu Widgets → Document → New….

Double-click the text area to open the widget settings. Select the "Text format" and enter your text.

The text can contain the parameter syntax {...}. During the run, the values are updated, so the Document widget can also be used to show measured values within a text.

Text formats

Plain text

Just enter a text and it will appear in the same way in the Document widget.

Rich text

Enter html/rich text that will be interpreted accordingly. You can use a website like https://html5-editor.net/ to quickly edit text.

Markdown text

Markdown is a syntax that allows to create structured text which is still easy to read. It is typically used in GitHub repositories to create a readme.md file. Here, it can be used to create text with headings, lines, tables, links and other features that go beyond a plain text.

You can use a website like https://markdownlivepreview.com/ to quickly create markdown text.

Further information: https://en.wikipedia.org/wiki/Markdown