Documentation 0.1

Common Content

Видання 0

Logo

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. Домовленості, що використовуються у документі
1.1. Топографічні домовленості
1.2. Умовне позначення цитування
1.3. Примітки та попередження
2. Нам потрібні ваші відгуки!

(preface title goes here)

1. Домовленості, що використовуються у документі

У цьому документі прийняті домовленості для виділення певних слів чи фраз та привертання уваги до частин інформації.
У паперовій та PDF версіях цього документу використовуються шрифти гарнітури Liberation Fonts. Набір шрифтів Liberation також використовується у HTML-версії, якщо вони встановлені у вашій системі. Примітка: шрифти Liberation входять до складу Red Hat Enterprise Linux 5 та старших версій.

1.1. Топографічні домовленості

Для виділення тексту використовуються чотири стилі, що вказуються далі.
Моноширинний жирний шрифт
Використовується для виділення інформації, що вводиться у систему, включаючи команди оболонки, назви файлів та шляхів до файлів. Також використовується для виділення назв клавіш та комбінацій клавіш. Наприклад:
Щоб вивести зміст файлу my_next_bestselling_novel у поточному каталозі, введіть у командному рядку cat my_next_bestselling_novel та натисніть Enter.
У наведеному вище прикладі вказано назву файлу, команду оболонки та назву клавіші, які виділено моноширинним жирним шрифтом.
Для розділення окремих клавіш у складі комбінацій клавіш використовується знак тире. Наприклад:
Для виконання команди натисніть Enter.
Для перемикання на перший віртуальний термінал натисніть Ctrl+Alt+F1. Щоб повернутись до вікна сеансу X-Window, натисніть Ctrl+Alt+F7.
У першому прикладі виділено назву клавіші. У другому - комбінації клавіш, клавіші при цьому натискаються одночасно.
Цим же шрифтом виділяються тексти програми, назви класів, методи, функції, назви змінних та значення, що повертаються. Наприклад:
Класи для роботи з файлами включають: filesystem - клас для роботи з файловою системою, 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 приймає запити, він розподіляє їх серед дочірніх процесів та потоків виконання. Така група процесів чи потоків виконання відома як пул сервера. У сервері Apache HTTP версії 2.0, відповідальність за створення та підтримку цих серверних пулів покладено на групу модулів із назвою Multi-Processing Modules (MPMs). На відміну від інших модулів у сервер Apache HTTP може бути завантажений лише один модуль з групи MPM.

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. Примітки та попередження

Зрештою, для привертання уваги до важливої інформації використовуються три візуальні стилі.

Примітка

Примітка зазвичай містить додаткову інформацію. Ігнорування примітки не матиме негативних наслідків, але ви можете пропустити пораду, яка спростить вашу роботу.

Важливо

На інформацію, що позначена важливою, слід звернути увагу. Вона може включати зміни у конфігурації, що стосуються лише поточної версії, або служби, які слід перезапустити перш ніж буде застосовано оновлення. Ознайомлення з важливою інформацією може значно спростити вашу роботу.

Попередження

Попередження не слід ігнорувати. Попередження містять важливу інформацію, що може запобігти втраті даних.

2. Нам потрібні ваші відгуки!

При надсиланні повідомлення, не забудьте вказати ідентифікатор документу довідки: Common_Content
Якщо ви маєте пропозиції щодо вдосконалення документації, намагайтесь точніше описати їх. Якщо знайшли помилку, будь ласка, включайте номер розділу та уривок тексту поблизу помилки, щоб її можна було швидко знайти.