Создание справочной системы. Описание возможностей HTML Help Workshop

HTML Help Workshop это среда разработки справочных материалов на базе Microsoft Help. Приложение включает функциональный конструктор с интеграцией ActiveX компонентов. Поддерживается вставка html разметки, растровых файлов и скриптов на Visual Basic Scripting Edition и JScript языках создания сценариев. Позволяет генерировать интуитивные справочники с интерактивными разделами, активными ссылками, мультимедийными данными.

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

Конструктор используется при работе с новыми приложениями, может выступать в качестве дополнения в сторонних инструментах разработки.

Скачать бесплатно полную русскую версию HTML Help Workshop с официального сайта без регистрации и смс.

Системные требования

• Поддерживаемые ОС: Windows 10, XP, Vista, 8.1, 7, 8
• Разрядность: x86, 64 bit, 32 bit

На лекции осваиваются приемы разработки справочной системы и подключения этой системы к проекту Lazarus.

Создание справочной системы

Любой серьезный проект должен быть снабжен подробной справочной системой, позволяющей пользователю разобраться с тем, как работает ваша программа . Ведь если бы не "хэлпы", мы с вами вряд ли смогли самостоятельно освоить какую-нибудь сложную программу. И в этой лекции мы научимся создавать справочные системы и подключать их к проекту. Напомню, что хоть Lazarus и является кросс-платформенной средой разработки программ, мы осваиваем работу с ним под управлением ОС Windows . Если вы пользуетесь Lazarus в среде Linux, Unix или другой не Windows ОС, то рекомендации из этой лекции вам вряд ли подойдут. В этом случае, вам придется поискать данный материал самостоятельно.

Итак, справка может быть двух форматов: *.hlp и *.chm. Оба формата разработаны корпорацией Microsoft. Формат HLP является устаревшим, хотя и встречается до сих пор, но в настоящий момент наиболее распространенным форматом справки в среде Windows является CHM, его и рассмотрим.

CHM (Microsoft Compressed HTML Help , Microsoft Compiled HTML Help , CHM) - формат файлов контекстной справки, разработанной Microsoft в 1997 году в качестве замены формата WinHelp - HLP. Файл CHM является сжатым набором HTML -страниц, своего рода, электронной книгой, и может содержать весь набор Web-страниц: текст, таблицы, рисунки, ссылки, медиа-файлы, и прочее, что делает такую справочную систему мощным инструментом. Все входящие в CHM-справку файлы сжаты алгоритмом LZX, что делает справку более компактной.

В Интернете я нашел упоминание, что в состав Lazarus входит инструмент для создания CHM-файлов. И в самом деле, я нашел этот инструмент по адресу (папки установки Lazarus у меня создавались по умолчанию):

C:\lazarus\tools\chmmaker

По этому адресу я нашел проект, который по идее, нужно скомпилировать, и получить готовый инструмент. Впрочем, достаточно взглянуть на окно проекта, чтобы понять, насколько данный инструмент примитивен. Говорить серьезно о создании с его помощью справочной системы не приходится. А значит, нам нужно найти другой инструмент.

Этот инструмент должен быть:

• бесплатным;
• достаточно мощным для создания справок любой сложности.

И тут на ум сразу приходят две программы: HTM2CHM и Microsoft HTML Help Workshop . Первая написана русским программистом Ярославом Кирилловым, обладает русским и достаточно дружелюбным интерфейсом. Функционально она проигрывает Microsoft HTML Help Workshop . Кроме того, компилируемые программой CHM-файлы получаются несколько большего размера. Однако если требуется простая небольшая справка, то лучшего инструмента вам не найти. Мы не будем рассматривать программу HTM2CHM, поскольку она достаточно проста, вам нетрудно будет освоить её самостоятельно. Рассмотрим более сложный инструмент - Microsoft HTML Help Workshop . Как видно из названия, программа разработана корпорацией Microsoft, является бесплатным, свободно распространяемым продуктом. Скачать её можно с сайта производителя, я нашел её по адресу: http://www.microsoft.com/en-us/download/details.aspx?id=21138

Или же вы можете скачать этот инструмент с моего сайта, который задумывался для поддержки этого курса: http://lazarusprog.tk/files/htmlhelp.rar

Это HTML Help Workshop версии 4.74.8702 - программа для создания справочной системы.

