Создание справок

Содержание сайта
Разное
Создание справок
Обзор программ /
Список программ


Содержание

Список всех программ

Редакторы HTML
Редакторы CSS
Текстовые редакторы
Чтение текста
Записные книжки
Работа с изображениями
Создание карты сайта
Создание навигационных панелей (меню)
Создание мультипликации
Создание фотоальбомов
Видео
Создание карты ссылок
Веб - формы
Календари
Снимки экрана
Отборщики цвета
Комплект инструментов
Баннеры и эмблемы
Кнопки
Электронные книги
Формулы
Создание прототипов
Проверка ссылок
Работа с файлами
Работа с PDF

Создание справок

Переводчики

И другое

Введение

Интернет хорош тем, что он заполнен общедоступными справочными материалами по самым разным областям.
Задача - подать эти справочные материалы в самой удобной для использования форме.


Методы создания справок

Справки можно создавать вручную или использовать для этого специализированные программы.

Каждый, кто имеет некоторое представление о создании html-страниц, сможет быстро создать справку. Для этого достаточно создать страницы справки и оглавление. Оглавление содержит список тем (страниц), к которым можно быстро перейти, используя ссылки. Пример такой справки - данная страница (оглавление расположено на левой стороне страницы).

Другой метод, который более часто применяется при создание справок - это применение фреймов (рамок) см. Фреймы. В этом случает в одну из рамок помещают заголовок справки, в другую - оглавление справки, в третью - само содержание справки. Преимущество этого метода в том, что при просмотре страниц справки две первые рамки (с заголовком и оглавлением) остаются неизменными и загружается только содержание справки, т.е. отдельные страницы.

В том случае, когда справка должна иметь много разделов, под-разделов и страниц, указанные выше простые методы могут оказаться неудачными, т.к. оглавление справки начнет разрастаться в размерах и им становится неудобно пользоваться (Вы можете представить оглавление со списком страниц высотой в метр или более ?).

Для таких больших справок обычно применяется в качестве оглавления многоуровневый раскрывающийся список - при щелчке по разделу раскрывается дополнительный список под-разделов, при щелчке по под-разделу - раскрывается список составляющих его страниц. Обычно для создания справок достаточно трехуровневого раскрывающегося списка.

Для создания раскрывающегося списка применяется код JavaScript. Вы можете освоить  JavaScript и создавать код раскрывающихся списков самостоятельно.
Или Вы можете применить специальные программы, способные создавать раскрывающиеся списки в визуальном режиме, например Sothink DHTML Menu, Xara Menu Maker, Easy CSS Menu, HTML TreeView Generator и другие (см. Навигация - Обзор программ).
В этом случае достаточно вставить созданный спецпрограммой раскрывающийся список на страницу - и оглавление справки практически готово - см. Пример (раскрывающий список создан в бесплатной программе HTML TreeView Generator).

См. также Ручное создание справки

Еще более простой способ создания справок - применить программы, специально для этого предназначенные.
В этом случае даже не нужно знать html, css, javascript - работа во всех спецпрограммах по созданию справок ведется в визуальном режиме, и программа сама создает исходный код.

Некоторые программы позволяют добавлять к справке эффекты, используя jQuery (например - создается справка с временно исчезающим оглавлением, чтобы освободить место на экране компьютера).

На самом деле большинство программ для создания справок могут выполнять более широкие задачи - создавать не только справки, но различную техническую документацию, каталоги, обзоры коллекций, книги и пр. Короче говоря, программы для создания справок применяются, когда нужно систематизировать большой объем данных и подать его в наиболее удобной форме.


Форматы справок

Справки могут создаваться в нескольких форматах, из которых наиболее распространены форматы CHM, Web Help и HTML.

CHM (Compiled HTML Help) или HTML Help, или Windows CHM - формат Microsoft. Чаще всего формат используется, чтобы создать справки для программ (так называемые контекстные справки), работающих в системах Windows.
Формат CHM позволяет объединить несколько отдельных файлов  в один файл. Справка используется без подключения к Интернету.
Подробнее о формате CHM

Web Help или Browser-based Help - формат справки, которая размещается в Интернете  (на сайте). Как уже понятно из названия, для того чтобы можно было пользоваться справкой, нужно подключение к Интернету.
Подробнее о формате Web Help

HTML - Справка формата HTML может располагаться на Вашем сайте, и пользователи могут ее рассмотреть через свой браузер. При создании справки использованы фреймовая структура, html, css и нет javascript. Оглавление представляет из себя обычный (не раскрывающийся) список, нет поиска, списка индексированных слов и избранного.
Пример справки формата HTML (для сравнения - эта же справка в формате Web Help)

Также применяются и другие форматы справок -  PDF, в формате документов Word, e-Book,  JavaHelp и другие. Подробнее

При необходимости можно преобразовать один формат справки в другой, например преобразовать формат CHM к формату Microsoft Word (или наоборот).

Компиляция (сборка) - объединение отдельных файлов (html, css, javascript) в один файл. Пример скомпилированного файла - .chm.
Декомпиляция - операция, обратная компиляции (разборка единого файла на составляющие его части).


Контекстно-зависимая справка

Контекстно-зависимая справка позволяет пользователям легко переходить к  разделам справки, касающимся выполняемых ими операций в той или иной программе.

Для создания контекстно-зависимой справки используются справки формата CHM (для этого нужно, чтобы справка была "прикручена" к программе).
Справка программы обычно вызывается при щелчке по кнопке Help (Справка), которая имеется в большинстве программ, или с помощью клавиши F1. При этом открывается справка программы со всем ее содержимым.

Но контекстно-зависимая справка позволяет перейти не только к справке программы, а и к определенному разделу справки. При этом нужный раздел справки открывается при выполнении определенной операции или при воздействии на какой-то элемент интерфейса программы.


Элементы справки

Справка состоит из нескольких элементов:

Содержание справки - набор страниц справки

Оглавление -
обеспечивает переход к нужной странице справки
Оглавление также часто называют TOC (table of contents). Оглавление представляет из себя раскрывающийся список и расположено на левой стороне окна справки. Все пункты (под-пункты, страницы) оглавления помечены специальными значками.

Индекс (Index) - список индексированных (ключевых) слов. В список включаются слова (сочетания слов), которые облегчают пользователям справки переход к нужному разделу справки или к разъяснению некоторых слов и терминов. Список индексированных слов  создается автором справки.

Поиск - позволяет пользователям искать любое слово или фразу в справке. Программы по созданию справок создают поиск автоматически.

Избранное (Favorites или Bookmark) - Создается пользователем справки. В список избранного пользователь может включить все нужные ему разделы справки.


Обзор программ для создания справок

Список программ

Примечания:
1. В более широком смысле к программам для создания справок можно отнести также программы, которые способны создавать видео-обучающие материалы (
так называемые скринкасты) - см. Снимки экрана. В данный обзор включены некоторые из программ, подобного рода.
2. Вы можете создать справочник по любой теме, используя специальные программы - Записные книжки. Но такие справки нельзя разместить в Интернете, т.к. они просматриваются в программах-создателях. Поэтому эти справки создаются только для личного пользования.




Последнее обновление: июнь 2015 г.