Flare являє собою інтерактивний інструмент для створення допомогти Madcap програмного забезпечення. Flare веб-проектів створення виробництва в XML і HTML, який може бути відредагований в будь-якому текстовому або регулярно редактор HTML. Ми будемо детально, як додавати, редагувати і видаляти вміст з веб-запускати книгу за допомогою текстового редактора.
По-перше, це гарна ідея мати хватку в архітектурі вихідний структури, яка породжується Flare. Типовий допомогти Flare висновок буде містити HTML файлу за відправну точку назвою ApplicationHelp.htm. Хорошим прикладом системи допомоги Flare є допомогти System100 онлайн яка доступна на http://www.system100.com/demo/help/ApplicationHelp.htm (який я також сталося з автором).
ApplicationHelp.htm файлу, при відкритті в браузері буде відкрита довідкова система і потягніть у потрібному стилю, веб-сторінки, XML і т.д. файлу ApplicationHelp.htm знаходиться в батьківській директорії для довідкової системи. На додаток до батьківської директорії, три основні підкаталоги знаходяться усередині батьківської директорії. Ці три підкаталогів:
Ми розповімо про цих підкаталогів пізніше, і допоможе вам зрозуміти їх корисності. Зараз ми повинні згадати додаткові файли підтримки, які також містяться в батьківський каталог, який включає:
- Default.js
- Default.mcwebhelp
- Default.xml
- Default_CSH.htm
- Default_Left.htm
Deafult.js
Цей файл містить інструкції, JavaScript, пов'язаних з початкової точки за замовчуванням теми довідкової системи. Він також містить зауваження (які були прокоментовані в коді цього файлу), які стосуються ID, шкіра Ім'я, запит і спочатку вибирають по ходу книги.
ПРИМІТКА: Якщо ви перейменувати за замовчуванням / відправною точкою допомогою системи необхідно переглянути окремим рядком у файлі Default.js у відповідності з новою назвою. У рядку конкретного питання у файлі Default.js є лінія номер 54, яка показує, як:
VAR gHelpSystemName = "Default.htm";
Так що, якщо б ви перейменувати замовчуванням відправною точкою допомогою системи з Default.htm в index.htm, ви повинні змінити рядок номер 54 Default.js наступним чином:
VAR gHelpSystemName = "index.htm";
Збережіть зміни у файлі Default.js.
Default.mcwebhelp
Це файл Madcap WebHelp яка не повинна бути змінена.
Default.xml
Цей файл XML містить інструкції з налаштування запуску / замовчуванням тему всякий раз, коли запустіть книга є першим почав. Вона також визначає місце розташування й ім'я файлу Зміст, індекс, концепції, Глосарій, пошуку баз даних, Псевдонім, синоніми та шкірою.
Default_CSH.htm
HTML файл, що містить настройки, які не повинні бути відредаговані.
Default_Left.htm
Цей файл містить HTML код для ТОС яка з'являється на лівій стороні довідкової системи і використовується для переходу від теми до теми, натиснувши на окремі записи TOC.
Тепер, коли ми ввели різні файли в батьківську директорію, давайте звернемо нашу увагу на трьох підкаталогів, які були згадані вище:
Зміст Дані Шкіра Вмісту папки
Авторські папка містить файли HTML в кожній окремій теми довідкової системи. На додаток до цих HTML файли, вміст каталогу містить ресурси (зображення і таблиці стилів), SkinSupport (JavaScript редаговані файли, які підтримують шкіру довідкові системи, і глосарій файлу.
Папки даних
Дані папка містить файли, пов'язані з даними в системі допомоги. Ці дані використовуються для створення та відображення довідки в робочий моди. Одним з таких файлів у папці даних яка має важливе значення має Toc.xml файлу. Ви можете внести зміни до ТОС (зміст) в довідковій системі шляхом зміни Toc.xml файлу. Ми розповімо про зміни до ІСЦ в інших розділах.
Шкіра Папка
Папка шкіра містить файли, які використовуються для шкіри довідкової системи. Шкіра визначає кольори, шрифти і графіка участь у презентації системи допомоги. На додаток до каталогу шкірою, є шкіра пов'язані файли, що містяться в даних та вмісту папок.