Content Formatting

To break up the text and make reading easier, the following visual cues will also be given.

Normal text

Simple paragraphs, like most of the text in this post, will mean the natural flow of the text. These will be informative for the first reading, you might just want to skip them and get to the important bits when you come back later for reference.

Instructions

  • Bulleted paragraphs would contain either lists for easier reference or instructions to follow.

  • Refer to these, if you revisit any post, and want to repeat the steps involved.

Code and commands

Any code and commands within the text will be highlighted like this. Notice the little icon on the right-hand side, that allows you to copy the whole code onto the clipboard and then later insert it as text anywhere. This can come in handy when configuring the system, and wanting to copy over longer lines.

Boxes like the one below, with differently coloured text, will contain code (usually bash commands) that you can just copy and paste into a terminal window. You can always copy and paste these lines “as is”. (If you have no idea what this all means, just be patient, it will all be explained later.)

#! /bin/bash
#This code can be executed as a script

echo "Hi. I am the text you've placed in that file."
echo "It's cool isn't it?"
echo "..."
echo "You: No. It is not."

Highlights

Highlighted notice blocks will represent important information, warning you of something being risky, or important.

These notices are just additional notes that deserve a little more attention

Info notices add valuable information to the main text that should be regarded important.

Tips are useful info snippets that might help you do something in an easier or more efficient way.

Warnings mean danger! Be careful about anything written in these. There (might) be dragons.

TL;DR; Sections

Hidden sections will contain text, that can be considered “additional”, and might not be of everyone’s interest.

Content like this will not be displayed by default. This could be anything, from more advanced technical details to additional code, which some might find boring or tedious, or just plainly too much. In order to ensure the best reading experience, such text will only be displayed “on demand”. Look out for the plus sign (+), if you are interested in reading (even) more.

Instruction accordions

Similar to the above an accordion-like structure will include different text blocks in which only one section is revealed, while the others remain hidden. These can be used in the following cases

So that only the relevant steps are visible, long instruction sets, such as the installation guide later on, will be placed inside an accordion. This should make the instructions easier to read and navigate.

In certain cases, a tabbed item might need to include further divided sub-items, that are also optional/and or can be used in parallel or might offer choices. To avoid a possibly confusing layout, instead of nesting a tabbed layout inside another, an accordion will be used inside the tab.

Like what? No idea. I just needed another section to make the accordion look cool. But I'm sure I'll think of something, worry you not.

Quotes

Finally, quotes will also be marked where appropriate. To differentiate from the main body of text, quotes will be formatted like below:

My job involves searching for 'lost' quotations - that is, trying to find out who came up with a quotable saying that lingers in someone's mind and which they wish to use for their own purpose and which they cannot find in conventional dictionaries of quotation. -Nigel Rees

Tabs

In certain cases, there are alternative ways to do the same thing, such as performing the same task in a different operating system, or using a different type of installer, etc. In such cases, a tabbed interface like below will allow you to choose and only display the text you are interested in.

A simple tab style is used so that the contents can fit into the main body of the text, not distracting your flow of reading.

Using tabs helps to un-clutter already long pages. Some articles offer many images/instructions, and this way it will be easier to find/follow only the ones that you need.

Using tabs is simple. Tabs are intuitive. Tabs are your friends. Buy more tabs now! (Paid advertisement by Tabs and Co.)

Animated texts

Used sparingly to avoid too much disruption,

animated underlined text

will mark important concepts, that are not worthy of their own notice block, but still need your attention.

On some rare occasions, you might see a warning message with

animated text in the middle

You should always pay attention to such messages, as they will denote critical information, usually warning you of a dangerous operation, potential damage or data loss.