1. Konvencie použité v dokumente
V tomto manuále je na zvýraznenie istých slov a fráz a upozornenie na špecifické kúsky informácií použitých niekoľko konvencií.
1.1. Typografické konvencie
Na zvýraznenie špecifických slov a fráz sú použité 4 konvencie. Nasledujú tieto konvencie a prípady, kedy sú použité, nasledujú.
Neproporcionálne Tučné
Použité na vyznačenie systémového vstupu, vrátane príkazov shellu, názvy súborov a ciest. Taktiež použité na vyznačenie názvov kláves a ich kombinácií.
Na zobrazenie obsahu súboru my_next_bestselling_novel v aktuálnom priečinku, zadajte vo výzve shellu príkaz cat my_next_bestselling_novel a stlačte Enter na vykonanie príkazu.
Vyššieuvedené obsahuje názov súboru, príkaz shellu a názov klávesy, všetky zobrazené neproporcionálnym tučným písmom a vďaka kontextu sú všetky rozlíšiteľné.
Kombinácie kláves sa odlišujú od klávesových kombinácií spojovníkom, ktorý spája všetky časti klávesovej kombinácie. Napríklad:
Na vykonanie príkazu stlačte Enter.
Stlačte Ctrl+Alt+F1 na prepnutie do prvého virtuálneho terminálu. Stlačte Ctrl+Alt+F7 pre návrat do vašej relácie X-Windows.
Prvá veta zvýrazňuje konkrétny kláves na stlačenie. Druhá popisuje dve sady po tri klávesy, každú sadu je potrebné stlačiť spoločne.
Ak sa pojednáva o zdrojovom kóde, názvy tried, metód, funkcií, názvy premenných a návratových hodnôt zmienených v odstavci budú zobrazené ako je uvedené vyššie, neproporcionálnym tučným písmom. Napríklad:
Kategórie spojené so súbormi obsahujú filesystem pre súborové systémy, file pre súbory a dir pre priečinky. Každá trieda má vlastnú priradenú sadu práv.
Proporcionálne Tučné
Toto označuje slová alebo frázy, na ktoré je možné naraziť v systéme, vrátane: názvy aplikácií; text v dialógovom okne; popisky tlačidiel; popisky zaškrtávacích a prepínacích tlačidiel; názvy ponúk a podponúk. Napríklad:
Z hlavnej ponuky si zvoľte na spustenie Nastavenia myši. Na karte Tlačidlá kliknite na voľbu Pre ľavákov a kliknite na tlačidlo Zavrieť na prepnutie primárneho tlačidla z ľavého na pravé (čo lepšie prispôsobí myš pre ľavú ruku).
Na vloženie špeciálneho znaku do súboru v gedit si z hlavnej ponuky zvoľte . Ďalej si z ponuky aplikácie Mapa znakov zvoľte , zadajte názov znaku do políčka Hľadať a kliknite na tlačidlo Nasledujúce. Hľadaný znak bude vyznačený v Tabuľke znakov. Dvojklikom na zvýraznený znak sa tento prenesie do políčka Text na kopírovanie a potom kliknite na tlačidlo Kopírovať. Teraz sa prepnite späť do vášho dokumentu a zvoľte z ponuky aplikácie gedit.
Vyššieuvedený text obsahuje názvy aplikácie, názvy položiek a podpoložiek v systémovej ponuke, položky ponuky špecifické pre aplikáciu a tlačidlá a texty nájdené v grafickom prostredí; všetky tieto sú zobrazené pomocou proporcionálneho tučného písma a vďaka kontextu sú všetky odlíšiteľné.
Všimnite si, že skratka je použitá na naznačenie cesty cez položky ponuky a ich podpoložky. Je to z dôvodu vyhnutiu sa snahe o takýto druh popisu: 'Zvoľte si položku z podpoložky položky menu v hlavnej ponuke systému'.
Neproporcionálna Tučná KurzívaProporcionálna Tučná Kurzíva
Či už neproporcionálne alebo proporcionálne tučné, pridanie kurzívy značí nahraditeľný alebo premenný text. Kurzíva označuje text, ktorý priamo nevpisujete, alebo zobrazený text, ktorý sa mení v závislosti od okolností. Napríklad:
Na pripojenie ku vzdialenému systému pomocou ssh vo výzve shellu zadajte ssh používateľské_meno@názov.domény. Ak je vzdialený systém example.com a vaše používateľské meno na ňom je john, zadajte ssh john@example.com.
Príkaz mount -o remount súborový-systém znova pripojí spomenutý súborový systém. Napríklad na opätovné pripojenie súborového systému /home je príkaz mount -o remount /home.
Na zistenie verzie nainštalovaného balíčka použite príkaz rpm -q balíček. Vrátený výsledok bude nasledovný: balíček-verzia-vydanie
Všimnite si slová uvedené tučným písmom a kurzívou — používateľské_meno, názov.domény, súborový-systém, balíček, verzia, vydanie. Každé z týchto slov je zástupné, či už pre text, ktorý zadáte pri zápise príkazu, alebo text zobrazený systémom.
Výnimkou z bežného využitia na zobrazenie nadpisu práce je, že kurzíva označuje prvé použitie nového a dôležitého výrazu. Napríklad:
Keď Apache HTTP server prijíma požiadavky, vytvorí procesy potomkov alebo vlákna na ich obslúženie. Táto skupina procesov potomkov alebo vlákien je známa pod názvom server-pool. V Apache HTTP servri 2.0 je zodpovednosť za vytváranie a spravovanie týchto server-poolov vytiahnutá do skupiny modulov nazvanej Multi-procesné moduly (MPM). Na rozdiel od iných modulov môže byť v Apache servri 2.0 načítaný zo skupiny MPM len jediný modul.
1.2. Konvencie pre citáty
Dvoj- ale bežne viacriadkové dátové typy sú vizuálne zvýraznené od okolitého textu.
Výstup odoslaný na terminál je vysádzaný neproporcionálnym rímskym písmom, takže zobrazené je:
knihy Plocha dokumentácia drafts mss fotky všeličo svn
books_tests Plocha1 stiahnuté obrázky poznámky skripty svgs
Výpisy zdrojového kódu sú tiež vysádzané neproporcionálnym rímskym písmom, ale sú zobrazené a zvýraznené nasledovne:
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("Created Echo");
System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
}
}
1.3. Poznámky a upozornenia
A nakoniec, používame tri vizuálne štýly na upozornenie na informácie, ktoré by inak mohli zostať nepovšimnuté.
Poznámka
Poznámka je rada, ťahák alebo alternatívny spôsob pre úlohu, ktorý je vždy poruke. Ignorovanie poznámky by nemalo mať negatívne dúsledky, ale môžete tým prešvihnúť trik, ktorý by vám uľahčil život.
Dôležité
Kolónka 'Dôležité' vymenúva ľahko prehliadnuteľné veci: zmeny nastavení, ktoré sa týkajú len aktuálnej relácie, alebo služby, ktoré musia byť opätovne spustené na aplikovanie aktualizácie. Ignorovaním Dôležitého nestratíte údaje, môže vás to ale podráždiť a frustrovať.
Upozornenie
Upozornenie by nemalo byť ignorované. Ignorovaním upozornenia pravdepodobne stratíte údaje.