HTML Help Workshop (hhw.exe) - программа , обладающая достаточно большими возможностями, хотя и непростая в эксплуатации, и не имеет русского интерфейса. Программа позволяет создавать все необходимые файлы справки, из которых затем компилируется единый проект.

Давайте вообще, разберемся, что представляет собой CHM-справка. По сути, это электронная интерактивная книга, позволяющая использовать содержание, индексы (тэги), полнотекстовый контекстный поиск , избранные статьи справки. И всё это создается на основе отдельных HTML -файлов. И вот теперь мы подходим к другому вопросу: что такое HTML ? HTML - Hyper Text Markup Language - Язык разметки гипертекста, основа, на которой строятся все Web-сайты, те самые веб-странички, которые мы загружаем в свои браузеры. Получается, чтобы создавать справочную систему, требуется изучить ещё какой то HTML ? В общем, да, если вы будете использовать только встроенные средства HTML Help Workshop . Веб-страничку можно написать в любом текстовом редакторе, хоть в Блокноте, если вы знаете разметку HTML . Однако конечно, есть и более простые пути.

Существует множество визуальных редакторов, которые позволяют сохранять содержимое в виде HTML -файлов. В первую очередь приходит на ум офисная программа MS Word . Да, она также позволяет создавать HTML -файлы, однако не советую её использовать: внутри таких файлов очень много лишних тегов - мусора. Кроме того, ссылки на изображения в HTML -файлах должны быть представлены тегом img , например:

а MS Word вставляет изображения в коллекцию Shapes .

Другим вариантом в Интернете нередко советуют программу из того же офиса MS FrontPage . Что ж, в первых версиях эта программа действительно, была хороша: достаточно простая, позволяла создавать веб-странички визуально, не требовала от пользователя знаний HTML . Однако со временем, FrontPage (как и другая продукция Microsoft) всё более усложнялась, в неё добавлялись всё новые, неизвестно кому нужные функции, и теперь MS FrontPage - неповоротливый монстр, для изучения которого потребуется достаточно увесистый учебник.

Есть и третий, более удачный вариант. На просторах Интернета существует много визуальных HTML -редакторов, не требующих знаний HTML . Есть и платные программы, и бесплатные. Есть довольно сложные системы, вроде Macromedia Dreamweaver, позволяющие строить целые сайты, есть программы попроще.

Для создания HTML -файлов я весьма рекомендую простой и бесплатный визуальный HTML -редактор с русским интерфейсом NVU. Этот редактор вы можете скачать с сайта разработчика: http://nvu.mozilla-russia.org/

Это NVU 1.0 - Визуальный HTML редактор (WYSIWYG -редактор, от англ. What You See Is What You Get , "что видишь, то и получишь"). Этот редактор не требует знаний HTML , достаточно прост в освоении и имеет подробную справку на русском языке:

Рассматривать создание веб-страниц в этом редакторе мы не будем, там всё достаточно просто и прозрачно, а лекция и без того получится большой. Замечу только, что имена HTML -файлам лучше давать латинскими символами и не использовать пробелы, то есть, вместо "Команды меню . html " файл будет лучше назвать "CommandsMenu. html ". Дело в том, что если вы будете размещать в каких то страницах руководства ссылки на другие страницы справочника, то HTML Help Workshop может дать неверные результаты с именами файлов на русском языке. Пробелы в имени файла тоже могут сослужить плохую службу.

Теперь вернемся к нашей справке. Надеюсь, вы сохранили проект Блокнота-шифровальщика из 18-й лекции? Для этого проекта мы и будем создавать справочную систему. Прежде всего, нам нужно разработать структуру будущей справки. Содержимое справки представляет собой древовидную структуру, в которой могут быть книги и страницы . Книга в HTML Help Workshop - это раздел, который имеет подразделы, такие книги могут быть вложенными. Страница - это конечный раздел, который не имеет подразделов. Наша программа не настолько сложная, поэтому и структура будет достаточно простой:

Назначение программы Команды меню Файл Правка Формат Кодирование Справка Обратная связь

Здесь мы имеем две страницы: "Назначение программы " и "Обратная связь ", а также книгу "Команды меню ", которая в свою очередь , содержит ещё 5 страниц: "Файл ", "Правка ", "Формат ", "Кодирование " и "Справка ".

