Documentation 0.1

Common Content

Wydanie 0

Dude McDude

My Org Best Div in the place

Copyright © 2009 Red Hat, Inc.. This material may only be distributed subject to the terms and conditions set forth in the Open Publication License, V1.0, (the latest version is presently available at http://www.opencontent.org/openpub/).
Fedora and the Fedora Infinity Design logo are trademarks or registered trademarks of Red Hat, Inc., in the U.S. and other countries.
Red Hat and the Red Hat "Shadow Man" logo are registered trademarks of Red Hat Inc. in the United States and other countries.
All other trademarks and copyrights referred to are the property of their respective owners.
Documentation, as with software itself, may be subject to export control. Read about Fedora Project export controls at http://fedoraproject.org/wiki/Legal/Export.


(preface title goes here)

1. Konwencje dokumentu

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.
W wydaniach PDF i papierowych ten podręcznik używa czcionek z zestawu Liberation. Czcionki Liberation są używane także w wydaniach HTML, jeśli zestaw jest zainstalowany w systemie. Jeśli nie, wyświetlone zostaną alternatywne, ale odpowiadające im czcionki. Uwaga: Red Hat Enterprise Linux 5 i późniejsze domyślnie zawierają zestaw czcionek Liberation.

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 folderze roboczym, wpisz polecenie cat mój_nowy_bestseller po znaku zachęty powłoki i naciśnij 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:
Naciśnij Enter, aby wykonać polecenie.
Naciśnij Ctrl+Alt+F1, aby przełączyć na pierwszy terminal wirtualny. Naciśnij Ctrl+Alt+F7, aby wrócić do sesji X Window.
W pierwszym zdaniu 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 folderów. Każda klasa posiada swój własny zestaw uprawnień.
Pogrubiona czcionka o zmiennej szerokości
Ta czcionka zaznacza słowa lub frazy spotykane w systemie, w tym nazwy aplikacji, tekst okien dialogowych, przyciski z etykietami, etykiety pól wyboru, tytuły w menu i podmenu. Na przykład:
Wybierz System > Preferencje > Mysz z głównego meny panelu, aby uruchomić Preferencje myszy. W karcie Przyciski naciśnij na pole wyboru Mysz leworęczna i naciśnij 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 gedit, wybierz Aplikacje > Akcesoria > Mapa znaków z głównego menu panelu. Następnie wybierz Znajdź > Znajdź… z paska menu Mapy znaków, podaj nazwę znaku w polu Znajdź i naciśnij 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 naciśnij przycisk Skopiuj. Teraz przełącz z powrotem na dokument i wybierz Edycja > Wklej z paska menu gedit.
Powyższy tekst zawiera nazwy aplikacji, nazwy menu systemowych i ich elementów, nazwy menu aplikacji oraz przyciski i tekst z interfejsu GUI, wszystkie przedstawione za pomocą pogrubionej czcionki o zmiennej szerokości, a rozróżnialne dzięki kontekstowi.
Zauważ znak >, używany do wskazania przejścia między menu a podmenu. Dzięki temu można uniknąć trudnej do zrozumienia formy 'Wybierz Mysz z podmenu Preferencje w menu System głównego menu panelu'.
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 zaznacza 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, podaj ssh nazwauż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, podaj 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, użyj polecenia rpm -q pakiet. Zwrócony zostanie następujący wynik: pakiet-wersja-wydanie.
Zauważ powyżej pogrubione i pochylone słowa — nazwauż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 zaznacza pierwsze użycie nowego i ważnego terminu. Na przykład:
Kiedy serwer HTTP Apache akceptuje żądania, rozdziela procesy potomne lub wątki, aby je obsłużyć. Ta grupa procesów potomnych lub wątków jest znana jako pula-serwera. W serwerze HTTP Apache 2.0, odpowiedzialność za tworzenie i zarządzanie tymi pulami-serwera została umieszczona w grupie modułów o nazwie Moduły wielokrotnego przetwarzania (MPMs). Inaczej niż inne moduły, tylko jeden moduł z grupy MPM może być wczytywany przez serwer HTTP Apache.

1.2. Konwencje dla cytatów

Dwa, zazwyczaj wielowierszowe typy danych 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  inne  svn
książki_test  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("Utworzono Echo");

      System.out.println("Echo.echo('Witaj') = " + echo.echo("Witaj"));
   }
   
}

1.3. Uwagi i ostrzeżenia

Używane są trzy style wizualne, aby zwrócić uwagę na informacje, które inaczej mogłyby zostać przeoczone.

Uwaga

Uwaga jest wskazówką, skrótem lub innym podejściem do omawianego zadania. Zignorowanie uwagi nie powinno mieć żadnych negatywnych konsekwencji, ale można pominąć ułatwiającą życie sztuczkę.

Ważne

Pole ważne przedstawiają szczegóły, które mogłyby zostać łatwo pominięte: zmiany konfiguracji mające zastosowanie tylko w bieżącej sesji lub usługa wymagająca ponownego uruchomienia przed uwzględnieniem aktualizacji. Zignorowanie pól ważne nie spowoduje utraty danych, ale może wywołać irytację bądź frustrację.

Ostrzeżenie

Ostrzeżenia nie powinny być ignorowane. Zignorowanie ostrzeżeń najprawdopodobniej spowoduje utratę danych.

2. Opinie są mile widziane

Wysyłając raport błędu, upewnij się, że wspomniałeś identyfikator podręcznika: Common_Content
Jeśli masz sugestie, jak ulepszyć dokumentację, postaraj się być jak najbardziej szczegółowy opisując swój pomysł. Jeśli znalazłeś błąd, dołącz numer sekcji i pobliską cześć tekstu, abyśmy mogli łatwo go znaleźć.