Запросить демо
Запросить демо
Документерра: руководство пользователя

Создание документа в формате веб-справки

В системе создания документации Документерра можно создавать различные виды условных публикаций, используя методы публикации из единого источника. Кроме того, вы можете выбрать формат условной публикации в соответствии со своими потребностям. Помимо прочих форматов Документерра поддерживает создание документации в формате веб-справки.

Примечание
Файл веб-справки, экспортированный из системы Документерра, имеет интерфейс читателя, соответствующий уровню доступности AA согласно требованиям Руководства по обеспечению доступности веб-контента WCAG 2.0. При этом соответствие контента требованиям зависит от стилизации на стороне пользователя и не контролируется системой Документерра. Узнайте больше одоступности контента здесь. 

Что такое веб-справка?

Веб-справка представляет собой файловый формат, который существует в виде набора HTML файлов, сопровождаемых изображениями, CSS и скрипт-файлами. Это статические файлы, которые не связаны с инструментом создания документации, в котором они были созданы.   Это отличный способ просмотреть браузерную документацию в оффлайн-режиме, а также разместить ее на собственном веб-сервере. Один из самых популярных вариантов применения веб-справки — размещение ее в изолированных сетях, которые не имеют доступа в Интернет.

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

Как правило, ее можно открыть в любом веб-браузере — либо как файл, хранящийся на диске, либо как веб-ресурс, размещенный на локальном веб-сервере.

Экспорт публикаций в формате веб-справки

Чтобы создать документ в формате веб-справки в системе Документерра, необходимо выполнить следующие действия:

  • После того, как вы опубликовали проект, выберите Опубликовать и запустите Мастер экспорта (например, это можно сделать со страницы Проекты вашего порталав системе Документерра).
  • Выберите формат веб-справки HTML5 из списка предлагаемых форматов экспорта:
    Выберите в качестве формата экспорта HTML5 в мастере экспорта. 
  • Следуйте инструкциям мастера. На последнем шаге процедуры экспорта вам будет предоставлена ссылка для скачивания:
    Страница завершения экспорта 
  • Нажмите на ссылку, чтобы скачать архив на свой компьютер. Вы получите zip-архив со всеми необходимыми файлами.

Содержимое архива будет выглядеть примерно так:

Содержимое HTML-архива

Теперь вы можете поставлять экспортированную документацию в формате веб-справкивместе с вашим продуктом и открывать ее в веб-браузере в автономном режиме, или же вы можете разместить ее на своем собственном сервере.

Самый простой способ открыть веб-справку в браузере в автономном режиме — дважды щелкнуть по файлу index.html в корневой папке архива.

Файл Index.html в архиве

Вы также можете получить доступ к любой странице напрямую, открыв ее HTLM-файл, расположенный в папке HTML вашего архива в формате веб-справки .

Это пример того, как будет выглядеть ваша документация в формате веб-справки при открытии в браузере:

Пример документации в формате веб-справки
Примечание

Публикация в формате веб-справки не наследуетШаблон пользовательского интерфейса читателя, который был выбран в настройках портала или проекта, а вместо этого использует специальный шаблон. 

Также используется упрощенная функция поиска, и в отличие от интернет-публикаций данная документация не поддерживает поисковые операторы. 

Создание ссылок в веб-справке

Каждая страница вашей документации в формате веб-справки имеет уникальный URL-адрес. Это упрощает создание ссылок на страницы. Адрес ссылки по умолчанию выглядит следующим образом:
.../topic-name.html 

Документация в формате веб-справкитакже поддерживает якорные ссылки (ссылки на определенные разделы страницы). Якорные ссылки выглядят следующим образом:
.../topic-name.html#anchor

Брендинг документации в формате веб-справки

Поскольку веб-справка представляет собой набор статических файлов, которые никак не связаны напрямую с вашим порталом, вы можете изменить любой из данных файлов на свое усмотрение.

Например, если вы хотите добавить верхний/нижний колонтитул в свою веб-справку, это можно сделать, отредактировав файлы HTML, расположенные в папке HTML, но вам придется сделать это для каждого файла индивидуально.   При создании новой веб-справки, в ней не будет ваших изменений, и вам придется применить их снова.  

Важно
В рамках услуг по брендингу мы можем создать мастер-файл (master.html — находится в архиве), который будет использоваться для создания страниц веб-справки вашего портала. Это позволит вам не применять свой шаблон к каждому файлу вручную. Для этого свяжитесь с нами по адресу support@documenterra.ru.

Кроме того, можно оформить интерфейс веб-справки с помощью файла Branding.css, который используется для разработки элементов интерфейса онлайн-портала.

Чтобы изолировать стили, применяемые к веб-справке, от стилей, применяемых к порталу, добавьте к вашим CSS-правилам CSS-класс . WebHelp_body. Например, если вы хотите, чтобы цвет заголовка главного меню был синим для портала и красным для веб-справки, вы можете сделать это следующим образом:

CSS
.BaseMaster_mainMenuContainer
{ /* Blue header for the portal */
background-color: blue !important;
}

.WebHelp_body .BaseMaster_mainMenuContainer
{ /* Red header for Web Help */
background-color: blue !important;
}

Примечание
Изменения, применяемые с помощью CSS-файла брендинга документации, изолированы от контента страницы и никоим образом не влияют на него. Если вы хотите стилизовать контент своих страниц, используйте вместо этого CSS-файлы проекта.