Таким образом, нам придется сделать 8 HTML -файлов, отдельно на книгу и на каждую из страниц. Я не буду приводить полные листинги этих файлов - содержимое справки будет зависеть от вашей фантазии, но некоторые показательные теги я приведу. Вот, например, как я указывал ссылки на существующие страницы руководства:

Рис. 28.2.

Код я привёл в виде изображения, чтобы теги примера не конфликтовали с тегами самой лекции. Причем текст HTML -файла открыт в простом Блокноте, чтобы увидеть теги в NVU, нужно открыть вкладку "Код " в нижней части рабочего окна.

А так у меня вставляется изображение:

Рис. 28.3.

В результате должна получиться примерно такая страничка со вставленным изображением:

Надеюсь, смысл вы уловили, и правильно сделали все 8 html -файлов (у меня есть ещё 9-й файл - изображение MyText.jpg ).

Наш Блокнот-шифровальщик находится в папке 18-01 , если вы следовали моим рекомендациям. Создадим в этой папке еще одну папку Help , где будем собирать нашу справочную систему. У меня получился такой адрес :

C:\Education\18-01\Help

Я поместил туда 8 html -файлов:

• Coder.html
• CommandsMenu.html
• File.html
• Format.html
• Naznachenie.html
• ObratSvyaz.html
• Pravka.html
• Spravka.html

и картинку MyText. JPG , которую я вставлял в страничке Coder . html (см. рис. 28.4).

Теперь все приготовления сделаны, можно загружать программу HTML Help Workshop и заняться, наконец, созданием CHM-файла. Загрузив программу, выберите команду меню "File -> New ", или щелкните кнопку "New " на Панели управления . Перед вами появится следующее окошко:

Рис. 28.5.

Итак, здесь вы можете выбрать для создания следующие объекты:

• Project - Проект в целом. Это нам выбирать еще рано, сначала нужно будет сделать Таблицу Содержания.
• Text - Простой текстовый файл.
• HTML File - Файл HTML, веб-страничка. Однако, как уже говорилось, возможности этого редактора весьма скромны, и чтобы им пользоваться, требуются знания гипертекстовой разметки.
• Table of Contents - Таблица Содержания, файл формата HHC (Hyper Help Contents ). Здесь откроется редактор, в котором нужно будет ввести содержание контекстной справки, точно такое же, как разработанная нами ранее древовидная структура. И нужно будет связать каждую книгу и страницу со своим HTML-файлом.
• Index - Создание индексного файла, или файла указателей. В этом файле собираются ключевые слова, фразы, по которым затем строится индекс. Сейчас в Интернете такие ключевые слова нередко называют тэгами. Файл имеет формат HHK (Hyper Help Keyword).

Создание Таблицы содержания

Как говорилось выше, вначале нужно будет сделать Таблицу содержания , поэтому выбирайте объект Table of Contents .

В окне HTML Help Workshop будет открыт объект TOC (Table Of Contents ):

Рис. 28.6.

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

Нажмите кнопку "Insert a page " (названия кнопок появляются, если некоторое время подержать над ними указатель мыши) для добавления страницы. В поле "Entry title " требуется указать то название раздела, которое будет отображаться в таблице. У нас это будет "Назначение программы " (без кавычек, конечно). Затем нужно нажать кнопку "Add/Edit ", чтобы указать соответствующий разделу HTML - файл . Откроется еще одно окно "Path or URL ", в котором требуется ввести имя HTML -файла или его Интернет - адрес . Можно воспользоваться кнопкой "Browse " для выбора файла, но тогда файл будет указан вместе с его относительным адресом, например, так:

..\..\Education\18-01\Help\Naznachenie.html

У нас с вами все файлы проекта справочника будут находиться в одной папке, поэтому относительный адрес тут не нужен. Удалите его, оставив в строке "File or URL " только имя соответствующего разделу HTML -файла, у меня это:

Naznachenie.html

Нажмите кнопку "ОК ", и тогда окно добавления раздела Таблицы содержания будет выглядеть так:

Рис. 28.7.

Нажмите "ОК ", и раздел будет добавлен в Таблицу содержания .

Теперь нажмите кнопку "Insert a heading ", потому что в этот раз нам нужно добавить не страницу, а книгу "Команды меню ". На запрос уверены ли вы, что желаете добавить книгу в таблицу содержания, ответьте утвердительно. Процесс добавления книги абсолютно такой же, как и страницы. Укажите название раздела "Команды меню " и укажите HTML - файл , соответствующий этому разделу. Не забудьте удалить относительный адрес , если вы воспользовались кнопкой "Browse " для выбора файла.

