Створення довідкової системи. Опис можливостей HTML Help Workshop
приклад
Кнопку можна також задати за допомогою парного тега . Всередині елемента BUTTON можна розміщувати інші HTML-елементи, тому можна зробити кнопку з текстом і малюнком. Ось так:
Можна замість малюнка вставити будь-що, хоч таблицю, якщо вам це необхідно.
Текстове поле
Усі атрибути є обов'язковими. Атрибут NAMEвизначає ім'я, під яким вміст вікна буде передано обробнику (у прикладі – address). Атрибут ROWSвстановлює висоту вікна у рядках (у прикладі - 5). Атрибут COLSвстановлює ширину вікна символи (у прикладі - 50).
Текст, розміщений між мітками , є вмістом вікна за замовчуванням. Користувач може його редагувати або просто стерти.
Атрибут SUBMIT
Цей атрибут використовується при введенні користувачем даних. Броузер, у свою чергу, виводить даний елементяк кнопку, на якій користувач може клацнути, щоб завершити процес редагування.
Разом з атрибутом SUBMIT можна використовувати такі атрибути:
· NAME- найменування кнопки SUBMIT
· VALUE- значення змінної поля у вашій формі
З допомогою HTML Help Workshop. можна створити довідкову систему у вигляді компілюваного файлу або спеціального Web-вузла. Файли, що становлять розділи цієї системи, містять тексти, графіку та інші елементи, які можуть з'являтися у розділах довідки. Інші файли, які також є частиною довідкової системи, Містять інформацію, необхідну для організації зовнішнього вигляду системи, організації пошуку необхідних розділів та інших маніпуляцій з нею.
HTML Help Workshop дозволяє створити зміст, індекси та файл проекту, що поєднує всі файли довідкової системи. У процесі компіляції файлу проекту та всіх файлів, пов'язаних з ним, HTML Help Workshop створює єдиний файл довідкової системи, виконуючи одночасно операцію стиснення. Стиснення HTML-файлів та інших типів файлів дозволяє суттєво економити необхідний дисковий простір.
Типи файлів, що з'являються в проекті, залежать, звичайно, від того, які кошти використовуються в розділах довідки, від можливостей, якими володітиме система і від того, в якому вигляді вона буде представлена - скомпілюваному файлі або Web-вузлі. Найчастіше в проект включаються файли наступних типів:
· HTML-файли, що описують розділи довідки.
· Графічні та мультимедійні файли, якщо в розділах довідки є посилання на такі елементи.
· Файли, що описують зміст довідкової системи
· Файли індексів, необхідні пошуку розділів по індексам.
· Допоміжні файли з інформацією, необхідною для побудови довідкової системи.
· Файл проекту довідкової системи, який би всю інформацію.
Основою довідкової системи є розділи, що описують ті чи інші теми. Як мовилося раніше, кожен розділ оформляється як окремого HTML-файла, представляючи сутнісно окрему Web-страницу. Отже, надається великий простір під час створення розділу довідки, оскільки тут можна використовувати весь дизайн Web-страниц. Зверніть увагу, оскільки розділи є Web-сторінками, то всю довідкову систему цілком природно розглядати у вигляді Web-вузла. Це особливо зручно в тих випадках, коли система, що розробляється, призначена для колективної роботикористувачів та доступна для роботи в корпоративних мережах інтранет, мережах екстранет або мережі Інтернет. У випадку, коли довідкова система поставляється разом із самою системою, природно, прийнятною формою довідкової системи є файл, що компілюється.
Додавання індексів до довідкової системи є одним з найбільш важливих способів швидкого доступудо розділів довідкової системи, дозволяючи знайти потрібний розділ чи сукупність розділів за заданим індексом. Часто такий спосіб є більш прийнятним, ніж пошук за змістом або повнотекстовий пошук. Створення індексів виконується після написання розділів довідкової системи. У кожному розділі виділяються ключові слова, основні терміни, що визначають цю тему. Вони стають індексом чи його частиною. Створення індексів вимагає вдумливої і кропіткої роботи зі змістом і передбачає певною мірою знання психології користувачів, щоб і початківець досвідчений користувачзмогли знайти потрібну їм тему за тим словом, яке вони обрали як ключ. Як правило, у добрій довідковій системі будується ієрархічна, принаймні, дворівнева система індексів. Наприклад, верхнім індексом може бути фраза "Довідкова система" і цьому індексу буде відповідати безліч розділів, а індексами наступного рівня можуть бути поєднання "Пошук за індексом" або "Пошук за змістом".
Включення до довідкової системи змісту або, використовуючи більш формальний термін, таблиці змісту є майже обов'язковою умовою будь-якого довідкового керівництва. Зміст дозволяє надати керівництву певну структуру. При добре продуманій структурі і заголовках розділів зміст дозволяє досить просто знайти потрібний розділ і, що важливо, навколишній контекст. При написанні керівництва зміст корисно складати ще до того, як буде створено розділи керівництва. Більше того, вже на цьому етапі створюється ієрархічна структуразмісту керівництва, - частини, глави, параграфи керівництва.
У системі HTML Help Workshop технологічно зміст створюється після створення розділів. При створенні таблиці змісту використовуються два типи елементів змісту – книги та сторінки. У книгу поряд зі сторінками можуть бути вкладені інші книги, і тому кожна книга розгортається в звичну для програмістів структуру дерева. Оскільки зміст керівництва на верхньому рівніможе складатися з кількох книг, то фактична структура змісту є не окремим деревом, а лісом - складнішою структурою, цілком достатньою для відображення складної ієрархії, що пов'язує розділи керівництва.
Тепер, коли отримано загальне уявленняпро інструмент 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
Створення довідкової системи у Microsoft Help Workshop
Довідкова система
Бажано, щоб кожна програма мала довідкову систему, за допомогою якої користувач міг отримати вичерпну інформацію про програму, як з нею працювати. Довідкова система є набором файлів певної структури, використовуючи які програма Winhelp, що є складовою Windows, виводить довідкову інформацію, яка знаходиться в hlp-файлі.
Вікно довідки має меню та панель інструментів, що дозволяють працювати з довідковими файлами. Залежно від ситуації, окремі кнопки можуть бути неактивними. Крім того, розробник довідкової системи за допомогою макрокоманд може змінити склад меню та панелі інструментів. Створити hlp-файл можна за допомогою програми Microsoft Help Workshop, вихідними даними якої є текст довідки, представлений як rtf-файла.
Процес створення довідкової системи (hlp-файлу) можна представити як послідовність наступних двох кроків:
- Підготовка довідкової інформації (створення файлу довідкової інформації).
- Перетворення файлу довідкової інформації на файл довідкової системи.
Файл документа довідкової інформації
Файл документа довідкової системи є rtf-файлом певної структури. Створити rtf-файл довідкової інформації можна за допомогою будь-якого редактора, що дозволяє працювати з документами формату RTF, у тому числі за допомогою Microsoft Word. Документ може містити графічні зображеннята таблиці, стильове та шрифтове оформлення. Крім власне довідкової інформації, до нього включаються керуючі дані, наприклад, що визначають взаємозв'язки між розділами документа. Спочатку потрібно набрати текст заголовків довідки, оформивши заголовки одним із стилів "Заголовок", наприклад Заголовок 1. При цьому текст кожного розділу повинен знаходитись на певній сторінці документа (закінчуватися символом "розрив станиці"). Розділ є фрагментом довідкової системи, що відображається у вікні Winhelp. Якщо розмір вікна недостатній для відображення розділу, у вікна з'являється горизонтальна або вертикальна смуги прокручування. Кожен розділ довідки оформляється окремим розділом документа. Довідковий файл має зміст, або початковий розділ, який за ієрархічної організації довідки виконує роль кореневого розділу. Після того як текст розділів буде набраний, потрібно, використовуючи виноски, позначити заголовки розділів довідкової інформації (виноски використовуються компілятором довідкової системи в процесі перетворення rtf-файлу на файл hlp-файл, файл довідки). Щоб позначити заголовок розділу виноскою, потрібно встановити курсор перед першою літерою заголовка розділу та з меню Вставка вибрати команду Виноска. У діалоговому вікні Виноски в групі Вставити виноску потрібно встановити перемикач в положення звичайну, а в групі Нумерація - в положення інша. У полі введення номера виноски слід ввести символ # та натиснути кнопку ОК.
В результаті в документ буде вставлена виноска # і в нижній частині вікна документа з'явиться вікно введення тексту виноски, в якому поруч із позначкою виноски слід ввести ідентифікатор розділу довідки. Найчастіше використовують такі види виносок:
| Виноска | Призначення |
| # | Задає ідентифікатор розділу довідки, який може використовуватися в інших розділах для переходу до позначеного розділу. |
| $ | Задає ім'я розділу, який буде застосовано для ідентифікації розділу довідки у списку пошуку та у списку переглянутих тем під час використання довідкової системи. |
| K | Задає перелік ключових слівпри виборі яких зі списку діалогу пошуку здійснюється перехід до розділу довідки, заголовок якої позначений цією виноскою. |
Примітка: Найкраще, щоб ідентифікатор розділу довідки починався з префіксу IDH_. У цьому випадку під час компіляції rtf-файлу буде перевірено коректність посилань на розділи довідки. Компілятор виведе список ідентифікаторів, перелічених у розділі файлу проекту (див. нижче), але яких немає в rtf-файлі.
Як правило, розділи довідки містять посилання на інші розділи. У вікні довідкової системи поняття (слова), вибір яких викликає перехід до іншого розділу довідки, відрізняються від основного тексту довідки кольором і підкреслюються. Під час підготовки тексту довідкової інформації слово-посилання, при виборі якої відбувається перехід до іншого розділу довідки, слід підкреслити подвійною лінією. Відразу за посиланням, без пропуску, помістити ідентифікатор розділу довідки, до якого має бути виконано перехід. Вставлений ідентифікатор необхідно оформити як прихований текст. При цьому малюнки, як і текст, можна використовувати посилання на інший розділ. Для цього малюнок відповідним чином наголошується, а контекст розділу міститься відразу після малюнка. На попередньому рисунку наведено вікно редактора тексту під час підготовки файлу довідкової інформації. Слово "Замовника" позначене посиланням на інший розділ довідки (тут передбачається, що розділ довідки, в якому знаходяться відомості про замовника, позначений виноскою #, що має ідентифікатор IDH_1).
Створення довідкової системи
Після створення файлу довідкової інформації системи (rtf-файл), можна приступити до створення довідкової системи (hlp-файлу). Для цього зручно скористатися програмою Microsoft Help Workshop, яка міститься у файлі Hcw.exe; який поставляється окремо або разом з Delphi (або C++ Builder) Запускається Microsoft Help Workshop через файл Hcw.exe.
Після запуску Microsoft Help Workshop на екрані з'являється головне вікно програми. Основним файлом компілятора є файл проекту, який поєднує такі елементи, як текстові файлидовідок, опції, номери контекстів і дозволяє створити з них довідковий файл. Для того щоб приступити до створення довідкової системи, потрібно з меню File вибрати команду New, потім у діалоговому вікні Project File Name, що відкрилося, вказати тип створюваного файлу - Help Project. Далі слід вибрати папку, де знаходиться програма, для якої створюється довідкова система, і де вже має бути файл документа довідкової системи (rtf-файл). Потім введіть ім'я файлу проекту довідкової системи в полі Ім'я файлу. Файлу проекту надається розширення HPJ.
Після натискання кнопки Зберегти відкривається вікно проекту довідкової системи. Елементи проекту є окремими секціями, імена яких відображаються. великими літерамиі укладені в квадратні дужки. Спочатку проект має лише секцію , до якої включені параметри вікна довідки та виведення звіту про компіляцію проекту.
Використовуючи вікно проекту довідкової системи, можна додати необхідні компонентиу проект, задати характеристики вікна довідкової системи, виконати компіляцію проекту та пробний запуск створеної довідкової системи. Для того щоб додати в проект файл довідкової інформації, потрібно натиснути на кнопку Files і в діалоговому вікні Topic Files - кнопку Add. У результаті відкривається стандартне вікно Відкриття файлу, що дозволяє вибрати потрібний файл rtf.
В результаті цих дій у вікні проекту з'явиться розділ , в якому буде вказано ім'я довідкової інформації. Якщо довідкова інформація розподілена за кількома файлами, операцію додавання файлу потрібно повторити. Для того, щоб задати характеристики головного вікна довідкової системи, треба у вікні проекту натиснути кнопку Windows. З'явиться вікно Create a window. У полі Create a window named треба ввести main.
В результаті натискання на кнопку ОК з'являється вікно Window Properties, у полі Title bar text вкладки General якого потрібно ввести заголовок головного вікна довідкової системи.
Використовуючи вкладку Position діалогового вікна Window Properties, можна встановити положення та розмір вікна довідкової системи.
На вкладці Position знаходиться кнопка Auto-Sizer, при натисканні якої відкривається вікно Help Window Auto-Sizer, розмір та положення якого визначається вмістом полів вкладки Position. За допомогою миші можна змінювати розмір та положення цього вікна. Після натискання кнопки ОК координати та розміру вікна Help Window Auto-Sizer будуть записані в поля вкладки Position.
Використовуючи вкладку Color, можна встановити колір фону області заголовка розділу довідки та області тексту довідки. Для цього потрібно натиснути відповідну кнопку Change та у стандартному вікні Колір вибрати потрібний колір.
Щоб програма, яка використовує довідкову систему, могла отримати доступ до конкретного розділу довідкової інформації, необхідно визначити числові значення ідентифікаторів розділів, тобто. встановити відповідності між номерами контекстів керуючих елементів програми та розділами довідкової системи. Щоб це зробити, треба у вікні проекту довідкової системи натиснути кнопку Map, в результаті чого відкриється діалогове вікно Map. У цьому вікні розробник може виконувати такі операції, як додавання нової відповідності або видалення наявного. Відповідності відображаються рядковим чином у вигляді пар значень, розділених знаком рівності. Зліва знаходиться контекст розділу довідкового файлу (виноска, позначена символом #), а праворуч - номер контексту елемента програми, що управляє.
У цьому вікні потрібно натиснути кнопку Add і в полі Topic ID, діалогового вікна Add Map Entry, що відкрилося, ввести ідентифікатор розділу довідки, а в полі Mapped numeric value - відповідне ідентифікатору числове значення. У полі Comment модно ввести коментар – назву розділу довідкової системи, якому відповідає ідентифікатор. Далі наведено вікно проекту довідкової системи після додавання rtf-файлу, встановлення характеристик головного вікна довідкової системи та призначення числових значень ідентифікаторів розділів.
Після того як буде підготовлений файл проекту, можна виконати компіляцію, клацнувши на кнопці Save and Compile, що знаходиться у вікні проекту. Проте вперше компіляцію проекту довідкової системи краще виконати вибором з меню File команди Compile, у результаті якої відкривається діалогове вікно Compile a Help File.
У цьому вікні слід встановити прапорець Automatically display help file in WinHelp when done (Автоматично показувати створену довідкову систему після завершення компіляції), а потім натиснути кнопку Compile. Після завершення компіляції на екрані з'явиться вікно з інформаційним повідомленням про результати компіляції і, якщо компіляція виконана успішно, вікно створеної довідкової системи. Створений компілятором файл довідкової системи (hlp-файл) буде поміщений у папку, в якій знаходиться файл проекту. Якщо повідомлень про помилки не було, довідковий файл містить коректну інформацію і готовий до використання. Однак якщо при компіляції були виявлені помилки, то довідковий файл все одно створюється і може бути використаний, однак окремі елементи, наприклад посилання, можуть не працювати або працювати не правильно. Компілятор довідкових файлів є MDI-додатком і може мати кілька відкритих дочірніх вікон одночасно. Після виконання компіляції такими вікнами є вікно проекту і вікно результатів компіляції, причому останнє розташовується поверх вікна проекту. Для продовження роботи над проектом необхідно закрити вікно результатів або переключиться у вікно проекту командою Window/Project Name, де Project Name – ім'я файлу проекту.
Для створення повноцінної довідкової системи необхідно створити cnt-файл, в якому зберігатимуться назви тем та розділів довідкової системи. У програмі Help Workshop потрібно створити новий проект File->New, у діалоговому вікні, що відкрилося, виберіть тип створюваного файлу - Help Contents. Відкриється вікно проекту, в якому потрібно заповнити поле Default filename – ім'я файлу довідки (RS.hlp) та Default title – заголовок вікна довідкової системи.
Для додавання теми потрібно натиснути кнопку Add Below – відкриється діалогове вікно додавання тем та розділів. Під темою розуміється те, що у довідковій системі відображається як іконка закритої книжки, клацання на якій призведе до розкриття списку розділів довідкової системи, що випадає, а розділ у довідковій системі відображається як іконка аркуша зі знаком питання, клацання на якій призведе до відкриття відповідного розділу. Додати тему можна і за допомогою кнопки Add Above - ці кнопки відрізняються тим, що при додаванні Add Above - розділ розташовується вище за виділений розділ, а Add Below - нижче. Для додавання теми необхідно встановити перемикач Heading і заповнити поле Title - назва теми.
При додаванні розділу, перемикач слід встановити на Topic та заповнити поля Title - назву розділу (Журнал оплати); Topic ID - ідентифікатор розділу (IDH_5); Help file – ім'я файлу допомоги (RS.hlp); Window type - тип вікна, у якому відображатиметься розділ (main).
Використання довідкової системи
Для того, щоб під час роботи програми користувач, натиснувши клавішу F1, міг отримати довідкову інформацію, щоб властивість Файл довідки форми містила ім'я файлу довідкової системи, а властивість Ідентифікатор довідки - числовий ідентифікатор розділу довідкової інформації, який повинен бути виведений.
Файл довідкової системи програми краще помістити в ту папку, в якій знаходиться файл програми, що виконується. Це дозволить використовувати те саме значення властивості Файл довідки у всіх екземплярах програми і не завадить установці програми в будь-яку папку користувача. Якщо у значенні цієї властивості не вказано шлях, Microsoft Access шукатиме файл довідкової системи в каталозі програми. Якщо в момент натискання клавіші F1 фокус знаходиться на елементі керування, для якого не був створений розділ довідкової системи, то буде виведений розділ довідки для форми. Якщо розділ довідки користувача для форми також відсутній, відкриється вікно помічника Office. Розділ довідки користувача не може бути виведений на екран за допомогою помічника.
Для створення файлу довідки можна використовувати також Microsoft HTML Help Workshop-для створення файлів довідкової системи у форматі гіпертексту.
Дещо з теорії довідкових систем
Довідкова система програми, або файл довідки, призначений для надання користувачеві програми повної та вичерпної інформації, про те як працювати з програмою і для чого даний програмний продукт потрібен. Довідкова система повинна задовольняти такі вимоги:
- Надавати повний опис з питань використання програми.
- Мати графічні матеріали щодо використання програми.
- Бути доступним для виклику з будь-якої форми програми.
- Мати контекстні описи та зручну систему пошуку інформації.
- Мати мінімально можливий розмір.
Процес створення chm значно полегшує такий інструмент, як HTML Help Workshop, розроблений Microsoft. Качаємо HTML Help Workshop із сайту Microsoft. Встановлюємо HTML Help Workshop на власний комп'ютер. Створюємо на локальному диску D: папку і називаємо її chm. Запускаємо HTML Help Workshop, вибираємо в контекстному меню "File" -> "New" -> "Project". Відкриється вікно майстра проекту.
Необхідно вказати, де зберігатиметься проект файлу chm. Я вказав створену нами папку.
Мал. 2. Вікно вибору розташування проекту
На наступному кроці нічого не змінюємо, тому що у нас немає жодних файлів, які можна було б додати до проекту HTML Help Workshop.
Мал. 3. Вікно вказівки які файли необхідні для створення довідки вже є у вас
Натискаємо "Готово". У нас вийшов пустий проект. Тепер потрібно підготувати файли, без яких неможливе створення chm. Головне – це самі сторінки, які містять довідку. Для їх створення необхідно вибрати в контекстному меню «File» -> «HTML File», у вікні, що з'явиться, набрати назву сторінки, яку будемо створювати. Я назвав її "Intro".
Мал. 4. Створення першого файлу HTML
Після того як ви вбили свою назву і натиснули «OK», перед вами буде вікно, в якому вже є порожня сторінка html, якщо ми збережемо її в такому вигляді, то це буде просто порожня html сторінка з заголовком «Intro». Наберіть щось між тегами
та збережіть сторінку, натиснувши на зображення дискети, у папці D:\CHM.
Мал. 5. Редактор HTML сторінок
Також створіть ще кілька сторінок, щоб можна було трохи поекспериментувати. Я створив сторінки «FolderIntro.htm» та «Help In Folder.htm»
Мал. 6. Файли у папці проекту
Тепер у нас є 3 файли, які потрібно скомпілювати в один файл chm. Але для того, щоб створений chm був повноцінним, важлива наявність дерева каталогів і сторінок довідки, що зберігаються всередині файлу. Це дерево завжди розташоване ліворуч від тексту довідки. Для створення цього дерева нам потрібно перейти на вкладку Contents у вікні HTML Help Workshop. При натисканні на цю вкладку з'явиться питання:
Мал. 7. Створення файлу контенту (у якому зберігається деревоподібна структура довідки)
Ми, звичайно ж, погоджуємось та створюємо новий файлконтенту. Приймемо ім'я файлу, яке запропонує нам HTML Help Workshop – «Table of Contents.hhc». Зліва звертаємо увагу на вертикальний ряд кнопок, ними ми будемо користуватися при створенні файлу контенту. Натиснемо верхню з них - "Contents Properties".
Мал. 8. Вікно в якому створюється дерево контенту
З'явиться таке от віконце "Table of Contents Properties", можете в майбутньому погратися з налаштуваннями стилів і видів, але зараз ми не будемо тут нічого міняти, закриємо вікно. Розглянемо кнопки трохи нижче, ніж кнопки «Contents Properties», перша (із зображенням папки) – створює каталог усередині файлу chm, до якого можна поміщати сторінки, друга (із зображенням списаного аркуша паперу) – створює сторінку всередині файлу chm, третя (олівець) – редагує сторінку або каталог усередині файлу chm, четверта – видаляє сторінку або каталог зі списку сторінок у файлі chm. Ще нижче, розташовані кнопки, які дозволяють переміщати сторінки та каталоги вгору та вниз за списком, також пересувати правіше та лівіше. Передостання кнопка перегляду HTML коду сторінки і остання, щоб зберегти все це лихо.
Отже, давайте приступимо до створення дерева каталогів. Натиснемо на кнопку із зображенням листка, перед нами з'явиться вікно, в якому заповнюємо поле Entry title (у мене набрано Intro). Натискаємо кнопку "Add...", з'являється вікно "Path or URL", набираємо в полі "File or URL" назву нашої першої створеної html сторінки. Оскільки сторінка зберігається у тій самій папці, як і сам проект – D:\CHM, немає необхідності вказувати повний шлях до файлу.
Мал. 9. Додавання сторінки до таблиці контенту
Мал. 10. Додавання сторінки до проекту
Потім натискаємо "OK" в обох віконцях. Тепер натискаємо кнопку із зображенням папки. З'явиться вікно, яке цікавиться вставити каталог на початок таблиці контенту. Ми погодимося, а потім, якщо треба, змінимо.
Мал. 11. Вказівка розташування запису у дереві контенту
Тут з'являється таке ж віконце, як і при додаванні окремої сторінки, тобто треба дати назву каталогу та вказати, який html файлбуде відображатись при виділенні цього каталогу. Після того, як каталог налаштований, виділяємо цей каталог та натискаємо на кнопку із зображенням сторінки. На питання про те, чи вставити сторінку в початок, ми відповідаємо «Ні». І, таким чином, після налаштування цієї сторінки вона буде поміщена всередину щойно створеного каталогу. Тепер можна перемістити каталог нижче, натиснувши кнопку зі стрілкою, спрямованої вниз.
Мал. 12. Щось схоже на дерево контенту
Збережемо таблицю контенту.
Тепер створимо "Індекс" для файлу chm. Для цього перейдемо на вкладку Index і погодимося створити новий індексний файл index.hhk. У вікні, що натискаємо на кнопку із зображенням ключа, набираємо в поле «Keyword» ключове слово, при пошуку якого за індексом (коли файл довідки буде вже створено) буде відкриватися певна сторінка. Після того, як вказали ключове слово, як і при створенні таблиці контенту, потрібно вказати файл, який буде відповідати цьому ключовому слову.
Мал. 13. Вікно створення індексу
Після того як створено таблицю контенту, індекс і самі html файли можна приступити безпосередньо до налаштування файлу chm. Для цього переходимо на вкладку «Project», і тут натискаємо на верхню у вертикальному ряду кнопку. Налаштовуємо все, як на скріншотах.
Мал. 14. Налаштування проекту вкладка General
Мал. 15. Налаштування проекту вкладка Files
На вкладці "Files" видно, що необхідно вказати які файли ми використовуємо як Contents file та Index file, а також Full text search stop list file. Перші два файли ми створили раніше, а останній створимо, натиснувши кнопку Browse ... і вказавши ім'я search. Після цього натискаємо "OK".
Для створення пошуку по файлу chm необхідно на вкладці Compiler поставити галку Compile full-text search information.
Тепер тиснемо на кнопку із зображенням папки (друга зверху), у вікні, натискаємо кнопку «Add…», виділяємо всі html файли, які хочемо додати в довідку і натискаємо «Відкрити». Усі файли будуть додані до файлу довідки. Тепер у нас має бути така картина.
Мал. 16. Додавання файлів HTML
Залишається лише скомпілювати файл chm. Натискаємо на нижню кнопку у вертикальному ряду кнопок.
Мал. 17. Компіляція
З'являється балка, того що зроблено. Відкриваємо папку D:\CHM, і бачимо там готовий файл MyProject.chm. У цьому створення chm завершено.
На лекції освоюються прийоми розробки довідкової системи та підключення цієї системи до проекту 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-файлів. Виділіть перший з них, потім, утримуючи кнопку
Мал. 28.10.
Створення індексів
Наша довідка майже готова, ми вже можемо скомпілювати результуючий файл довідки, проте не заважає додати до неї деякі додаткові функції. Індексу в нас ще немає!
Індекс - це файл із розширенням HHK (Hyper Help Keyword), що містить ключові слова та фрази, та посилання на сторінки довідки, до яких вони відносяться.
Зараз в Інтернеті багато сайтів – бібліотек, блогів, новинних сайтів тощо. - де ви можете знайти інформацію про так званих тегах. Ви ж бачили поле , куди вводять шукані слова та фрази, і кнопку " Знайтипоряд? Ті ключові слова, які ви туди вводите, у сфері Інтернету називаються тегами, а в проекті довідки - індексами.
Одна сторінка довідки може мати багато ключових слів. З іншого боку, одне ключове слово може посилатися на безліч сторінок довідки. Грамотна організація індексів сильно полегшить кінцевого користувача роботу з довідкою, тут все залежить від вашої фантазії та знань психології користувача.
У вікні HTML Help Workshopвідкритий файл проекту, у лівій частині вікна ви бачите три вкладки: " Project", "Contents"і" Index". Щоб розпочати створення індексів, потрібно перейти на вкладку " Index". Оскільки індексний файл у проекті ще не вказаний, то буде виведений запит - чи створюємо ми новий індексний файл, чи підключаємо існуючий? Ми створюємо новий файл, тому залиште виділеною радіокнопку" Create a new index file" та натисніть " ОКВам буде запропоновано ввести ім'я індексного файлу, причому за замовчуванням буде запропоновано ім'я Index.hhk. Не бачу особливого сенсу міняти це ім'я. Переконайтеся, що в полі " Папка" як і раніше відкрита наша папка " Help", індексний файл нам потрібно зберігати теж у неї. Натисніть " Зберегти", і індексний файл буде створено.
Поки що він порожній – індексів немає. Займемося їх створенням. Взагалі, слід заздалегідь продумати, які ключові слова до якого розділу довідки прив'язати. У мене вийшло так:
| Файл та назва розділу | Ключові слова |
|---|---|
|
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для збереження індексного файлу.
Створення повнотекстового пошуку
Індекси можуть суттєво полегшити користувачеві пошук потрібної довідки, проте все ж таки повнотекстовий пошукдля цього використовують найчастіше. Повнотекстовий пошук- це коли користувач вписує шукане слово / фразу, а