Всё! Завершено гениальное творение не менее гениального программиста. Программное детище проверено, отлажено и перепроверено. Все найденные друзьями-тестерами "баги" благополучно устранены. А значит, пришло время распространить программу среди пользователей, которые раньше как-то умудрялись без неё обходиться... И вдруг понимаешь, что, несмотря на интуитивно-понятный интерфейс, в мире обязательно найдутся не интуитивно-понятливые "юзеры", которые не смогут насладиться всеми функциями данного произведения искусства, а то и вовсе (о, ужас!) удалят программу БЕЗВОЗВРАТНО. Смахнув со лба капли холодного пота и преисполнившись жалостью к таким "юзерам", всерьёз задумываешься о сопроводительной документации. На ум сразу же приходят мысли о файле "readme.txt" или о небольшой html-страничке, но тут же отметаются: в солидном проекте всё должно быть солидно. Так что придётся делать общепринятый файл *.hlp, который будет гордо называться "справочной системой". Как создавать файлы такого формата рассказывает данная статья.
Прежде всего, нам понадобится программа Microsoft Help Workshop. Найти её можно по адресу http://download.microsoft.com/download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe, также она распространяется вместе с популярными средами программирования (Delphi, VC++). Помимо этой "софтины", нам потребуется текстовый процессор для создания файла в формате RTF (rich-text format), Word от всё той же Microsoft вполне подойдёт.
Теперь можно приступить к процессу создания справочной системы, который состоит из трёх важных составляющих:
– подготовка RTF-файла;
– создание и компилирование файлов справочной системы;
– создание содержания справки.
Как известно, справка обычно разбивается на разделы. В RTF-файле каждый раздел должен начинаться заголовком и заканчиваться символом "разрыв страницы" ("Вставка\Разрыв..."). Кроме этого, раздел должен содержать уникальный идентификатор. Для его установки поместите текстовый курсор перед первым символом заголовка и из меню "Вставка" выберите пункт "Сноска...". В появившемся диалоговом окне (рис.1) в разделе нумерация установите радиокнопку в положение "Другая" и введите символ диеза ('#'). После нажатия на кнопку "OK", Word предложит ввести текст сноски, что и необходимо сделать. Следует заметить, что если текст сноски начинается с префикса IDH_, то во время компиляции справочной системы будет проверена корректность всех ссылок данного раздела.
Ссылки на другие разделы
Для связывания разных разделов используются слова-ссылки, при нажатии на которые осуществляется переход к нужной ветке справки. Для того, чтобы сделать слово ссылкой, нужно выделить его и подчеркнуть двойной линией ("Формат\Шрифт\Подчёркивание/Двойное"). После этого, сразу за словом-ссылкой, требуется поместить идентификатор нужного раздела (текст сноски). При запуске справки ссылка будет выделена цветом и одинарным подчёркиванием.
Комментарии
В документе можно использовать не только ссылки на другие разделы, но и ссылки на комментарии (например, для объяснения какого-нибудь заумного термина). Во время работы справочной системы такие ссылки выделяются цветом и подчёркиванием пунктирной линией, при нажатии на них появляется вплывающее окно с текстом комментария. В RTF-файле комментарии оформляются так же, как и разделы, но они не должны начинаться с заголовка. Ссылку на комментарий нужно подчеркнуть одной линией и сразу за ней написать его идентификатор скрытым текстом.
Ключевые слова и поиск по разделам
Для каждого раздела справки можно создать список ключевых слов. Для этого нужно перед заголовком раздела установить сноску K, а в текст сноски нужно записать все ключевые слова, разделив их точкой с запятой. При работе справочной системы ключевые слова всех разделов будут отображены в закладке "Указатель". Рядом с ней находится закладка "Поиск", в которой осуществляется поиск по справке. Для того, чтобы включить возможность поиска по какому-либо разделу, нужно перед его заголовком поставить сноску $, текстом которой должно служить название раздела в поисковой системе.
Вставка графики
Для вставки картинки в раздел, достаточно просто поместить её туда в Word'e ("Вставка\Рисунок").
General
Эта закладка содержит основные настройки справки:
Default topic – идентификатор основного раздела справки. Этот раздел появляется при запуске справочной системы (если она не имеет содержания) и в случае, если пользователь нажал на ссылку на несуществующий раздел.
Help title – заголовок справки, который отображается на заголовке окна.
Copyright information – текст, отображаемый в диалоговом окне "Версия" и текст, который автоматически добавляется при печати и копировании справки (подпись).
Сompression
Здесь находятся настройки сжатия справочной системы.
None – не использовать сжатие.
Maximum – максимальное сжатие (дольше компилируется, но занимает меньше места на диске).
Custom – позволяет выбрать алгоритмы сжатия справочной системы.
Files
Файлы, составляющие справочную систему.
Help File – имя файла справки (*.hlp);
Log File – имя log-файла (отчёт о компиляции справочной системы);
Rich Text Format (RTF) files – RTF-файлы (*.rtf);
Contents file – содержание справочной системы (*.cnt);
FTS (full-text search)
Настройки поисковой системы справки.
Generate full text search index – генерировать содержание поиска по справке. Если этот параметр выбран, то при компиляции справочной системы сгенерируется файл имя_справки.fts, который нужен для текстового поиска. Как правило, этот файл занимает намного больше места на диске, чем сама справка (*.hlp).
Теперь осталось сделать содержание для нашей справочной системы.
На этом создание полноценной справочной системы завершено. Наш маленький, но очень гордый "хелп" имеет удобное содержание и мощную поисковую систему, содержит как текстовую, так и графическую информацию, и даже подписывается при цитировании и распечатке!
Иван Ширко
ishyrko@gmail.com
среда, 28 ноября 2007 г.
Создание справочной системы
Создание RTF-файла
Оформление разделовСоздание файла справочной системы
Теперь, когда RTF-файл набран, можно приступить к созданию справки на основе этого файла. Запустите программу Microsoft Help Workshop и создайте новый проект, выбрав пункт меню "File\New/Help Project". В правой части окна программы нажмите на кнопку "Files..." и в появившемся диалоговом окне при помощи кнопки "Add" добавьте к проекту RTF-файл. Теперь пройдёмся по опциям справочной системы (кнопка "Options...").Создание содержания
Выберите "File\New/Help Contents" и введите имя и заголовок содержания. При помощи кнопок "Add Above" ("Добавить над") и "Add Below" ("Добавить под") создайте нужные папки (Heading) и пункты содержания (Topic). При добавлении пункта, введите его название в поле "Title", в "Topic ID" – идентификатор раздела справки, на который ссылается этот пункт, в "Help File" – имя файла справки, в котором находится этот раздел. Кнопки "Move Right" и "Move Left" служат для изменения иерархии пунктов. После сохранения содержания, откройте проект справки (*.hpj), нажмите на кнопку "Options", активизируйте закладку "Files" и в поле "Contents file" введите имя файла содержания либо выберите его при помощи кнопки "Browse". Откомпилируйте проект.
Подписаться на:
Комментарии к сообщению (Atom)
Комментариев нет:
Отправить комментарий