Когда вы укажите всё, что нужно, и подтвердите все запросы, книга будет добавлена в Таблицу содержания , но окажется ВЫШЕ предыдущей страницы! А в нашей древовидной структуре она должна быть во второй строчке. Тут на помощь приходят четыре кнопки со стрелками. Первые две позволяют перемещать объект выше и ниже, а вторые - влево и вправо. Таким образом, мы можем не только установить раздел на нужную строчку Таблицы , но и передвинуть его на нужную позицию древовидной структуры. Ведь в третьей строчке у нас должна быть страница "Файл ", которая будет вложенной в книгу "Команды меню ", а стало быть, должна быть сдвинута вправо.

Проделав эту операцию нужное количество раз, добавьте все остальные страницы в Таблицу содержания :

Рис. 28.8.

Не забывайте убирать относительный адрес HTML -страниц.

Когда закончите работу, нажмите нижнюю кнопку "Save file " на левой панели инструментов для сохранения Таблицы содержания . Имя таблицы можете оставить без изменения, "Table of Contents.hhc ", но убедитесь, что сохраняете его в ту же папку, где уже находятся HTML -файлы справки. Впрочем, эта самая папка уже должна быть указана в окне сохранения Таблицы , если вы добавляли HTML -страницы кнопкой "Browse ".

Создание файла проекта

Командой главного меню "File -> Close all " закройте созданную ранее Таблицу разделов . Затем выберите команду "File -> New " или нажмите кнопку "New " на Панели инструментов , чтобы начать создание нового объекта. В этот раз мы создаем Проект , поэтому в окне выбора объекта укажите Project .

Появится окно мастера создания проекта, и вначале вам будет предложено конвертировать существующий проект устаревшего формата WinHelp . Мы с вами создаём проект "с нуля", поэтому флажок "Convert WinHelp project " не устанавливаем, а сразу нажимаем "Далее ".

На следующем шаге вам будет предложено ввести имя файла проекта или выбрать существующий файл . Тут проще всего нажать кнопку "Browse ", убедиться, что открыта папка "Help ", в которой у нас хранятся все файлы проекта справки, в поле "Имя файла " указать имя файла проекта. Тут есть одно замечание: результирующая справка будет иметь такое же имя, как и файл проекта, а имена справочных файлов обычно совпадают с именами программы. Файл программы у нас называется CodeBook.exe , значит, вписываем имя CodeBook и нажимаем "Открыть ". Вы вернетесь в окно с именем файла, это имя будет указано вместе с адресом, а имя файла проекта автоматически получит расширение HHP (Hyper Help Project) . У меня получилось так:

C:\Education\18-01\Help\CodeBook.hhp

Нажимаем "Далее ", и откроется следующее окно мастера. Тут нам будет предложено указать, какими файлами проекта мы уже располагаем. У нас с вами есть HTML -файлы с разделами и файл Таблицы содержания , устанавливаем соответствующие флажки:

Рис. 28.9.

Нажимаем "Далее ". На следующем шаге будет предложено указать файл Таблицы содержания . Нажмите "Browse " и выберите файл таблицы (Table of Contents.hhc ). Нажимаем "Открыть ", адрес и имя файла Таблицы попадет в поле мастера. Нажимаем "Далее ".

На следующем шаге нам предлагается ввести все HTML -файлы проекта. Можно добавлять их по очереди, а лучше все файлы разом. Нажмите кнопку "Add ", откроется окно открытия файлов. По умолчанию, должна быть открыта папка "Help ". В окне вы увидите 8 HTML -файлов. Выделите первый из них, затем, удерживая кнопку , щелкните по последнему. Все 8 файлов окажутся выделенными. Нажмите "Открыть ", и все эти файлы попадут в окно мастера:

Рис. 28.10.

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

Наша справка почти готова, мы уже можем скомпилировать результирующий файл справки, однако не мешает добавить в неё некоторые дополнительные функции. Индекса то у нас еще нет!

Индекс - это файл с расширением HHK (Hyper Help Keyword), содержащий ключевые слова и фразы, и ссылки на страницы справки, к которым они относятся.

