1. Установени практики за оформяне на документи
Това ръководство използва няколко установени практики, с които се обръща внимание на определени думи, фрази или специфични части от информация.
1.1. Шрифтови спецификации
Четири метода се използват за да се обърне внимание на специфични думи и фрази. Това са:
Сбито Удебеляване
Използва се за посочване на системно въвждане, включително и конзолни команди, имена на файлове и пътя до тях, имена на клавиши или комбинация от клавиши. Например:
За да видите съдържанието на файл my_next_bestselling_novel във вашата текуща директория, въведете cat my_next_bestselling_novel в конзолата и натиснете Enter.
Примерът включва име на файл, команда и име на клавиш, всичките показани в Сбито Удебеляване и различими в контекста.
Клавишните комбинации се различават от имената на клавишите по това, че всяко копче от комбинацията е свързано с тире. Например:
Натиснете Enter, за да изпълните командата.
Натиснете Ctrl+Alt+F1, за да превключите на първия виртуалнен терминал. Натиснете Ctrl+Alt+F7, за да се върнете до X-Windows сесията.
Първото изречение посочва конкретния клавиш, който трябва да се натисне. Второто посочва два набора от три клавиша, всеки един от които трябва да се натисне едновременно с другите.
Ако се обсъждат програмни кодове, класове, методи, функции, променливи и връщани стойности, споменати в един абзац, то те ще бъдат представени като по-горе, в Сбито Удебеляване. Например:
Класовете свързани с файлове включват файлова система за файловата система, file за файловете, и dir за директориите. Всеки файл има свой асоцииран набор от позволения.
Пропорционално Удебеляване
С този шрифт се обозначават думи или фрази, срещнати в процес на работа със системата, включително имена на приложения; текст в диалогови кутии; етикети на тик-кутии; етикети на радио и други бутони; заглавия на менюта и подменюта. Например:
Изберете от бутона за главното меню Предпочитания към Мишка. В табулатора Бутони , щракнете на тик-кутията Мишка за лява ръка и след това Затвори , за да размените местата на левия и десния бутон(режим,подходящ за левичари).
За да вмъкнете специален символ в gedit файл, изберете от бутона за главното меню. След това изберете от менюто на Таблица със знаци , напишете името на символа в полето Търсене и натиснете Следващ. Символът,който търсехте ще бъде посочен в Таблицата със знаци. Двойно щракване върху посочения символ ще го постави в полето Текст за копиране след това кликнете на бутона Копирай Сега се върнете обратно в документа и изберете от менюто на gedit .
Текстът по-горе включва имена на приложения; имена на системни менюта и обекти; имена на програмни менюта; бутони и текст в потребителски интерфейс, всички представени в Пропорционално Удебеляване и всички различими в контекста.
Обърнете внимание на записа , използван за посочване на преминаването през менютата и подменютата. Това е,за да се избегнат сложните за проследяване стъпки 'Изберете от подменюто в менюто от главното меню'.
Ръкописно Сбито УдебеляванеРъкописно Пропорционално Удебеляване
Прибавянето на 'Ръкописно' към Сбито Удебеляване и Пропорционално Удебеляване предполага заместим или вариращ текст. 'Ръкописно' означава, че текста не трябва да се въвежда буквално или че се променя според определени условия. Например:
За да се свържете с отдалечена система чрез ssh, напишете в конзолата ssh потребителско име@име.на.домейна. Ако отдалечената система е example.com и вашето име на тази система е john, напишете ssh john@example.com.
Командата mount -o remount файлова система монтира отново посочената файлова система. Например, за да монтирате отново файловата система /home, командата е mount -o remount /home.
За да видите версията на вече инсталиран пакет, използвайте командата rpm -q пакет. Ще се покаже резултат, както следва: пакет-версия-редакция
Забележете думите по-горе в ръкописно удебеляване: тире, потребителско име, име.на.домейна, файлова система, пакет, версия и редакция. Всяка дума определя или мястото, където вие трябва да въведете текст или текст, изписван от системата.
Като изключим стандартната употреба за заглавие на работа, ръкописният шрифт означава използване за първи път на важен термин или новина. Например:
Когато Apache HTTP Server приема заявка, той ги разбива на подпроцеси, за да може да се справи с тях. Тези подпроцеси са познати като server-pool. Под Apache HTTP Server 2.0, отговорността за създаването и управлението на тези server-pools е поверена на група от модули, наречени Multi-Processing Modules (MPMs). За разлика от другите модули, само един модул от групата MPM може да бъде зареден от Apache HTTP Server.
1.2. Практика за отделяне на различни типове
Два типа данни, обикновено многоредови, са отделени от заобикалящия ги текст.
Изходът, изпратен до конзолата е поставен в Печатно Сбито Удебеляване и е представено така:
books Desktop documentation drafts mss photos stuff svn
books_tests Desktop1 downloads images notes scripts svgs
Програмният код също се поставя в Печатно Сбито Удебеляване, но се представя и отличава както следва:
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. Забележки и Предупреждения
Най-накрая, вече използваме три визуални стила за наблягане на информация, която в друг случай би могла да бъде пренебрегната.
Забележка
Забележката е полезен съвет или кратък път за алтернативно изпълнение на належаща задача. Пренебрегването на забележка не би трябвало да има негативни последици, но може да пропуснете трик, който би направил живота ви по-лесен.
Важно
Кутиите с "Важно!" съобщение напомнят събития, пропуснати по-рано: конфигурационни промени, които засягат текущата сесия или услуги, които трябва да бъдат рестартирани преди обновление да встъпи в действие. Пренебрегване на кутия с "Важно!" съобщение няма да предизвика загуба на данни, но може да ви струва ядове и объркване.
Предупреждение
Предупрежденията не трябва да се игнорират или рискувате загуба на данни.