Ten podręcznik używa kilku konwencji, aby wyróżnić niektóre słowa i frazy, a także zwrócić uwagę na określone części informacji.
1.1. Konwencje typograficzne
Aby zwracać uwagę na określone słowa i frazy używane są cztery następujące konwencje typograficzne.
Pogrubiona czcionka o stałej szerokości
Używana do wyróżniania wejścia systemu, w tym poleceń powłoki, nazw plików i ścieżek. Używana także do wyróżniania klawiszy i ich kombinacji. Na przykład:
Aby zobaczyć zawartość pliku mój_nowy_bestseller w bieżącym katalogu roboczym, należy wpisać polecenie cat mój_nowy_bestseller po znaku zachęty powłoki i nacisnąć klawisz Enter, aby wykonać polecenie.
Powyższy tekst zawiera nazwę pliku, polecenie powłoki i klawisz, wszystkie przedstawione za pomocą pogrubionej czcionki o stałej szerokości, a rozróżnialne dzięki kontekstowi.
Kombinacje klawiszy mogą być rozróżniane od pojedynczych klawiszy przez myślnik łączący każdą część kombinacji klawiszy. Na przykład:
Proszę nacisnąć klawisz Enter, aby wykonać polecenie.
Naciśnięcie Ctrl+Alt+F2 przełączy na pierwszy terminal wirtualny. Naciśnięcie Ctrl+Alt+F1 powróci do sesji X Window.
W pierwszym paragrafie wyróżniono pojedynczy klawisz do naciśnięcia. W drugim wyróżniono dwa zestawy trzech klawiszy, każde do wciśnięcia jednocześnie.
Jeśli omawiany jest kod źródłowy, to nazwy klas, metody, funkcje, nazwy zmiennych oraz wartości zwrócone wspomniane w paragrafie zostaną przedstawione tak jak powyżej, pogrubioną czcionką o stałej szerokości. Na przykład:
Klasy związane z plikami to filesystem dla systemów plików, file dla plików, a dir dla katalogów. Każda klasa posiada swój własny zestaw uprawnień.
Pogrubiona czcionka o zmiennej szerokości
Ta czcionka oznacza słowa lub frazy spotykane w systemie, w tym nazwy aplikacji, teksty okien dialogowych, przyciski z etykietami, etykiety pól wyboru, tytuły w menu i podmenu. Na przykład:
Proszę wybrać → → z głównego menu panelu, aby uruchomić Preferencje myszy. W karcie Przyciski należy nacisnąć pole wyboru Dla leworęcznych i nacisnąć przycisk Zamknij, aby przełączyć główny przycisk myszy z lewego na prawy (umożliwiając używanie myszy lewą ręką).
Aby umieścić specjalny znak w pliku programu gedit, należy wybrać → → z głównego menu panelu. Następnie należy wybrać → z paska menu Mapy znaków, podać nazwę znaku w polu Znajdź i nacisnąć przycisk Dalej. Wyszukiwany znak zostanie wyróżniony w Tablicy znaków. Podwójne naciśnięcie wyróżnionego znaku umieści go w polu Tekst do skopiowania. Następnie należy nacisnąć przycisk Skopiuj. Teraz należy przełączyć się z powrotem na dokument i wybrać → z paska menu programu gedit.
Powyższy tekst zawiera nazwy aplikacji, nazwy menu systemowych i ich elementów, nazwy menu aplikacji oraz przyciski i tekst z graficznego interfejsu użytkownika, wszystkie przedstawione za pomocą pogrubionej czcionki o zmiennej szerokości, a rozróżnialne dzięki kontekstowi.
Pogrubiona i pochylona czcionka o stałej szerokości lub Pogrubiona i pochylona czcionka o zmiennej szerokości
Kiedy używana jest pogrubiona czcionka i stałej lub zmiennej szerokości, dodanie pochylenia wskazuje tekst do zastąpienia lub zmienne. Pochylenie oznacza tekst, którego nie trzeba wpisywać dosłownie lub który zmienia się w zależności od okoliczności. Na przykład:
Aby połączyć się ze zdalnym komputerem używając SSH, należy podać polecenie ssh nazwa_użytkownika@nazwa.domeny po znaku zachęty powłoki. Jeśli zdalny komputer to przykład.pl, a nazwa użytkownika na tym komputerze to jan, należy podać ssh jan@przykład.pl.
Polecenie mount -o remount system-plików ponownie montuje podany system plików. Na przykład, aby ponownie zamontować system plików /home, polecenie to mount -o remount /home.
Aby zobaczyć wersję obecnie zainstalowanego pakietu, należy użyć polecenia rpm -q pakiet. Zwrócony zostanie następujący wynik: pakiet-wersja-wydanie
Proszę zauważyć powyżej pogrubione i pochylone słowa — nazwa_użytkownika, nazwa.domeny, system-plików, pakiet, wersja i wydanie. Każde słowo zostanie zastąpione przez tekst podany przez użytkownika podczas wpisywania polecenia lub przez tekst wyświetlany przez system.
Poza standardowym użyciem do przestawienia tytułu pracy, pochylenie oznacza pierwsze użycie nowego i ważnego terminu. Na przykład:
Publican jest systemem publikowania opartym na formacie DocBook.
1.2. Konwencje dla cytatów
Wyjście terminala i kod źródłowy są wizualnie oddzielone od otaczającego tekstu.
Wyjście wysłane do terminala jest wyświetlane za pomocą czcionki antykwowej o stałej szerokości i przez to przedstawia się tak:
książki Pulpit dokumentacja szkice mss zdjęcia coś svn
książki_testowe Pulpit1 pobrane obrazy notatki skrypty svg
Kod źródłowy jest także wyświetlany za pomocą czcionki antykwowej o stałej szerokości, ale wygląda i wyróżniony jest następująco:
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"));
}
}