Сейчас в Интернете много сайтов - библиотек, блогов, новостных сайтов и т.п. - где вы можете найти информацию по так называемым тегам. Вы же видели поле , куда вводят искомые слова и фразы, и кнопку "Найти " рядом? Те ключевые слова, которые вы туда вводите, в сфере Интернета называются тегами, а в проекте справки - индексами.

Одна страничка справки может иметь множество ключевых слов. С другой стороны, одно ключевое слово может ссылаться на множество страничек справки. Грамотная организация индексов сильно облегчит конечному пользователю работу со справкой, тут всё зависит от вашей фантазии и знаний психологии пользователя.

В окне HTML Help Workshop открыт файл проекта, в левой части окна вы видите три вкладки: "Project ", "Contents " и "Index ". Чтобы начать создание индексов, нужно перейти на вкладку "Index ". Поскольку индексный файл в проекте еще не указан, то будет выведен запрос - создаем ли мы новый индексный файл , или подключаем существующий? Мы создаем новый файл , поэтому оставьте выделенной радиокнопку "Create a new index file " и нажмите "ОК ". Вам будет предложено ввести имя индексного файла, причем по умолчанию будет предложено имя Index.hhk . Не вижу особого смысла менять это имя. Убедитесь только, что в поле "Папка " по -прежнему открыта наша папка "Help ", индексный файл нам нужно сохранять тоже в неё. Нажмите "Сохранить ", и индексный файл будет создан.

Пока еще он пустой - индексов нет. Займемся их созданием. Вообще, следует продумать заранее, какие ключевые слова к какому разделу справки привязать. У меня получилось так:

Таблица 28.1. Примерный список ключевых слов и фраз для индексного файла

Файл и название раздела	Ключевые слова
Coder.html Команды меню "Кодирование "	кодирование, декодирование, шифровать, дешифровать, расшифровать, текст
CommandsMenu.html Команды меню	пункты меню, файл, правка, формат, кодирование, справка
File.html Команды меню "Файл "	файл, работа с файлом, создать, открыть, сохранить, статистика, выход
Format.html Команды меню "Формат "	формат, шрифт, цвет, перенос по словам, автоматический перенос текста
Naznachenie.html Назначение программы	CodeBook, блокнот-шифровальщик, блокнот, пароль, ключевое слово, версия
ObratSvyaz.html Обратная связь	обратная связь, сайт, e-mail, электронный ящик, автор
Pravka.html Команды меню "Правка "	правка, отменить, вырезать, копировать, вставить, удалить, выделить всё, буфер обмена

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

Со списком разобрались, приступаем к созданию индексов. В окне HTML Help Workshop должна быть открыта вкладка "Index ". Обратите внимание на кнопки левой боковой панели инструментов, они почти такие же, как у Таблицы содержания . Нас интересует вторая кнопка "Insert a keyword ", на ней изображен ключ .

Нажмите на неё. Откроется окно добавления индекса. Ключевое слово или фразу нужно вписать в поле "Keyword ", затем нажать кнопку "Add ". Будет открыто окно, в котором нужно выбрать раздел, на который будет ссылаться данное ключевое слово . Если это слово встречается в разных разделах, то придется создавать несколько индексов: с одним ключевым словом, но разными ссылками на разделы . Для больших справочных систем та ещё работа!

Итак, ключевое слово указали, раздел справки в поле "HTML titles " выбрали - поля "File or URL " и "Title " должны заполниться автоматически. Нажмите "ОК ", и новый индекс появится в окне добавления индекса:

Рис. 28.11.

Ещё раз нажмите "ОК ", и на вкладке "Index " появится ключевое слово "кодирование ". Ничего сложного, кроме того, что подобную операцию придется повторять многократно, для каждой пары "Ключевое слово - Ссылка на раздел ". Так что запаситесь терпением, и введите все ваши ключевые слова и фразы.

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

Не знаю, как у вас, а у меня получилось 46 ключевых слов и фраз! Не мешало бы рассортировать их в алфавитном порядке. Для этого служит третья снизу кнопка "Sort keywords alphabetically " с буквами A и Z и стрелкой вниз - нажмите её, и список будет отсортирован. Если вам доведется работать с большой справкой, индексы можно создавать не за один подход, а добавлять их время от времени. Но потом всё же не забывайте их снова сортировать, иначе индексы будут выглядеть неряшливо.

Всё, работу с индексами закончили, нажмите нижнюю кнопку "Save file " для сохранения индексного файла.

