Огляд HelpManual - програми для створення файлів довідкової системи
Отже, ви створили програмне забезпечення, яке збираєтеся продати і непогано на цьому заробити. Програма, скомпільована, налагоджена і протестована. Єдине, чого їй не вистачає, - це файлу допомоги. Жодне серйозне програмне забезпечення не обходиться без модуля довідкової інформації і керівництва користувача. Це додає програмі закінчений вигляд і показує турботу про користувача. У цьому огляді буде розглянута програма HelpManual від компанії EC Software, здатна генерувати help-файли самих різних форматів.
У дереві задається вся структура файлу змісту, так як його буде бачити користувач. Тут задаються заголовки папок і сторінок. Для кожного елемента дерева можна задати власну іконку і статус. Залежно від статусу елемент виділяється своїм кольором (жовтий - редагується, блакитний - потребує доопрацювання, білий - готовий), тим самим роблячи роботу з наповнення сторінок більш наочною.
На першій закладці визначаються основні параметри поточної сторінки: ідентифікатор сторінки, ідентифікатор вікна, в якому вона буде відкриватися, ключові слова, якір за замовчуванням, компілятори, що включають дану сторінку в кінцевий файл.
Якорем в програмі називається невидима мітка в тексті сторінки, до якої буде здійснюватися перехід за ключовим словом або за гіперпосиланням. Додаючи якір, ми вказуємо для нього ідентифікатор і ключові слова. Всі ключові слова, зазначені як цілком для сторінок, так і для якорів, будуть виводитися на сторінці "Покажчик (список предметів,, Index) згенерованих файлів допомоги". Натиснувши на вибраному ключовому слову, буде здійснено перехід до об'єкта, на який посилається: страницу або якір.
Гіперпосилання тут виконують ту ж роль, що і в інтернет-браузері, - здійснюють перехід на зазначену сторінку. Гіперпосилання можуть бути чотирьох типів.
Посилання на сторінки поточного файлу допомоги. Для цього випадку в параметрах посилання вказується ідентифікатор сторінки, на яку буде здійснений перехід. Якщо перейти потрібно не до початку сторінки, а до якоря на ній, додатково вказуємо ідентифікатор цього якоря. Якщо в програмі визначено більш ніж одне вікно, тут можна вказати, яке з вікон буде відкриватися при переході по посиланню.
Вікно додавання гіперпосилання
Якщо є необхідність додати в проект текстовий блок, який повинен відображатися тільки в обраних форматах файлів допомоги, то на допомогу прийде інструмент "Умова".
В параметрах цього інструменту вибираються формати компільованих файлів і ставиться логічне умова IF, IFNOT або ELSE (якщо, якщо ні, інакше). Після застосування цього інструменту виділений текстовий блок полягає в червоні маркери.
Вікно додавання текстової змінної
У вікні властивостей проекту можна задати основні параметри майбутнього файлу допомоги. Всі настройки розбиті на дев'ять груп.
У першій групі задаються властивості, які не залежать від формату майбутнього файлу. Це значення текстових змінних (як зумовлених, так і заданих додатково), настройки мови, шрифт за замовчуванням, каталоги з картинками, власне сховище картинок та інше.
За замовчуванням у програмі визначено одне вікно з ідентифікатором Main. Користувач має можливість додавати нові вікна і задавати для кожного з них власні настройки. Все це робиться в другій групі налаштувань. Тут задаються такі параметри, як наявність у вікна заголовка, кольору фону, позиція. Для файлів формату CHM і HLP тут можна налаштувати набір кнопок, які будуть доступні у вікні файлу допомоги.
Наступні сім груп містять індивідуальні настройки для кожного формату файлу допомоги. Наприклад, параметри сторінки для RTF або доступність тексту для виділення і копіювання в файлі eBook (EXE).
зовнішні компоненти
З додаткових коштів HelpManual хочеться звернути увагу на три зовнішні компоненти, що допомагають в написанні інструкції.
Перша - це потужний фотограф скріншотів Screen Capture. Дана утиліта дозволяє робити знімки довільної області екрану і навіть окремих елементів інтерфейсу: панелей інструментів, областей введення та іншого. Більш детально, в якості самостійного додатки, вона описана в статті "Фотографуємо вікна".
Зручною особливістю режиму компіляції є можливість включення в скомпільований файл опцій файлів інших форматів. Наприклад, в початковому тексті у вас присутні умови, які виведуть текстові блоки тільки для файлів HLP. Але одного разу вам знадобилося зібрати файл у форматі PDF і включити туди згадані текстові блоки. Для цього вам не знадобиться переписувати вихідний текст проекту, досить у вікні компіляції вибрати формат файлу PDF і поставити галочку Classic Winhelp (.HLP). Cледует помітити, що для компіляції файлів CHM і HLP знадобляться власні компілятори. Якщо вони не встановлені в системі, їх можна завантажити тут.
резюме
Завантажити саму програму Help Manual можна тут