---
title: "Создание документа в формате WebHelp"
id: "sozdaniye-dokumenta-v-formate-veb-spravki"
project: "Руководство пользователя Документерры"
url: "https://docs.documenterra.ru/articles/manual/sozdaniye-dokumenta-v-formate-veb-spravki"
keywords:
  - "web help"
updated: 2026-11-16T06:45:01Z
---

# Создание документа в формате WebHelp

В системе создания документации **Документерра** можно создавать различные виды условных публикаций, используя методы публикации из единого источника. Кроме того, вы можете выбрать формат условной публикации в соответствии со своими потребностям. Помимо прочих форматов **Документерра** поддерживает создание документации в формате **WebHelp**.

| ![](/resources/Storage/manual/documenterra_baselang/Images/quick-parts/icon-info.svg) | Примечание |
| --- | --- |
| Файл WebHelp, экспортированный из системы Документерра, имеет интерфейс читателя, соответствующий уровню доступности AA согласно требованиям Руководства по обеспечению доступности веб-контента WCAG 2.2. При этом соответствие контента требованиям зависит от стилизации на стороне пользователя и не контролируется системой Документерра. Узнайте больше о [доступности контента](/articles/manual/dostupnost) здесь. |

## Что такое WebHelp?

**WebHelp**представляет собой файловый формат, который существует в виде набора **HTML** файлов, сопровождаемых изображениями, CSS и скрипт-файлами. Это статические файлы, которые не связаны с инструментом создания документации, в котором они были созданы. Это отличный способ просмотреть браузерную документацию **в оффлайн-режиме**, а также разместить ее на собственном веб-сервере. Один из самых популярных вариантов применения документации в формате WebHelp — размещение ее в **изолированных сетях**, которые не имеют доступа в Интернет.

**Документация в формате WebHelp** организована в виде **Дерева страниц** и имеет функцию **Поиска** для более удобной навигации по контенту, а также может иметь другие функции.

Как правило, ее можно открыть в любом веб-браузере — либо как файл, хранящийся на диске, либо как веб-ресурс, размещенный на локальном веб-сервере.

## Экспорт публикаций в формате WebHelp

Чтобы создать документ в формате WebHelp в системе Документерра, необходимо выполнить следующие действия:

* После того, как вы опубликовали проект, выберите **Опубликовать** и запустите **Мастер экспорта** (например, это можно сделать со страницы **Проекты** вашего портала в системе **Документерра**).
* Выберите **формат HTML5 WebHelp**из списка предлагаемых форматов экспорта: 
 ![Выберите в качестве формата экспорта HTML5 в мастере экспорта.](/resources/Storage/manual/documenterra_baselang/Screenshots/create-webhelp-manual/export_wizard.png)
* Следуйте инструкциям мастера. На последнем шаге процедуры экспорта вам будет предоставлена **ссылка для скачивания**: 
 ![Страница завершения экспорта](/resources/Storage/manual/documenterra_baselang/Screenshots/create-webhelp-manual/finished_export.png)
* Нажмите на ссылку, чтобы скачать архив на свой компьютер. Вы получите zip-архив со всеми необходимыми файлами.

Содержимое архива будет выглядеть примерно так:

![Содержимое HTML-архива](/resources/Storage/manual/documenterra_baselang/Screenshots/create-webhelp-manual/archive-content.png)
 
Теперь вы можете поставлять экспортированную документацию в формате **WebHelp**вместе с вашим продуктом и открывать ее в веб-браузере в автономном режиме, или же вы можете разместить ее на своем собственном сервере.

Самый простой способ открыть документацию в формате **WebHelp** в браузере в автономном режиме — дважды щелкнуть по файлу **index.html** в корневой папке архива.

![Файл Index.html в архиве](/resources/Storage/manual/documenterra_baselang/Screenshots/create-webhelp-manual/index-html.png)

Вы также можете получить доступ к любой странице напрямую, открыв ее HTLM-файл, расположенный в папке HTML вашего архива в формате **WebHelp**.

Это пример того, как будет выглядеть ваша документация в формате **WebHelp** при открытии в браузере:
![Пример документации в формате веб-справки](/resources/Storage/manual/documenterra_baselang/Screenshots/create-webhelp-manual/webhelp_look.png)

| ![](/resources/Storage/manual/documenterra_baselang/Images/quick-parts/icon-info.svg) | Примечание |
| --- | --- |
| Публикация в формате WebHelp не наследует [Шаблон пользовательского читательского интерфейса](/articles/manual/shablony-interfeysa-chitatelya), который был выбран в настройках портала или проекта, а вместо этого использует специальный шаблон.<br><br>Также используется упрощенная [функция поиска](/articles/manual/polnotekstovyy-poisk-podderzhivayemyye-operatory-poiska), и в отличие от интернет-публикаций данная документация не поддерживает поисковые операторы. |

## Создание ссылок в WebHelp

Каждая страница вашей **документации в формате WebHelp** имеет **уникальный URL-адрес**. Это упрощает создание ссылок на страницы. Адрес ссылки по умолчанию выглядит следующим образом: 
 *.../topic-name.html*

**Документация в формате WebHelp**также поддерживает **якорные ссылки** (ссылки на определенные разделы страницы). **Якорные ссылки** выглядят следующим образом: 
 *.../topic-name.html#anchor*

## Брендинг документации в формате WebHelp

Поскольку документация в формате WeHelp представляет собой набор статических файлов, которые никак не связаны напрямую с вашим порталом, вы можете изменить любой из данных файлов на свое усмотрение.

Например, если вы хотите добавить заголовок и футер в свою документацию, это можно сделать, отредактировав файлы HTML, расположенные в папке **HTML**, но вам придется сделать это для каждого файла индивидуально. При создании новой документации в формате WebHelp, в ней не будет ваших изменений, и вам придется применить их снова.

| ![](/resources/Storage/manual/documenterra_baselang/Images/quick-parts/icon-info-important.svg) | Важно |
| --- | --- |
| В рамках услуг по брендингу мы можем создать мастер-файл (**master.html** — находится в архиве), который будет использоваться для создания страниц документации в формате WebHelp вашего портала. Это позволит вам не применять свой шаблон к каждому файлу вручную. Для этого свяжитесь с нами по адресу [support@documenterra.ru](mailto:support@documenterra.ru). |

Кроме того, можно оформить интерфейс документации в формате WebHelp с помощью файла [Branding.css](/articles/manual/rasshirennyy-brending-s-pomoschyu-css), который используется для разработки элементов интерфейса онлайн-портала.

Чтобы изолировать стили, применяемые к к документации в формате WebHelp, от стилей, применяемых к порталу, добавьте к вашим CSS-правилам CSS-класс .WebHelp\_body. Например, если вы хотите, чтобы цвет заголовка главного меню был синим для портала и красным для документации в формате WebHelp, вы можете сделать это следующим образом:


```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;
}
```


| ![](/resources/Storage/manual/documenterra_baselang/Images/quick-parts/icon-info.svg) | Примечание |
| --- | --- |
| Изменения, применяемые с помощью CSS-файла брендинга документации, изолированы от контента страницы и никоим образом не влияют на него. Если вы хотите стилизовать контент своих страниц, используйте вместо этого [CSS-файлы проекта](/articles/manual/stili-i-skripty-proyekta). |