Создание полнотекстового поиска

Индексы могут существенно облегчить пользователю поиск нужной справки, однако всё же полнотекстовый поиск для этого используют чаще. Полнотекстовый поиск - это когда пользователь вписывает искомое слово /фразу, а

HelpNDoc v 5.9 (2018 г). Интерфейс и справка - на англ. языке. Вес 60 Мб.
Цены: HelpNDoc Personal Edition - бесплатная программа, HelpNDoc Standard Edition - 99 евро, HelpNDoc Professional Edition - 199 евро.
Назначение HelpNDoc - создание справок, различной документации и eBooks. HelpNDoc (последних версий) может произвести стандартные справочные файлы Windows CHM (Microsoft HTML Help), документацию для веб-сети, для сайтов, PDF, документы Word, ePub и Kindle eBooks.
Рекомендуем попробовать

HelpScribble v 8.1.2 (2018 г., май). Интерфейс и справка - на англ. языке. Вес 4,3 Мб. Цена 99 долл.
Назначение программы HelpScribble - создание справок.

Helpinator

Helpinator v 3.18 (2017 г). Интерфейс - на русском языке, справка - на англ. языке. Вес 64,5 Мб. Цена 249 долл. Работает в Windows 7 - 10.
Назначение программы - создание справок в различных форматах - веб-справки, форматов CHM (Microsoft HTML Help), PDF (Adobe Acrobat), RTF, JavaHelp, EPUB и других форматах. При создании справок применяются шаблоны для каждого формата справки.

CHM Editor

CHM Editor v 3.1.2 (2003 - 2018 гг). Интерфейс многоязычный (есть русский язык). Вес 23 Мб.
Цены: CHM Editor Home - 89 долл., CHM Editor Professional - 189 долл.
Назначение программы - создание справок в форматах PDF, DOC, HTML.
При создании справки на страницу можно вставить текст, изображения, таблицы. создать ссылки, установить закладки. Особенность программы - возможность создания справки на нескольких языках, используя Google Переводчик .

Microsoft HTML Help Workshop

Microsoft HTML Help Workshop 4.74 (1996 - 1999 гг). Интерфейс и справка - на англ. языке. Вес 3,79 Мб. Бесплатная программа.Работает в Windows 2000, 7, 8, 95, 98, ME, NT, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows Vista, Windows XP.
Назначение программы - создание справок в формате CHM.
Формат справок CHM, созданный Microsoft - обычный формат справочных материалов, которые сопровождают все программы, работающие в системе Windows.

Dr.Explain v 5.1. Интерфейс и справка - на русском языке (русская программа). Вес 40,1 Мб. Имеет три вида платных лицензий - Regular (190 долл.), Advanced (290 долл), Ultima (390 долл.). Работает в Windows XP, Windows 7, Windows 8
Назначение программы - создание справок.
Программа Dr.Explain не обременена излишними функциями, ее функциональность при создании справок - ниже средней. Экспорт справки - в форматах HTML (онлайн руководства), CHM (файлы справки для ОС MS Windows), RTF и PDF.

CHM Builder 2010 г. Интерфейс и справка - на русском языке. Вес 2,18 Мб. Бесплатная программа.
Назначение CHM Builder - создание справок формата CHM. Справка создается из комплекта html-страниц, созданных в любом html-редакторе.
CHM Builder полностью совместим с Microsoft HTML Help Workshop версии 4.74.
CHM Builder - небольшая, простая в изучении и применении программа. Цены бы ей не было, если бы добавить еще надежность в работе.
Скачать

CHM Decoder v 2.2 (2003 - 2014 г). Интерфейс на англ. языке. Справки нет. Вес 2,65 Мб. Бесплатная программа.
CHM Decoder предназначен для декомпиляции единого файла CHM на составные части (в частности, на страницы HTML). Простая в применении программа.
Может работать с командной строкой.
Скачать - поиск в Интернете.

Adobe RoboHelp

Adobe RoboHelp 2019 - программа большая и многофункциональная. Вес 595 Мб. При использовании RoboHelp в составе пакета Creative Cloud плата за использование 29,99 долларов в месяц. Цена 999 долл.
Работает в Windows XP SP4 или позже, Windows Vista, Windows 7, Mac OS, Linux, iOS, Android. Версию испытания (30 дней) можно установить на Ваш компьютер.
Назначение программы - создание справок в формате HTML5, MOBI, CHM, RF8 и др.

