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 файла. Мы расскажем об изменениях к ИПЦ в других разделах.
Кожа Папка
Папка кожа содержит файлы, которые используются для кожи справочной системы. Кожа определяет цвета, шрифты и графика участие в презентации системы помощи. В дополнение к каталогу кожей, есть кожа связанные файлы, содержащиеся в данных и содержимого папок.