Documentation 0.1

Common Content

Редакция 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. Соглашения документа

В этом руководстве используются различные стили для выделения текста.
В PDF- и бумажной версиях руководства используются шрифты семейства Liberation. Эти же шрифты будут использоваться для отображения HTML-версии, если они установлены в вашей системе. Замечание: Red Hat Enterprise Linux 5 и более поздние версии включают в свой состав комплект Liberation по умолчанию.

1.1. Типографические соглашения

Для выделения текста используются четыре стиля, которые будут перечислены далее.
Моноширинный жирный шрифт
Используется для выделения системного ввода, включая команды оболочки, а также имена файлов, пути и комбинации ключей. Пример:
Чтобы просмотреть содержимое файла my_next_bestselling_novel в текущем рабочем каталоге, в строке приглашения оболочки введите cat my_next_bestselling_novel и нажмите Enter для выполнения этой команды.
Приведенный текст содержит имя файла, команду оболочки и имя клавиши, которые выделены моноширинным жирным шрифтом.
Для разделения клавиш в составе комбинаций используется дефис. Пример:
Нажмите Enter для исполнения команды.
Нажмите Ctrl+Alt+F1 для перехода в первый виртуальный терминал. Нажмите Ctrl+Alt+F7 , чтобы вернуться в сессию X-Windows.
В первом примере жирным шрифтом выделено название отдельной клавиши, во втором – комбинаций клавиш.
Этим же шрифтом выделяются имена классов, методов, функций, переменных и возвращаемые значения в составе кода. Пример:
Классы файлов включают filesystem для файловых систем, file для файлов, dir для каталогов. Каждому классу соответствует набор разрешений.
Пропроциональный жирный шрифт
Выделяет системные слова или фразы, что включает имена приложений, текст диалога, элементы графического интерфейса, названия меню. Пример:
В главном меню выберите Система > Параметры > Мышь для запуска утилиты Настройки мыши. На вкладке Кнопки установите флажок Настроить мышь под левую руку и нажмите кнопку Закрыть, чтобы настроить мышь для левши.
Чтобы вставить специальный символ в файл gedit, выберите Приложения > Стандартные > Таблица символов. Затем в меню выберите Поиск > Поиск…, введите имя символа и нажмите кнопку Найти следующее. Найденный символ будет выделен в таблице символов. Дважды щелкните на этом символе, чтобы вставить его в поле Текст для копирования и нажмите кнопку Копировать. Теперь вернитесь к вашему документу и в меню выберите Правка > Вставить.
Приведенный выше текст содержит имя приложения, названия меню, кнопок и элементов графического интерфейса.
Обратите внимание, что для обозначения переходов между уровнями меню используется символ >.
Моноширинный жирный курсив или пропорциональный жирный курсив
Оба типа выделения обозначают изменяемый или заменяемый текст. Курсив сообщает о том, что не следует вводить приведенный текст напрямую, а изменить в соответствии с вашими настройками. Пример:
Для подключения к удаленной машине с помощью SSH в строке приглашения выполните ssh имя_пользователя@имя_домена. Скажем, имя удаленной машины – example.com, а ваше имя пользователя – john, тогда команда будет выглядеть так: ssh john@example.com.
Команда mount -o remount файловая_система осуществит повторное монтирование заданной файловой системы. Например, для /home команда будет выглядеть так: mount -o remount /home.
Чтобы просмотреть версию установленного пакета, выполните команду rpm -q пакет. Результат команды будет представлен в формате пакет-версия-выпуск.
В приведенных примерах жирным курсивом выделяются имя пользователя, имя домена, файловой системы, пакет, его версия и выпуск.
Также курсивом выделяются термины, которые встречаются в тексте документа впервые. Пример:
Когда сервер HTTP Apache принимает запросы, для их обработки выделяются дочерние процессы или потоки. Группа таких процессов (потоков) известна как серверный пул. В Apache 2.0 за создание таких групп отвечают многопроцессорные модули. В отличие от других модулей, только один модуль из группы может быть загружен сервером HTTP Apache.

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.
Если Вы хотите предложить улучшения руководства, постарайтесь описать предложения максимально подробно. Если Вы нашли ошибку, пожалуйста, укажите номер раздела и текст вокруг, чтобы мы могли её быстро найти.