Doc-O-Matic

Doc-O-Matic v 10 (2000 - 2016 гг) - большая многофункциональная программа, предназначенная для создания различной документации, в том числе создание связей с базами данных. Одна из функций - создание справок в форматах Web Help, Windows Help, PDF, XML , основанные на файлах Html. Программа позволяет создавать сложные системы помощи. В Doc-O-Matic можно работать с исходным кодом - C/C ++, C #, Delphi, VB.NET, IDL, Ява, PHP, JavaScript и др.
Применяются шаблоны, шаблоны включают проекты для Microsoft Visual Studio 2010, 2008, Embarcadero RAD Studio XE, Delphi 2010 и Borland Delphi.
Цены от 150 до 2190 долл.

Help Workshop позволяет создать оглавление, индексы и файл проекта, объединяющий все файлы справочной системы. В процессе компиляции файла проекта и всех файлов, связанных с ним, HTML Help Workshop создает единый файл справочной системы, выполняя одновременно операцию сжатия. Сжатие HTML -файлов и файлов других типов позволяет существенно экономить требуемое дисковое пространство .

Типы файлов, появляющиеся в проекте, зависят, конечно, от того, какие средства используются в разделах справки, от возможностей, какими будет обладать система и от того, в каком виде она будет представлена - скомпилированном файле или Web-узле. Чаще всего, в проект включаются файлы следующих типов:

• HTML-файлы, описывающие разделы справки.
• Графические и мультимедийные файлы, если в разделах справки есть ссылки на элементы подобного рода.
• Файлы, описывающие содержание справочной системы
• Файлы индексов, необходимые для поиска разделов по индексам.
• Вспомогательные файлы с информацией, необходимой для построения справочной системы.
• Файл проекта справочной системы, объединяющий всю информацию.В справочную систему можно также включить средства, позволяющие получать справки и тем пользователям, у которых нарушены те или иные функции, например, слух или зрение.

В справочную систему можно также включить средства, позволяющие получать справки и тем пользователям, у которых нарушены те или иные функции, например, слух или зрение.

Основой справочной системы являются разделы , описывающие те или иные темы. Как уже говорилось, каждый раздел оформляется в виде отдельного HTML -файла, представляя по существу отдельную Web-страницу. Следовательно, предоставляется большой простор при создании раздела справки, поскольку здесь можно применять весь дизайн Web-страниц. Заметьте, поскольку разделы являются Web-страницами, то всю справочную систему совершенно естественно рассматривать в виде Web-узла. Это особенно удобно в тех случаях, когда разрабатываемая система предназначена для коллективной работы пользователей и доступна для работы в корпоративных сетях интранет , сетях экстранет или сети Интернет . В случае, когда справочная система поставляется вместе с самой системой, естественно, приемлемой формой справочной системы является компилируемый файл .

Добавление индексов в справочную систему является одним из наиболее важных способов быстрого доступа к разделам справочной системы, позволяя найти нужный раздел или совокупность разделов по заданному индексу. Зачастую такой способ более приемлем, чем поиск по содержанию или полнотекстовый поиск . Создание индексов выполняется после того, как написаны разделы справочной системы. В каждом разделе выделяются ключевые слова, основные термины, определяющие данную тему. Они и становятся индексом или его частью. Создание индексов требует вдумчивой и кропотливой работы с содержанием и предполагает в какой-то мере знание психологии пользователей, чтобы и начинающий и опытный пользователь смогли найти нужную им тему по тому слову, которое они выбрали в качестве ключа. Как правило, в хорошей справочной системе строится иерархическая, по крайней мере, двухуровневая система индексов. Например, верхним индексом может служить фраза " Справочная система " и этому индексу будет соответствовать множество разделов, а индексами следующего уровня могут быть сочетания " Поиск по индексу" или " Поиск по содержанию".

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

Справка о справке

Частью HTML Help Workshop , как и положено, является справочное руководство. В качестве примера давайте построим некоторый его аналог - справочное руководство, рассказывающее о том, как строить справочные руководства. Конечно, наш пример будет лишь демонстрационной версией, цель которой рассмотреть все этапы создания руководства. Нас гораздо меньше будет интересовать содержание разделов и, тем более полнота охвата темы.

Создание разделов руководства

