This wiki uses specific design choices to communicate information effectively. This includes font design, color markings and page layout. Below you can find an explanation of these.
| Design | Explanation |
|---|---|
| Bold |
Bold font means one of two things:
|
| Italics |
Italics mean one of two things:
|
| Underline |
Underlined text is always combined with specific keywords to note a type of UI element. For example marking that something is a dropdown menu ("Dropdown"). The keywords you can find in this wiki are:
|
| “Quotation marks” | “Quotation marks” mark a specific configuration the user is prompted to use. For example the specific number to enter into a field, a specific selection from a dropdown menu, or the state of a toggle ("On" or “Off”). |
| Yellow highlighting |
Yellow highlighting are always combined with specific keywords and are used to draw attention to the following text. Such keywords include:
|
On this wiki, you will find many boxes like this.
| ! | Info box example |
| This is an example of an info box. |
These boxes are used for a variety of purposes. They always convey additional information related to the article they show up in. This can be side notes, warnings, links and other information. The type of information is identified by the sign or letter in the left part. The importance of the information is identified by the color of the left part. See below for an explanation of them.
| Sign/Color | Meaning |
|---|---|
| ! | Note. Additional information that does not fit into the flow of the article otherwise. |
| ? | Question. A frequently asked question — and its answer — which may arise from reading the article. |
| E | Expert. Highlights settings which are Expert-only. Non-experts are advised to contact Ferncast support (support@ferncast.de) before performing any configurations. |
| L | Link. Provides a link to an external resource that is relevant to the article. |
| Nice to Know. Information that is not relevant to the operation of the system, but is “nice to know” or otherwise useful, but not overly important. | |
| Clarification. Information that is important to fully understand the function detailed in the article. This is the most common color. | |
| Caution. A note of caution. Information to help avoid misconfiguration or mistakes which may impact regular operation. | |
| Warning. A major warning. Information you MUST pay attention to avoid misconfiguration or mistakes, which may otherwise require significant investment of time or resources to alleviate. | |
|
Danger. A severe warning. This highlights information you MUST pay attention to in order to avoid one of two things:
|