1. Домовленості, що використовуються у документі
У цьому документі використано певні домовленості щодо позначення певних слів чи фраз та привертання уваги до частин інформації.
Для привернення уваги до певних частин тексту використано чотири типографічних стилів. Нижче наведено опис цих стилів та обставин, за яких їх застосовують.
Моноширинний жирний
Використовується для позначення інформації, що вводиться до системи, зокрема команд оболонки, назв файлів та їх адрес. Крім того, використовується для позначення назв клавіш та комбінацій клавіш. Приклад:
Щоб переглянути вміст файла my_next_bestselling_novel у поточному каталозі, введіть у командному рядку команду cat my_next_bestselling_novel та натисніть Enter, щоб наказати системі виконати команду.
У наведеному вище прикладі вказано назву файла, команду оболонки та назву клавіші, які позначено моноширинним жирним шрифтом.
Для відокремлення клавіш у складі комбінацій клавіш використовується знак дефіса. Приклад:
Щоб виконати команду, натисніть Enter.
Для перемикання на перший віртуальний термінал натисніть Ctrl+Alt+F2. Щоб повернутись до вікна сеансу X-Window, натисніть Ctrl+Alt+F1.
У першому прикладі позначено назву окремої клавіші. У другому — дві комбінації клавіш (кожна є сукупністю трьох клавіш, які слід натискати одночасно).
Цим же шрифтом позначаються тексти програми, назви класів, методи, функції, назви змінних та значення, що повертаються. Приклад:
До класів для роботи з файлами належать: filesystem — клас для роботи з файловою системою, file — для роботи з файлами, та dir — для роботи з каталогами. З кожним класом пов'язаний власний набір прав доступу.
Пропорційний жирний
Цим шрифтом позначаються слова та фрази, що зустрічаються у системі, зокрема назви програм, текст з діалогових вікон, назви кнопок, інші елементи графічного інтерфейсу, пункти меню. Приклад:
Щоб запустити програму Параметри миші, виберіть у головному меню . Щоб зробити головною кнопкою праву кнопку миші, замість лівої, на вкладці Кнопки, позначте пункт Під ліву руку і натисніть на кнопку Закрити (це зробить мишу зручною для використання лівою рукою).
Щоб вставити спеціальний символ у файлі gedit, у головному меню виберіть . Потім, виберіть у меню Таблиця символів, введіть назву символу у полі Пошук та натисніть Наступний. Символ, який ви шукаєте, буде позначено у полі Таблиця символів. Двічі клацніть на позначеному символі, щоб помістити його у поле Текст для копіювання, а потім натисніть кнопку Копіювати. Тепер поверніться назад до вашого документа і скористайтеся пунктом меню gedit.
Наведений вище текст містить назви програм; загальносистемні назви пунктів меню; специфічні для програми пункти меню; назви кнопок та інших елементів графічного інтерфейсу, усі вони позначаються пропорційним жирним шрифтом та розрізняються за контекстом.
Моноширинний жирний курсивПропорційний жирний курсив
Обидва стилі означають текст, який треба замінити чи змінний текст. Курсив вказує, що текст не слід вводити дослівно, а змінити його залежно від параметрів. Приклад:
Щоб з'єднатись з віддаленим комп'ютером через ssh, введіть у командному рядку ssh ім'я_користувача@назва.домену. Наприклад, якщо назва віддаленого комп'ютера example.com а назва облікового запису john, введіть ssh john@example.com.
Команда mount -o remount файлова_система повторно монтує файлову систему. Наприклад, для повторного монтування файлової системи /home, слід вказати команду mount -o remount /home.
Щоб побачити версію встановленого пакету, скористайтеся командою rpm -q пакунок. Вона поверне результат у вигляді: пакунок-версія-випуск
У наведених прикладах жирним курсивом позначаються ім'я_користувача, назва.домену, файлова система, пакет, версія та випуск. Кожне слово замінюється при вводі на фактичну команду, що вводиться або замінюється при виводі справжнім текстом, який покаже система.
Також курсивом позначається перше використання нового та важливого терміну. Приклад:
Publican — це система публікації документів, заснована на DocBook.
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"));
}
}