Разделы руководства являются основными терминальными элементами справочной системы. При работе в HTML Help Workshop каждый раздел должен быть представлен отдельным файлом в формате HTML. По этой причине разделы могут быть созданы в любом Редакторе, позволяющем работать с таким форматом представления данных. Рассмотрим три основные возможности:

• Разделы создаются непосредственно в HTML Help Workshop . Для этого достаточно из меню File выбрать пункт New и в появившемся диалоговом окне выбрать HTML в качестве типа создаваемого файла. Такой способ удобен для создания достаточно простых разделов справочного руководства. Но поскольку в данном Редакторе файлов нет набора специальных средств, облегчающих создание и форматирование содержания, то такой способ удобен лишь тем, кто хорошо знаком и привык к непосредственной работе с языком HTML, его тегами. В противном случае, целесообразно использовать более мощные Редакторы.
• Разделы справочного руководства создаются в Редакторе Word, привычном для большинства разработчиков. Здесь есть почти все необходимые для этого средства. Тем не менее, я рекомендую рассматривать Word только как промежуточный Редактор, используя FrontPage для окончательного редактирования. Дело в том, что не все файлы, созданные в Редакторе Word, будут без ошибок компилироваться и затем просматриваться в HTML Help Viewer. В моих экспериментах при компиляции таких файлов выдавались различные предупреждения о возможных ошибках. Хуже того, рисунки, вставленные в текст раздела, не просматривались при отображении справочного руководства. Последнее связано с тем, что Word вставляет рисунки в коллекцию Shapes. Элементы этой коллекции нормально просматриваются на Web-страницах как в самом приложении Word, так и в Intenet Explorer. Однако в HTML Help Viewer эти рисунки не просматриваются, поскольку там они должны быть представлены тегом Image.
• По-видимому, наиболее удобным Редактором для создания сложных разделов является FrontPage. Здесь легко и удобно создавать разделы, использующие все возможности Web-страниц, включая, например, изощренные мультимедийные средства. С другой стороны, файлы, созданные здесь, компилируются и просматриваются в HTML Help Viewer без каких либо ограничений, по крайней мере, в моих экспериментах.

Прежде, чем создавать разделы, идеологически правильно создать оглавление руководства. Однако технология работы с системой HHW предполагает первоначальное создание разделов, поскольку при создании пунктов оглавления необходимо сразу связывать их с уже существующими файлами разделов. Тем не менее, давайте танцевать от печки. Вот как выглядит спроектированное мной оглавление (таблица содержания) нашей будущей справочной системы:

Microsoft HTML Help Введение Создание справочного руководства Разделы Поиск Разное Рисунки Ссылки Answer Wizard Вопросы и Office Assistant

Я постарался отобразить в этом тексте иерархическую структуру оглавления. В нем присутствуют два типа элементов - книги и страницы. С каждой книгой и страницей связан отдельный раздел - соответствующий HTML -файл. Книги отличаются тем, что в них могут быть вложены другие книги, о чем уже говорилось ранее. В приведенном выше тексте названия книг выделены жирным шрифтом, курсивом - названия страниц. В соответствии с этим планом наше руководство будет состоять из 10 разделов, составляющих на верхнем уровне две книги - "Microsoft HTML Help" и "Answer Wizard". В первую из этих книг, в свою очередь, вложены еще две книги.

Понимая, как выглядит оглавление, можно приступить к созданию соответствующих разделов. Для создания разделов справки я использовал в качестве основного инструмента FrontPage. Но поскольку большую часть содержания этих разделов составляли материалы этой лекции, то я просто копировал тексты Word, перенося их на Web-страницу, создаваемую в приложении FrontPage. Я не буду приводить детали этого процесса, отмечу лишь, что все файлы, соответствующие спроектированным разделам справочного руководства, были созданы и записаны в один каталог. В этом каталоге будет накапливаться вся информация, необходимая для построения руководства. Этот же каталог и будет содержать будущий проект и скомпилированный файл, созданный инструментарием HTML Help Workshop .

Замечу, что при построении разделов справки никаких особых средств не использовалось, - заголовки, абзацы, гиперссылки и списки - вот, пожалуй, и все используемые элементы. Исключение составляют два раздела - "Рисунки" и "Ссылки". В первый из этих разделов я включил рисунки различных форматов, во второй - различные ссылки. Но об этих разделах и используемых в них элементах я скажу позже чуть подробнее.