Любой программист, написавший в жизни хотя бы пару программ, по окончании написания программы задумывался, как организовать справочную систему для своей программы. Написать справку в блокноте - это смешно. Составить справочное руководство при помощи мощного текстового процессора типа MS Word - тоже как-то не очень серьезно.
Самый лучший вариант - это сделать справку в современном формате chm, но нужно обладать определенными знаниями для создания справки в этом формате. Как оказывается, эти знания иметь вовсе и не обязательно. На помошь придет программа HelpNDoc, которую Вы можете скачать прямо с сайта по ссылке Скачать HelpNDoc .
Интерфейс программы сделан в ленточном стиле MS Office 2007. Хотя программа на английском языке, разобраться в ней сможет любой, кто хоть раз работал в тектовом редакторе MS Word. Тем не менее кратко опишу процесс создания справки при помощи данной программы и в конце приведу пример справочного руководства, ранее созданного мной для своей программы.
Файл справки в формате CHM. Этап №1. Создание проекта
Итак, при первоначальном запуске программа предложит нам три варианта:
New Project
- Новый проект
Open Project
- Открыть существующий проект
Import...
- данная опция позволит импортировать уже скомпилированный файл справки
Выберем опцию New Project . Откроется окно создания шаблона проекта справки, в котором можно задать имя проекта (Project Title ) и язык проекта (Project Language ), а также будет отображена таблица первоначального наполнения, которую можно импортировать из уже существующего проекта.
Директ
Отредактировав необходимые параметры, жмем кнопку Создать проект (Create Project ), после чего будет создан проект по выбранному шаблону.
Файл справки в формате CHM. Этап №2. Задание опций проекта
Далее все делается интуитивно. Щелкнув по первой кнопке Project Options и выбрав вкладку General settings , мы попадем в окно задания опций проекта, в котором можно задать Имя проекта, автора, версию проекта, написать комментарий, добавить строку Copyright, задать топик, который открывается по умолчанию ("топик" - это раздел вашей справки) и т. д.
На вкладке Generation Settings можно задать пути для формирования файлов справок. Кстати, HelpNDoc позволяет создавать справку не только в формате CHM, но и PDF, HTML и Word.
На вкладках CHM Settings и PDF Settings , можно задать различные параметры файлов справок, формируемых в формате CHM и PDF соответственно. Например, для формата CHM можно задать отображаемые кнопки, размер шрифта и т. д.
Файл справки в формате CHM. Этап №3. Добавление топиков
Для добавления топиков (разделов справки) служит команда Add topic . Подтопики добавляются командой Add child topic .
Менять параметры топиков (иконку топика, Help Context и т.д.) можно через контекстное меню самого топика.
Файл справки в формате CHM. Этап №4. Форматирование текста
На вкладке Write можно задавать различные параметры форматирования текста как в MS Word.
Вкладка Insert позволяет добавлять различные объекты в файл справки, например картинки, видео, документы, HTML-код и т.д. При добавлении картинки и щелчке по ней сразу же появляется контекстная вкладка Format , которая позволяет изменить параметры отображения картинки.
Файл справки в формате CHM. Этап №5. Сохранение проекта
При нажатии на кнопку дискеты, предлагается сохранить проект в формате HND - это формат программы HelpNDoc. При необходимости можно будет потом сохраненный таким образом проект открыть и продолжить его редактирование.
Файл справки в формате CHM. Этап №6. Генерация файла справки
После того, как проект будет полностью закончен, Вам останется только нажать кнопку Generate Help и сгенерировать файл справки.
Совсем забыл. Сгенерировать проект не получится, если у Вас не установлена программа Microsoft HTML Help WorkShop, которую можно скачать в интернете либо прямо с этого сайта по ссылке Скачать MS HTML Help WorkShop .
Ну и напоследок привожу пример файла справки, созданный некогда мной для программы на Delphi Скачать testchop.chm . Удачи.
Бесплатная программа для конвертирования файлов формата HTML в формат CHM. Скачать программу можно по адресу http ://yarix .by .ru .
После запуска программы открывается рабочее окно программы (Рис. 101).
Необходимо указать папку с файлами HTML. Для этого нажмите на кнопку Open folder (Открыть папку) (). В полях TOC (Оглавление) и Index (Индекс) имена генерируются автоматически по имени исходной папки. Опция Close window (Закрыть окно) предписывает закрывать данное окно после создания оглавления, так как оно больше не нужно. Опция Open TOC with Editor (Открыть оглавление для редактирования).
Оглавление собирается по содержимому тега < TITLE > в каждом файле HTML исходной папки. Опыт показывает, что в файлах HTML, скачанных из Интернета, обычно в тегах < TITLE > царит полная неразбериха: несколько файлов имеют один и тот же заголовок или вообще нечленораздельный текст. Создатели файлов гонятся за количеством, не вникая в детали. Поэтому мы подходим к опции Use file names instead of titles (Использовать имя файла вместо названий). По умолчанию в этой опции нет флажка, что предписывает программе собирать оглавление по тегам < TITLE >. Если в данной опции установлен флажок, то оглавление собирается по именам файлов HTML, а не по тегам < TITLE >.
Для начала сбора оглавления нажмите на кнопку Start (Старт). После этого в окне Generator (Генерация) показывается процесс выполнения задачи и после завершения окно Generator (Генерация) закрывается и открывается собранное оглавление для редактирования этого оглавления (Рис. 103).
По составу оглавления сразу видно - стоит ли конвертировать файл CHM или нет. Окно редактирования разделено пополам: в правой части выведено содержимое папки, на основе которой создавалось оглавление, а в левой части выведено оглавление, все описание будет вестись именно по этой части. Если в оглавлении имеются какие-либо ошибки, то их можно поправить здесь же:
Во-первых, можно выделить строку с несоответствующей записью и нажать на кнопку Edit (Редактирование) () или нажать на клавишу F4 на клавиатуре ПК. После этого открывается содержимое файла, заголовок которого мы выделили, в программе Блокнот. Здесь можно скорректировать заголовок тега < TITLE > и сохранить файл. Оглавление можно потом будет переделать;
Во-вторых, щелкнуть по выделенной записи правой клавишей мыши и из открывшегося контекстного меню выполнить команду Rename (Переименовать) или нажать на клавишу F2 на клавиатуре ПК.
Кнопка Preview (Предварительный просмотр) () или клавиша F3 на клавиатуре ПК открывает выбранный файл HTML в браузере, выбранном по умолчанию.
Кнопка Delete (Удалить) () или клавиша F8 на клавиатуре ПК удаляет выделенную строку в оглавлении.
Списки Size (Размер) и Font (Шрифт) определяют размер и гарнитуру шрифта, которыми будет оформлен текст оглавления. В списке Icon (Миниатюра) предлагаются образцы миниатюр или иконок, которые находятся слева от имени заголовка в оглавлении.
Кнопка Sort (Сортировка) () становится доступной только после выделения самой книги (Root ), то есть самого верхнего уровня книги. Миниатюрная треугольная кнопочка рядом с этой кнопкой открывает варианты сортировки.
Сохраните изменения в оглавлении и закройте это окно. После этого программа возвращается в окно (Рис. 101).
В следующих сеансах работы с файлом CHM можно вернуться к корректировке оглавления. Для этого в главном рабочем окне нажмите на кнопку Editor ().
Кнопка Compiler (Компилировать) () открывает одноименное окно (Рис. 104). С помощью этой кнопки мы создадим файл CHM.
В поле Folder (Папка) указывается папка, в которой находятся исходные файлы HTML для конвертирования их в файл CHM. Для этого нажмите на кнопку Open folder (Открыть папку) () и укажите нужную папку.
В списке Preset (Шаблон) выбирается шаблон для создания файла CHM. По умолчанию предлагается пресет Help, который чаще всего можно применять при создании файлов CHM . Для просмотра или для редактирования пресета нажмите на кнопку Open preset (Открыть пресет) (). После этого открывается окно Preset Editor (Редактор пресета) (Рис. 105).
 |
