Статьи

Огляд Help & Manual - програми для створення файлів довідкової системи

  1. інтерфейс програми
  2. якоря
  3. гіперпосилання
  4. умови
  5. текстові змінні
  6. Коментарі
  7. властивості проекту
  8. зовнішні компоненти
  9. Компіляція файлу допомоги
  10. резюме

Отже, ви створили програмне забезпечення, яке збираєтеся продати і непогано на цьому заробити. Програма, скомпільована, налагоджена і протестована. Єдине, чого їй не вистачає, - це файлу допомоги. Жодне серйозне програмне забезпечення не обходиться без модуля довідкової інформації і керівництва користувача. Це додає програмі закінчений вигляд і показує турботу про користувача. У цьому огляді буде розглянута програма Help & Manual від компанії EC Software , Здатна генерувати help-файли самих різних форматів.

Головною перевагою програми є її універсальність. З її допомогою можна отримати файл довідкової інформації в будь-якому з найбільш поширених на сьогоднішній день форматів (CHM, HLP, HXS, HTML, PDF, RTF, EXE, XML). Інтуїтивно зрозумілий інтерфейс робить програму простий в освоєнні. Основний блок програми становить текстовий редактор, мало відмітний від MS Word як по інтерфейсу, так і за кількістю можливостей.

інтерфейс програми

Інтерфейс складається з двох областей. Перша - це панель Navigation з деревовидної структурою змісту файлу. Друга - редактор сторінок.

У дереві задається вся структура файлу змісту, так як його буде бачити користувач. Тут задаються заголовки папок і сторінок. Для кожного елемента дерева можна задати власну іконку і статус. Залежно від статусу елемент виділяється своїм кольором (жовтий - редагується, блакитний - потребує доопрацювання, білий - готовий), тим самим роблячи роботу з наповнення сторінок більш наочною.

Редактор сторінок складається з трьох закладок: Topic Options (опції), Page Editor (редактор сторінки), XML Source Code (исходник у форматі XML).

Головне вікно програми

На першій закладці визначаються основні параметри поточної сторінки: ідентифікатор сторінки, ідентифікатор вікна, в якому вона буде відкриватися, ключові слова, якір за замовчуванням, компілятори, що включають дану сторінку в кінцевий файл.

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

Третя закладка - це вихідний текст сторінки в форматі XML. При бажанні користувач має можливість редагувати сторінку прямо в исходнике або додавати сюди код, який неможливо ввести за допомогою редактора (хоча таке важко собі уявити).

Розглянемо деякі важливі інструменти редактора.

якоря

Якорем в програмі називається невидима мітка в тексті сторінки, до якої буде здійснюватися перехід за ключовим словом або за гіперпосиланням. Додаючи якір, ми вказуємо для нього ідентифікатор і ключові слова. Всі ключові слова, зазначені як цілком для сторінок, так і для якорів, будуть виводитися на сторінці "Покажчик (список предметів,, Index) згенерованих файлів допомоги". Натиснувши на вибраному ключовому слову, буде здійснено перехід до об'єкта, на який посилається: страницу або якір.

Вікно додавання якоря

гіперпосилання

Гіперпосилання тут виконують ту ж роль, що і в інтернет-браузері, - здійснюють перехід на зазначену сторінку. Гіперпосилання можуть бути чотирьох типів.

Для посилання можна задати один із чотирьох стилів відображення: класична посилання (синій шрифт з підкресленням), форматований текст, кнопка або малюнок.

умови

Якщо є необхідність додати в проект текстовий блок, який повинен відображатися тільки в обраних форматах файлів допомоги, то на допомогу прийде інструмент "Умова".

Вікно додавання умови

В параметрах цього інструменту вибираються формати компільованих файлів і ставиться логічне умова IF, IFNOT або ELSE (якщо, якщо ні, інакше). Після застосування цього інструменту виділений текстовий блок полягає в червоні маркери.

текстові змінні

В параметрах проекту можна задати низку визначених параметрів, таких як заголовок, автор, копірайт, номер версії та т. Д. Ці параметри можна виводити на сторінках за допомогою текстових змінних. Крім визначених параметрів можна додавати власні текстові параметри, які також будуть доступні в списку змінних.

