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 parts of the text that need to be highlighted in order to make them clearer, easier to remember, and to add a little color to the appearance of the content.

These distinctions have different meanings, so I have associated each with an icon to help you navigate faster in the writings. The following are examples of panel types that 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 based on (depends on) the description or detail marked as, so you must first have the building block to make it. In such a panel, I therefore refer to the necessary preconditions.


Related tutorials. There are other useful articles and tutorials related to the description. These types of pages are not interdependent, but they are logically and thematically related, so it’s worth reading them as well. In this panel, I link, for example, a series of articles and a description series related to a given topic, so that you do not have to search for them in the categories.


Navigation. The description consists of several pages that belong together (they have been divided into several pages only because of their size), so they have a separate pager to make it easier to navigate between the pages. In this type of panel, there is a scrolling section at the bottom of the description pages that connects 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, choice or several variations. There are also alternative methods in the description to solve the same problem, in which case we can choose the one that is more convenient for us. Furthermore, there may be cases where a description includes several different solutions or methods, in which case we can select the variation that best suits us. Such panels usually have internal links that skip one section and point to the other immediately.


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


Tips, ideas. The text in the panel gives tips and ideas related to the implementation of the given 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 draws attention to the fact that the section 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 indicate them here as well.


Time consuming part. If a given part takes a long time to complete, or it takes a long time for the machine (eg compiling source codes, etc.), then I indicate that e.g. how long did it take me. This way you can prepare for it beforehand.


Error possible. We can make a mistake if we don’t pay attention to the details and conditions, which we can fix afterwards, but it’s worth avoiding unnecessary 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.