Types and Meanings of Content Highlights

botond published 2018. 03. 27., K - 01: 11 time

In the tutorials and articles published on the site, there may be sections of text that need to be highlighted to make them clearer, easier to memorize, and to add some color to the content.

These distinctions have different meanings, so I've attached an icon to each of them to help me navigate faster in my writing. The following examples illustrate what panel types can occur:

Building Block. The description, or a part of it, functions as a building block that serves as the basis for other description (s).

Prerequisite, addiction. The description is another, building blockis (depends on it), so you must first have the building block to make it. So, in such a panel, I refer to the necessary prerequisites.

Related tutorials. There are additional useful articles and tutorials related to the description. These types of pages are not interdependent, but they are logically and thematically related, so you should read them as well. In this panel, for example, I link a series of articles, a description series, to a topic, so that they do not have to be searched through categories.

Navigation. The description consists of multiple pages that belong together (they are spread over several pages only because of their size), so they have a separate page to make it easier to navigate between pages. This type of panel has a paging section at the bottom of the description pages that links only the pages of that description.

Reusable parts, solutions. The text on the panel draws attention to the fact that the implementation you are discussing can be used elsewhere (eg scripts, code snippets, etc.), so you should bookmark it so you can easily find it later if you need it again.

Alternative solution. In addition to the solution discussed herein, it is possible to arrive at the same end result alternatively. So we can choose the one that is more comfortable for us.

Additional information, comments. The text on the panel serves as additional information for that description.

Tips, ideas. The text on the panel provides tips and hints for implementing this description.

Recommended reading, literature or sources used. Links to other articles, tutorials, or other websites or books may appear in this type of panel. The readings listed here are not prerequisites for the implementation of the tutorials, but are recommended for ease of understanding and preparation.

An update was added to the description later. Parts of this description have become obsolete in the meantime, so up-to-date information is required for operation.

Important parts. The texts in such a panel are meant to highlight vital parts of the tutorials.

Permanent, non-reversible operations. Although very rare, you may not be able to restore it later, after you have done an operation (eg upgrading a distribution to a major release, etc.). So before doing such an operation, we always consider the impact it may have on the rest of our Linux installation (eg web servers in use, etc.). I shall therefore deal separately with that distinction Important parts type.

Recommended or required downloads. The panel contains downloads recommended or needed to create a description.

Distribution dependent parts. This points out that the part in this description is for a specific distribution, so it may not work for others. In this case, if there are solutions for other distributions, I will report them here as well.

Time consuming part. If it takes a long time to make a particular part, or it takes a long time for the machine (eg compiling source codes, etc.) how long it lasted for me. So you can be prepared for it before.

Error possible. We may make a mistake if we do not pay attention to details and circumstances, which we can correct later, but it is worth avoiding extra work.

Fatal error. It differs from the previous one in that the error so marked is very difficult, if not impossible, to be corrected without first starting again. Of course, this is only relevant for longer tutorials.
I have been through these mistakes most of the time, so this is how I try to draw attention to them.