Вікно додавання текстової змінної

Коментарі

При написанні допомоги нерідко її автору потрібно вставити на сторінку текст, цікавий тільки йому. Цю роль в програмі виконує інструмент "Коментар". Він вставляє на сторінку текстовий блок жовтого кольору, який при компіляції файлу ігнорується.

властивості проекту

У вікні властивостей проекту можна задати основні параметри майбутнього файлу допомоги. Всі настройки розбиті на дев'ять груп.

Вікно параметрів проекту

У першій групі задаються властивості, які не залежать від формату майбутнього файлу. Це значення текстових змінних (як зумовлених, так і заданих додатково), настройки мови, шрифт за замовчуванням, каталоги з картинками, власне сховище картинок та інше.

За замовчуванням у програмі визначено одне вікно з ідентифікатором Main. Користувач має можливість додавати нові вікна і задавати для кожного з них власні настройки. Все це робиться в другій групі налаштувань. Тут задаються такі параметри, як наявність у вікна заголовка, кольору фону, позиція. Для файлів формату CHM і HLP тут можна налаштувати набір кнопок, які будуть доступні у вікні файлу допомоги.

Наступні сім груп містять індивідуальні настройки для кожного формату файлу допомоги. Наприклад, параметри сторінки для RTF або доступність тексту для виділення і копіювання в файлі eBook (EXE).

зовнішні компоненти

З додаткових коштів Help & Manual хочеться звернути увагу на три зовнішні компоненти, що допомагають в написанні інструкції.

Перша - це потужний фотограф скріншотів Screen Capture. Дана утиліта дозволяє робити знімки довільної області екрану і навіть окремих елементів інтерфейсу: панелей інструментів, областей введення та іншого. Більш детально, в якості самостійного додатки, вона описана в статті "Фотографуємо вікна".

Другий інструмент - це редактор шаблонів Print Manual Designer для майбутніх файлів у форматі PDF. Тут можна задати розмітку сторінок і за допомогою текстових змінних визначити, як буде виводитися вихідний текст в майбутньому файлі. Шаблон, створений в цьому редакторі, зберігається в файлі MNL і у властивостях проекту підключається до налаштувань формату PDF.

І останнє додаток, на яке слід звернути увагу, - це графічний редактор Impict. Це досить простий (але не примітивний) і зручний графічний редактор, достатній для потреб написання документації. Оперуючи невеликим набором графічних примітивів, дана утиліта дозволяє з легкістю створювати схеми, малюнки і діаграми, а накладаються ефекти дозволяють зробити кожен об'єкт зображення по-своєму унікальним. З об'єктів, створюваних редактором, особливо хочеться виділити об'єкт "Лупа", що дозволяє збільшити зображення, на яке він накладається. Цей інструмент буде дуже корисний при роботі з скріншот з великою кількістю дрібних деталей.

Компіляція файлу допомоги

Коли текст довідки набраний, зміст наповнене, посилання, якоря і зображення розставлені, можна приступити до компіляції кінцевого файлу. У вікні компіляції потрібно вибрати формат кінцевого файлу, вказати його ім'я і розташування. Після чого натиснути кнопку "OK". І все! Через кілька секунд готовий файл буде перед вами.

вікно компіляції

Зручною особливістю режиму компіляції є можливість включення в скомпільований файл опцій файлів інших форматів. Наприклад, в початковому тексті у вас присутні умови, які виведуть текстові блоки тільки для файлів HLP. Але одного разу вам знадобилося зібрати файл у форматі PDF і включити туди згадані текстові блоки. Для цього вам не знадобиться переписувати вихідний текст проекту, досить у вікні компіляції вибрати формат файлу PDF і поставити галочку Classic Winhelp (.HLP). Cледует помітити, що для компіляції файлів CHM і HLP знадобляться власні компілятори. Якщо вони не встановлені в системі, їх можна завантажити тут .

резюме

Без тіні сумніву можна заявити, що Help & Manual є найкращим на сьогоднішній день генератором файлів допомоги. Універсальність, зручність редактора, потужні інструменти, прості і наочні механізми структуризації і зв'язку сторінок роблять його таким.


Новости