1. Konvence používané v dokumentu
V tomto manuálu je použito několik konvencí pro zvýraznění určitých slov nebo vět a ke zdůraznění konkrétních informací.
1.1. Typografické konvence
Pro zvýraznění slov nebo vět se používají čtyři typografické konvence. Tyto konvence a situace, v nichž se uplatňují, jsou následující.
Neproporcionální tučné.
Používá se pro zvýraznění vstupu včetně příkazů shellu, názvů souborů a cest v souborovém systému. Dále pro zvýraznění názvů kláves a jeich kombinací. Například:
Chcete-li zobrazit obsah souboru my_next_bestselling_novel
v aktuálním adresáři, napište příkaz cat my_next_bestselling_novel
v příkazovém řádku a stisknutím Enter ho spustťe.
Výše uvedený text obsahuje název souboru, příkaz shellu a název klávesy zobrazené neproporcionálním tučným písmem a díky kontextu navzájem rozlišitelné.
Kombinace kláves se od názvů kláves odlišují pomlčkou oddělující jednotlivé části kombinace. Například:
Příkaz spusťe stisknutímEnter .
Stiskněte Ctrl+Alt+F1 pro přepnutí na první virtuální terminál. Stisknutím Ctrl+Alt+F7 se pak vrátíte do prostředí X-Windows.
V první větě je zvýrazněna jedna konkrétní klávesa. Ve druhé pak dvě skupiny po třech klávesách, které mají být stiskuty současně.
Je-li uváděn zdrojový kód, pak jsou názvy tříd, metody, funkce, identifikátory proměnných a návratové hodnoty zmiňované v textu zobrazovány tak jako výše, tedy neproporcionálním tučným
písmem. Například:
Mezi třídy související se soubory patří filesystem
pro souborový systém file
pro soubory, and dir
pro adresáře. Každá z těchto tříd má vlastní sadu oprávnění.
Proporcionální tučné
Označuje slova nebo věty , s nimiž se můžeme setkat v systému, jako jsou názvy aplikací, texty zobrazované v dialogových oknech, nadpisy tlačítek nebo jiných ovládacích prvků a položky menu. Například:
Vybráním v hlavním menu spusťte aplikaci Mouse Preferences . V záložce Buttons zaškrtněte volbu Left-handed mouse a stiskněte Close pro změnu hlavního tlačítka myši z levého na pravé (to usnadní používání myši levou rukou).
Chcete-li vložit speciální znak do souboru v aplikaci gedit, zvolte v hlavním menu. Pokračujte v menu Character Map napište název znaku do pole Search a stiskněte Next. Hledaný znak by měl být zvýrazněn v Character Table. Dvojklikem zvýrazněný znak umístěte do pole Text to copy a pak stiskněte tlačítko Copy. Po návratu do dokumentu zvolte v menu aplikacegedit.
Výše uvedený text obsahuje názvy aplikací, systémových a aplikačních menu a tlačítek, stejně jako různé texty, s nimiž se můžeme setkat v uživatelském rozhraní. Všechny jsou zobrazeny proporcionálním tučným písmem a jsou rozlišitelné podle kontextu, v němž se používají.
Všimněte si zkratky používané pro indikaci procházení v menu a jeho podmenu. Slouží ke zvýšení přehlednosti popisu opoti například "Vyberte v podmenu menu v hlavním menu".
Neproporcionální tučná kurzíva
nebo Proporcionální tučná kurzíva
Ať je tučné písmo proporcionální nebo neproporcionální, kurzíva označuje zaměnitelný nebo proměnlivý text. Znamená tedy, že se text může měnit podle okolností. Například:
Chcete-li se připojit ke vzdálenému systému prostřednictvím ssh, zadejte ssh username
@domain.name
v příkazovém řádku. Je-li vzdáleným systémem example.com
a vaše uživatelské jméno v tomto systému je john, zadejte ssh john@example.com
.
Příkaz mount -o remount file-system
znovu připojí zadaný souborový systém. Chcete-li například znovu připojit souborový systém/home
, je odpovídajícím příkazem mount -o remount /home
.
Chcete-li zobrazit verzi nainstalovaného balíčku, použijte příkaz rpm -q package
. Jeho výstup bude následující: package-version-release
.
Všimněte si výše uvedených slov zobrazených tučnou kurzívou — username, domain.name, file-system, package, version a release. Každé z těchto slov reprezentuje buď text, který zadáváte při spouštění příkazu, nebo text, zobrazovaný systémem.
Vedle obvyklého použití pro název díla se kurzíva používá k vyznačení prvího použití nového důležitého termínu. Například:
V rámci zpracování požadavků spouští HTTP server Apache synovské procesy nebo vlákna, které požadavky vyřizují. Skupina synovských procesů nebo vláken bývá označována jako server-pool. Ve verzi 2.0 serveru Apache je zodpovědnost za vytváření a udržování těchto skupin oddělena do skupiny modulů nazývané Multi-Processing Modules (MPMs). Na rozdíl od jiných modulů může být serverem Apache nahrán pouze jeden z modulů ze skupiny MPM.
Dva typy textu, obvykle víceřádkového, jsou vizuálně odlišeny od obklopujícího textu.
Výstup zobrazený v terminálu je zobrazen písmem Mono-spaced Roman
a prezentován takto:
books Desktop documentation drafts mss photos stuff svn
books_tests Desktop1 downloads images notes scripts svgs
Výpisy zdrojových kódů jsou rovněž zobrazovány písmem Mono-spaced Roman
, ale jsou prezentovány a zvýrazňovány následujícím způsobem:
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"));
}
}
Pro zvýraznění informací, které by jinak mohly být přehlédnuty, používáme tři vizuální styly.
Poznámka
Poznámka je tip, možné zjednodušení nebo alternativní postup v dané situaci. Ignorováním poznámky neriskujete negativní následky, ale můžete přijít o možnost ulehčit si práci.
Důležité
Okna Důležité obsahují detaily, které je někdy snadné přehlédnout. Například změny v konfiguraci, týkající se pouze konkrétního sezení, nebo služby, které je třeba restartovat, aby se projevily změny v systému. Ignorování takových informací nezpůsobí ztrátu dat, ale může být zdrojem nepříjemností.
Varování
Varování by nemělo být ignorováno. Ignorování varování pravděpodobně způsobí ztrátu dat.