Рис. 105. Параметры пресета Help |
В верхнем левом углу окна находится список пресетов. Для просмотра образца пресета выберите пресет и нажмите на кнопку Test (Тест).
На панели Pane (Панель) определяются параметры панели, которая находится в левой части окна с книгой CHM (Рис. 106). На нее выводится, например, оглавление книги. В поле Width (Ширина) определяется ширина этой панели.
В списке Default tab (Вкладка по умолчанию) выбирается вкладка, которая должна быть открыта по умолчанию после загрузки книги CHM.
В списке Position (Позиция) определяется местоположение ярлычком с заголовками вкладок. По умолчанию они находятся в верхней части панели (Top ), но их можно расположить слева или внизу панели Pane (Панель).
Опция Pane opened (Открыть панель) предписывает открывать панель Pane (Панель) при загрузке книги CHM. Следующие опции (Contents , Index , Favorites ) определяют вкладки, которые должны быть на панели Pane (Панель). Обычно на этой панели 3 вкладки: Содержание, Указатель, Избранное (Рис. 106).
На панели Window (Окно) определяются параметры панели с текстом книги (правая часть окна). Параметры Width (Ширина) и Height (Высота) определяют ширину и высоту окна с книгой после ее открытия. Параметры Left (Слева) и Top (Сверху) определяют размеры отступа от левого верхнего угла окна с книгой.
Из элементов управления по умолчанию включена только инструментальная панель (Toolbar ) с кнопками. Но можно открыть и меню (Menu ). Окно можно развернуть по весь экран (Maximized ).
На панели Toolbar (Инструментальная панель) определяется, какие кнопки будут видны в окне с книгой CHM.
Кнопка Add (Добавить) добавляет новый пресет, а кнопка Delete (Удалить) удаляет выбранный пресет.
После определения всех параметров пресета нажмите на кнопку ОК для возвращения в окно Compiler (Компилировать) (Рис. 104).
В поле Title (Заголовок) указывается заголовок книги CHM, который будет выводиться в окне при чтении книги CHM (Рис. 106). Заголовок считывается из тега < TITLE > главного файла HTML. В поле Home (Домой) указывается главный файл HTML. Этот файл будет открываться, когда в книге CHM будет нажата кнопка Home (Домой). В поле Output (Выход) указывается имя файла CHM и путь к этому файлу. Имя выходного файла CHM берется из имени папки с файлами HTML. Чтобы указать путь к папке, в которую следует сохранять файл CHM, нажмите на кнопку () и укажите эту папку.
В полях TOC (Оглавление) и Index (Индекс) указываются файлы с оглавлением и индексами файлов, которые мы создали предварительно в самом начале работы над проектом. Имена появляются сразу же после выбора папки в поле Folder (Папка).
В списке Language (Язык) выбирается язык книги. Русский язык там присутствует.
Кнопка << скрывает некоторые параметры из данного окна, а кнопка >> снова их выводит в этом окне для настройки.
Опция Close window (Закрыть окно) закрывает окно Compiler (Компилировать).
Опция Show statistic (Показать статистику) показывает результат конвертирования файла CHM.
Опция Show output file (Показать выходной файл) показывает выходной файл CHM.
Опция Delete input folder (Удалить исходную папку) удаляет исходную папку с файлами HTML, на основе которых создавался файл CHM. Очень опасный параметр, так как файл CHM может получиться некорректно и пользователь может узнать об этом спустя какое то время, когда исходных файлов уже не будет.
В списке Format (Формат) выбирается расширение или формат выходного файла. Все время мы говорили только о формате CHM, который здесь предлагается по умолчанию. В этом файле можно также выбрать формат ITS (Internet Document Set ).
После определения всех параметров нажмите на кнопку Start (Старт). Результат выполнения задания будет показываться на индикаторной полосе Ready (Выполнение). После завершения создания файла CHM выводится сообщение об этом.
Готовый файл CHM можно открыть для чтения (Рис. 106).
Файл CHM можно декомпилировать в файлы HTML. Для этого в главном рабочем окне нажмите на кнопку Decompiler (). После этого открывается одноименное окно (Рис. 107).
В поле File (Файл) укажите файл в формате CHM. Для этого нажмите на кнопку () и укажите исходный файл. В поле Folder (Папка) нужно указать папку, в которую будут сохранены извлекаемые файлы. Извлекаться будут не только файлы HTML, но рисунки и другие объекты. Нажмите на кнопку () и укажите нужную папку. Нажмите на кнопку Start (Старт) для начала извлечения файлов.
Файловый формат.chm был создан компанией Майкрософт в 1997 году. Он должен был заменить расширение.hlp, которое использовалось для справочной информации. CHM – аббревиатура от английского “Compressed HTML Help”. Это значит, что материалы такого формата имеют стандартную интернет-разметку HTML, содержат гиперссылки и могут иметь многоуровневую структуру разделов. Благодаря возможности размещать анкоры внутри и между статьями расширение.chm также стали использовать различные компании и обычные пользователи. Помимо справочной информации о работе операционной системы, в этом формате сохраняют другие данные, например, образовательные буклеты или руководства пользователя.
Во всех десктопных операционных системах Майкрософт, начиная с Windows 98, есть встроенная утилита для чтения документов с расширением.chm. Прежде чем использовать ее, убедитесь, что название документа написано латиницей и не содержит символов “_” (нижнее подчеркивание) или “#” (шарп). Из-за кириллических букв файл может не открыться стандартной программой. Переименуйте документ, если не уверены, что их нет в названии. Далее в ОС Виндовс дважды щелкните мышью по иконке файла. Открытая chm-справка выглядит примерно так: Если документ не открывается кликом мышки, попробуем вручную запустить утилиту, предназначенную для его чтения. Для этого подведите курсор к файлу, нажмите правую клавишу и выберите раздел «Открыть с помощью», далее щелкните пункт «Выбрать программу». В появившемся окне придавите клавишу «Обзор». Таким способом вы попадете в каталог установленных в вашей ОС программ – “Program Files”. Но нужная утилита находится в папке “Windows”, поэтому вернитесь к списку системных разделов диска C. Зайдите в каталог “Windows” и найдите программу “hh”. Выделите ее курсором и нажмите «Открыть», а затем «ОК» в окне «Выбор программы». Если файл не открывается, проверьте, не заблокирован ли он для чтения. Для этого щелкните по документу правой клавишей мыши, выберите раздел «Свойства». Далее откройте вкладку «Безопасность». Если в графе «Чтение» есть отметка «Запретить», перейдите в раздел «Дополнительно».
Файл в формате CHM предназначен для отображения справочной документации. Скомпилированный файл справки в формате HTML (.chm) разработан корпорацией.
Файл справки в формате CHM (Compiled Help Modules) по умолчанию открывается утилитой, встроенной в операционную систему. Для открытия файла в этом формате достаточно два раза кликнуть по файлу CHM мышью, или открыть файл в соответствующей программе, которая имеет справочную информацию в виде файла данного типа, из меню управления приложения.
Чем еще можно открыть файл справки с расширением CHM? С помощью сторонних программ, файл справки CHM можно открыть в программах: 7-Zip, и некоторых других.
Не открывается файл CHM
В некоторых случаях, файл справки с расширением CHM не открывается:
- если файл CHM находится на сетевом диске, то для открытия файла нужно скопировать файл справки на компьютер
- если в имени файла есть кириллица или специальные символы, то нужно переименовать файл, дав файлу имя буквами латинского алфавита
Не отображается содержимое файла CHM
Намного чаще встречаются другой вариант: сам CHM файл запускается из программы, или непосредственно после клика по файлу, но содержимое справки не отображается. Открыто только содержание документа.
На написание этой статьи меня надоумил случай, происшедший со мной. Я писал обзор программы IrfanView. Программа поддерживает русский язык, но файлы для русификации программы, устанавливаются после установки программы. После установки языкового пакета, я запустил файл справки в программе, и увидел, что содержимое CHM файла не отображается.
Операционная система Windows блокирует отображение файла справки с целью защиты компьютера.
Что делать? На самом деле, я знаю, что следует сделать, так как ранее уже сталкивался с подобной проблемой. Я продумал, что некоторые пользователи также могут столкнуться с таким вариантом запуска документа. Человек надеется получить ответы на свои вопросы, а вместо этого, получает пустое содержание файла справки, отображается только оглавление.
Сначала необходимо найти скомпилированный файл справки в формате CHM на компьютере. В большинстве случаев, он расположен в папке установленной программы.
После этого откроется окно «Свойства: имя_файла». В нижней части окна вы увидите предупреждение: «Осторожно: этот файл получен с другого компьютера и, возможно, был заблокирован с целью защиты компьютера».
Вы можете снова открыть файл справки CHM и увидеть, что теперь содержимое справки отображается.
Выводы статьи
Скомпилированный HTML-файл справки в формате CHM можно открыть с помощью средства операционной системы, или с помощью сторонних программ. В некоторых случаях, Windows блокирует содержимое файла справки для защиты компьютера, поэтому файл CHM можно разблокировать для отображения содержимого помощи.
Введение
Интернет хорош тем, что он заполнен общедоступными справочными материалами по самым разным областям.Задача - подать эти справочные материалы в самой удобной для использования форме.
Методы создания справок
Справки можно создавать вручную или использовать для этого специализированные программы.
Каждый, кто имеет некоторое представление о создании 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 позволяет объединить несколько отдельных файлов в
один файл. Справка используется без подключения к Интернету.
Web Help
или
Browser-based 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. Вы можете
создать справочник по любой теме, используя специальные программы - Записные
книжки
.
Но такие
справки нельзя
разместить в Интернете, т.к. они просматриваются в
программах-создателях. Поэтому эти справки создаются только для личного
пользования.
