E kézikönyv számos hagyományt használ bizonyos szavak és kifejezések kiemelésére, illetve azért, hogy felhívja a figyelmet bizonyos adatokra.
1.1. Tipográfiai hagyományok
Négy tipográfiai jelölést használunk figyelemfelhívásra bizonyos szavak és kifejezések esetében. E jelölések és a körülmények amelyek közt alkalmazzuk őket a következőek:
Egyenszéles félkövér
Rendszer bemenet kiemelésére használjuk, beleértve a héj parancsokat, fájl neveket és elérési utakat. Billentyűleütések illetve billentyűkombinációk kiemelésére szintén használjuk. Például:
Egy az aktuális munkamappában levő fájl, a kedvenc_toplistás_regényem tartalmának megtekintéséhez gépelje be a cat kedvenc_toplistás_regényem parancsot a terminálban és nyomjon Entert, aparancs végrehajtásához.
A fentiekben fájlnév, héj parancs és billentyűleütés, mind egyenszéles félkövér, és mind megkülönböztethető a szövegkörnyezetnek köszönhetően.
Billentyűkombinációkat a részeit összekötő kötőjel különbözteti a billentyűleütésektől. Például:
Nyomjon Entert a parancs végrehajtásához.
Nyomjon Ctrl+Alt+F1-et az első látszólagos terminálra váltáshoz. Nyomjon Ctrl+Alt+F7-et az X-Window munkamenetbe visszatéréshez.
Az első mondat egy bizonyos megnyomandó billentyűt emel ki. A második két hármas billentyűkombinációt emel ki, ahol a kombinációk elemeit egyidejűleg nyomják meg.
Ha forráskódot, osztály neveket, műveleteket, függvényeket, változó neveket illetve visszatérési értékeket említünk egy bekezdésben, akkor azokat a fentiek szerint egyenszéles félkövér betűkkel jelenítjük meg. Például:
Fájlkezelő osztályok tartalmaznak egy filesystemet fájlrendszerekhez, filet fájlokhoz illetve dirt mappákhoz. Minden egyes osztályhoz tartozik hozzá rendelt jogosultság halmaz.
Arányos félkövér
Ez olyan szavakat vagy kifejezéseket jelöl, amikkel egy rendszerben találkozhatnak: alkalmazás neve, párbeszéd doboz szövege, címkés gomb, jelölő doboz és választó gomb címke, menü és almenü címe. Például:
Válassza a fő menü pontját az Egér beállítás indításához. A Gombok fülön, kattintson a Balkezes egér jelölő dobozra, majd a Bezárás gombra az elsődleges egérgomb balról jobbra felcseréléséhez (a bal kézhez igazításhoz).
Különleges jelek gedit fájlba beszúrásához válassza az menüpontot. Majd válassza a Karaktertábla menüjéből a pontot. Gépelje be a jel nevét a Keresés mezőbe, és kattintson a Következő gombra. A keresett jelet a Karaktertábla kiemeléssel jelöli. Duplán kattintva e kiemelt jelre a Másolandó szöveg mezőbe kerül. Kattintson a Másolás gombra. Váltson vissza az iratra, és válassza a gedit menüjéből a pontot.
A fenti szöveg tartalmaz alkalmazás neveket, rendszer szintű menü neveket és elemeket, alkalmazások saját menü neveit, grafikus felületen található gombokat és szövegeket, mind a szövegkörnyezettől jól megkülönböztethetően arányos félkövér alakban megjelenítve.
Vegye észre a jel használatát, ami menü és almenü bejárását jelöli. Ez a nehezen követhető „Válassza a fő menü menüjének almenüjének pontját” leírás helyett áll.
Egyenszéles dőlt félkövérArányos dőlt félkövér
Akár az egyenszéles félkövér akár az arányos félkövér esetében a dőlt betű helyettesíthető vagy változó szöveget jelöl. A dőlt betű jelöli, hogy nem kell szó szerint begépelni azt, vagy hogy a megjelenő szöveg helyzettől függően változik. Például:
Távoli gépre ssh-t használva történő bejelentkezéshez gépelje be az ssh használó@tartomány.neve parancsot a parancssorba. Ha a távoli gép pelda.hu és a használó azonosítója azon a gépen jani, akkor gépelje be az ssh jani@pelda.hu parancsot.
A mount -o remount fájlrendszer parancs újra csatolja a megnevezett fájlrendszert. Például a /home fájlrendszer újracsatolására való parancs a mount -o remount /home.
Az éppen telepített csomag változat számát megtekintendő, használja az rpm -q csomag parancsot. Ez a következő eredményt adja: csomag-változat-kiadás
Vegye észre a fenti dőlt félkövér szavakat: használó, tartomány.neve, fájlrendszer, csomag, változat és kiadás. Minden szó egy helyettes. Vagy parancs kiadása során begépelendő, vagy a rendszer által megjelenített szöveg.
A szokványos – munka címét megjelenítendő – használat mellett a dőlt betű új fontos szakkifejezés első használatát is jelölheti. Például:
Amikor az Apache HTTP szolgáló elfogadja a kérést, továbbítja azt a gyerek folyamatainak, hogy kezeljék. A gyerek folyamatok vagy szálak e csoportja a tartalék szolgálók néven ismeretes. Apache HTTP szolgáló 2.0 alatt, e tartalék szolgálók teremtését és karbantartását a Multi-Processing Modules (MPMs) nevű modulok csoportja végzi. Más moduloktól eltérően csak egy az MPM csoportból csak egy modult tölthet be az Apache HTTP szolgáló.
Két – gyakran többsoros – adat típust választanak el látványosan a környező szövegtől.
A parancssorba küldött kimenetet egyenszéles román alakban jelenítjük meg:
könyvek Asztal iratok félkész mss fotók dolgok svn
könyv_próba Asztal1 letöltések képek jegyz írások svg
A forráskód példákat szintén egyenszéles román betűtípussal szedjük, de a következő kiemeléseket és megjelenítést alkalmazzuk:
package org.jboss.book.jca.ex1;
import javax.naming.InitialContext;
public class ExClient
{
public static void main(String args[])
throws Exception
{
InitialContext iniCtx = new InitialContext();
Object ref = iniCtx.lookup("EchoBean");
EchoHome home = (EchoHome) ref;
Echo echo = home.create();
System.out.println("Echo kész");
System.out.println("Echo.echo('Szia') = " + echo.echo("Szia"));
}
}
1.3. Megjegyzések és figyelmeztetések
Végül három látványos stílust használunk figyelemfelkeltésre olyan tájékoztatáshoz, ami felett könnyen átsiklanának.
Megjegyzés
A megjegyzés rövid jótanács, fogás vagy az aktuális feladat egy másik megközelítése. Egy megjegyzés átugorható komolyabb negatív következmény nélkül, de egy ügyes trükk – ami megkönnyíti az életet – nagyon tud hiányozni.
Fontos
A fontos dobozok könnyen kihagyható részleteket taglalnak: beállítás változásokat, ami az aktuális munkamenetre vonatkoznak, vagy olyan szolgáltatásokra, amiket újra kell indítani, hogy a változások életbe lépjenek. Fontos doboz átugrása nem okoz adatvesztést, de lehet belőle némi izgalom és gyötrelem.
Figyelmeztetés
Figyelmeztetést ne ugorjon át! Figyelmeztetés mellőzése valószínűleg adatvesztést okoz.