Особенности настройки Help+Manual Professional

Version 8.3.1 Build 5794


Общие настройки:

1) Нет прямой интеграции между Help+Manual и Atlassian Jira. Файлы TOC (содержание) и Topics (все разделы документа) проекта, реализованного в Help+Manual (.hmxp), хранятся в формате XML. В качестве обходного пути можно сформировать ссылку на эти проектные файлы.

2) При создании задачи в Task manager на публикацию документов нужно указывать build в каждом действии задачи (Task action) аналогично абсолютному пути к файлу. Например, если есть раздел Общие настройки с build GeneralConfigurations и подраздел Настройка карточки CardConfig, то в Task manager в Task action нужно будет указать оба build в include options: GeneralConfigurations и СardConfig.

3) Функция Multi-user editing работает так: пользователи могут одновременно редактировать только разные разделы в одном проекте. Если пользователь #1 открывает раздел #1 и начинает редактировать, а пользователь #2 открывает тот же раздел #1 в том же проекте, то пользователь #2 сможет только просматривать данный раздел. При попытке отредактировать данный раздел пользователь #2 увидит сообщение о том, что данный раздел редактируется другим пользователем. Редактирование для него будет недоступно пока пользователь #1 не сохранит изменения, внесенные им в данном разделе.

4) Функция Concurrent Use доступна только с лицензией Floating. Функция работает так: один и тот же пользователь может открывать проект на разных устройствах с одной и той же лицензией Help+Manual. Обязательно, чтобы сессия активна была только на одном из устройств. Также данное устройство должно быть подключено к интернету, так как сверка лицензий происходит на удаленном сервере производителя. Можно также прикрепить лицензию к устройству на восемь дней и таким образом открывать проект в Help+Manual без выхода в интернет. Наличествует специальный инструмент для администратора, который позволяет управлять активными сессиями, таким образом распределяя лицензии между пользователями. К примеру, администратор может принудительно завершить активную сессию одного пользователя, тем самым освободить лицензию и позволить другому пользователю на другом устройстве открыть проект под освобожденной лицензией.

5) Есть возможность создать несколько TOC (содержание). Таким образом можно настроить отдельный TOC для каждого выходного документа и при этом в проекте заполнять разделы только в одном из основных TOC. Например, можно создать TOC Общее и затем создать еще три TOC. Разделы скопировать из TOC Общее в созданные TOC. Поменять структуру разделов в созданных TOC, переименовать разделы и т.д (например, создать одну из структур по ГОСТу 2.105). Таким образом, при заполнении разделов основного TOC содержимое будет копироваться в разделы из других TOC.

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

7) Если опубликованные файлы Web Help открываются с ошибками в веб-браузере Chrome — разделы развернуты и нет возможности свернуть их, то следует открыть файл по протоколу http, а не открывать данный файл локально. Данный файл Web Help должен быть размещен на веб-сервере.

8) Формат вывода Web Help. Если документ HTML (index.html) открыт на АРМ у стороннего пользователя, то при сборке документа HTML посредством командной строки будет отображаться ошибка [Error] Error while writing top frame page! — документ собираться не будет. Следует закрыть документ, запустить сборку документа и только после этого можно открывать обновленный документ на другом АРМ. Также возможно в целевой папке с опубликованным документом отсутствует предыдущий файл index.html. В таком случае следует удалить все файлы из целевой папки и запустить сборку документа.

9) Если используются несколько оглавлений и в одном из них требуется переименовать разделы для документов в формате DOCX, то следует переименовать данные разделы в TOC. При этом в настройках раздела (Topic Options) в поле <TITLE Tag> может быть установлено другое название. Данное название отображается только в шапке раздела в документе формата Web Help.

10) Если в документе использовать разметку IF…END то возможно после тега END будет добавляться пустая строка в публикуемых документах. Чтобы этого избежать, следует ставить тег END в начало строки, следующей за условным фрагментом.

11) Чтобы использовать свой файл CSS для оформления документов Web Help следует указать его в настройках шаблона Web Help после ссылки на стандартный файл CSS: Configuration - Publishing Options - Webhelp - Layout, Table of Contents, Keyword Index, Full Text Search.

12) Требование: чтобы при выборе определенного раздела не из панели навигации (например при вводе ссылки на раздел с его ID), отображался выбранный раздел вместе с панелью навигации. Для этого следует установить признак в настройках шаблона WebHelp: Configuration - Publishing Options - Webhelp - Navigation - When a topic is loaded outside the navigation frame, force it to reload the navigation frame.

13) Если два рисунка с одним и тем же номером сохранены в разных каталогах проекта (настройка директорий к каталогам проекта: Configuration - Common Properties - Project Search Path), то при публикации документов будет использоваться рисунок из того каталога, который первый в списке Project Search Path.


Настройки build server:

1) Если не запускается файл CMD для публикации документов, следует составить новый и возможно с другим названием, но с тем же содержанием;

2) Если использовать русские буквы в названиях конечных документов или директориях, в которые публикуются документы из единого источника, то могут возникать ошибки при публикации документов. Особенно важно использовать только латинские буквы при составлении конфигурационного файла INI. Нельзя использовать русские буквы в названиях TOC (содержание);

3) Не должно быть табуляций или каких-либо пробелов в начале строк в файлах INI и CMD, а также до и после этих строк;

4) При активации лицензии build server необходимо на сервере в консоли ввести команду:

<path>HELPMAN.EXE lic:xxxxxxxxxxxxxxx

Затем ввести ту же лицензию при открытии приложения HELPMAN на сервере.

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

6) Если ключ /L не указан в конфигурационном файле INI, то логи будут отображаться в консоли сервера при сборке документов посредством командного файла. Если ключ написан, то логи сохранятся в файл TXT, указанный в настройках файла INI.