Tartalmi kiemelések fajtái és jelentései

botond küldte be 2018. 03. 27., k - 01:11 időpontban

Az oldalon közzétett leírásokban, cikkekben előfordulhatnak olyan szövegrészek, melyeket szükséges kiemelni hogy áttekinthetőbbek, könnyebben megjegyezhetők legyenek, és hogy kicsit színesítsem, feldobjam a tartalom megjelenését.

Ezek a megkülönböztetések különböző jelentésekkel bírnak, így mindegyikhez társítottam egy ikont ami segíti a gyorsabb eligazodást az írásokban. Az alábbi példákkal mutatom be hogy milyen paneltípusok fordulhatnak elő:

 

Építőelem. A leírás vagy annak egy adott része építőelemként funkcionál, mely más leírás(ok) alapjául is szolgál.

 

Alapfeltétel, függőség. A leírás egy másik, építőelem-ként megjelölt leírásra vagy részletre épül (tőle függ), így az elkészítéséhez először az építőelmnek meg kell lennie. Az ilyen panelen tehát a szükséges előfeltételekre hivatkozom.

 

Kapcsolódó leírások. A leíráshoz kapcsolódnak további hasznos cikkek, leírások. Ezek a fajta oldalak nem függenek egymástól, de logikailag, tematikailag összetartoznak, így érdemes elolvasni azokat is. Ezen a panelen linkelem be például az adott témakörbe tartozó cikksorozatot, leírás sorozatot, hogy ne kelljen keresgélni őket a kategóriákban.

 

Navigáció. A leírás több oldalból áll, amik összetartoznak (csak a terjedelmük miatt kerültek szétosztva több oldalra), ezért külön lapozóval rendelkeznek, hogy könnyebben lehessen navigálni az oldalak között. Ilyen fajta panelen található a leírás oldalainak alján a lapozó rész, ami csak az adott leírás oldalait kapcsolja össze.

 

Újrahasználható részek, megoldások. A panelen lévő szöveg arra hívja fel a figyelmet, hogy az éppen tárgyalt kivitelezés máshol is felhasználható (pl scriptek, kódrészletek, stb.), így célszerű lementeni könyvjelzőbe, hogy később könnyen visszatalálhassunk, ha újból szükség lenne rá.

 

Alternatív megoldás. A leírásban tárgyalt megoldáson kívül lehetőség van alternatív módon is eljutni ugyanahhoz a végeredményhez. Így választhatjuk a számunkra kényelmesebbet.

 

Kiegészítő információk, kommentek. A panelen lévő szöveg kiegészítő információként szolgál az adott leírással kapcsolatosan.

 

Tippek, ötletek. A panelen lévő szöveg tippeket, ötleteket ad az adott leírás megvalósításával kapcsolatosan.

 

Ajánlott olvasmány, szakirodalom vagy felhasznált források. Ezen a fajta panelen megjelenhetnek hivatkozások másik cikkekre, leírásokra, esetleg más weboldalakra vagy könyvekre. Az itt feltűntetett olvasmányok nem feltételei a leírások megvalósításának, de ajánlottak ahhoz, hogy könnyebben érthetők, elkészíthetők legyenek.

 

A leírásba utólag bekerült frissítés. A leírás egyes részei időközben már elavultak, ezért friss információk szükségesek a működéshez.

 

Fontos részek. Az ilyen panelen lévő szövegek a leírások létfontosságú részeit hivatottak kihangsúlyozni.

 

Maradandó, nem visszafordítható műveletek. Bár nagyon ritka, de előfordulhat hogy egy művelet elvégzése után már nincs lehetőség annak a későbbi visszaállítására, visszafordítására (Pl egy disztribúció főverzió frissítése, stb). Így az ilyen művelet végrehajtása előtt mindig mérlegeljük hogy milyen hatással lehet a Linux telepítésünk többi részére (pl. éles használatban lévő webszervereknél, stb). Ezt a megkülönböztetést tehát külön kezelem a Fontos részek típustól.

 

Ajánlott, vagy szükséges letöltések. A panel tartalmazza a leírás elkészítéséhez ajánlott vagy szükséges letöltéseket.

 

Disztribúció függő részek. Ez arra hívja fel a figyelmet, hogy a leírásban lévő rész egy konkrét disztribúcióhoz készült, így nem biztos hogy másikokon is működik. Ilyenkor ha más disztribúciókhoz is vannak megoldások, itt jelzem azokat is.

 

Időigényes rész. Ha egy adott részt sokáig tart elkészíteni, vagy éppen a gépnek tart sokáig (pl forráskódok fordítása, stb), akkor így jelzem hogy pl. nálam mennyi ideig tartott. Így már előtte fel lehet rá készülni.

 

Hibalehetőség. Hibát ejthetünk ha nem figyelünk a részletekre és a körülményekre, amit utólag javíthatunk, de érdemes elkerülni a felesleges pluszmunkát.

 

Végzetes hibalehetőség. Annyiban különbözik az előzőtől, hogy az így jelzett hibát ha elkövetjük, akkor már nagyon nehéz, vagy egyáltalán nem lehet utólag javítani az egész előröl kezdése nélkül. Ennek természetesen csak a hosszabb leírások esetén van jelentősége.
Ezeken a hibákon én már többnyire átestem a munka során, ezért így próbálom felhívni ezekre a figyelmet.