Изменить расположение пользовательской документации

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

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

Рисунок 1. Настройка расположения документации

Шаблоны расположения документации

В шаблоне могут быть использованы переменные:

{client} — псевдоним клиентской программы, который может приобретать значения:
- winclient — для Windows-клиента.
- webclient — для Web-клиента.
  
  Другие клиентские приложения не поддерживают настройку, определяющую расположение документации.
{version} — версия клиентской программы.

Таким образом фактический стандартный адрес документации, к примеру, для Windows-клиента версии 5.5.1 будет следующим: http://www.docsvision.com/docs/winclient/5.5.1/index.html.

Для всех клиентских программ используется общий шаблон, поэтому размещать документацию Windows-клиента и Web-клиента следует на одном сайте.

Изменение расположения документации

Создайте на сайте в общей родительской папке каталоги:
- winclient/Версия-Windows-клиента и webclient/Версия-Web-клиента — если на ресурсе будут храниться документы для разных версий программ.
- winclient и webclient — если на ресурсе будут храниться документы для единственной версии программ.
Скопируйте в созданные папки документацию в формате HTML.
Измените шаблон в настройке Адрес расположения документации.
Пример 1. Настройка расположения документации
Документация была размещена на сайте company.com, версия программ не учитывается:
- Для модуля Windows-клиент документация доступна по адресу http://www.company.com/winclient.
- Для модуля Web-клиент документация доступна по адресу http://www.company.com/webclient.
В шаблоне должно быть указано: http://www.company.com/{client}/index.html.
Сохранить изменения.