Как добавить в контент служебную информацию, которая не пойдет на экспорт?
Представьте ситуацию, когда в контент нужно добавить какую-либо служебную информацию: сотрудника, который внес правки, причину, по которой были обновлены изображения или напоминание согласовать текст с отделом маркетинга.
Эта информация не должна попасть в экспортированный файл, но должна быть доступна авторам. Если это небольшая заметка, можно добавить ее в виде комментария — комментарии никогда не попадают в экспортированный файл.
Однако если служебная информация довольно объемная, сдержит изображения, таблицы, лучше использовать другой инструмент: условный текстовый блок. В его настройках задаются правила, исключающие его из экспорта. Можно настроить экспорт текстового блока таким образом, что его контент попадет только в документацию определенного формата, а из экспорта в остальные форматы этот контент будет исключен.
Пример условного текстового блока, оформленного в виде таблицы, в контенте пользовательской документации в Dr.Explain:
Чтобы добавить условный текстовый блок, используйте один из описанных ниже способов:
-
нажмите кнопку
в панели инструментов и выберите один из вариантов, например, Info.
На странице появится текстовый блок:
Убедиться в том, что добавленный блок с содержащимся в нем контентом не попадет в экспорт, можно нажав иконку Логические настройки:
Откроется показанное ниже диалоговое окно.
Иконки форматов HTML, CHM, DOCX, PDF в блоке Условия экспорта будут неактивны — этот блок не попадет в экспортированный документ. Добавьте в блок нужный контент.
-
откройте выпадающий список Вставить переменную
в панели инструментов и выберите Условный текстовый блок.
Откроется показанное ниже диалоговое окно.
Деактивируйте иконки форматов, в которые не должен попасть контент условного текстового блока:
Нажмите OK, чтобы сохранить изменения и закрыть окно.
Подробнее о настройках логического текстового блока можно узнать в этом разделе.
В Dr.Explain имеются инструменты для более гибкой настройки условий экспорта. О том, как настроить логические правила, по которым определенный раздел попадет в финальный документ или будет исключен из него, можно в разделе Логические условия экспорта раздела.
Часто задаваемые вопросы
Есть ли у программы бесплатная версия?
На этой странице можно загрузить бесплатную версию Dr.Explain.
Где можно почитать о реальных случаях использования программы Dr.Explain?
Ознакомиться с ними можно на странице Пользовательские истории успеха.
Как экспортировать карту сайта онлайн документации?
Читайте об этом в разделе Экспорт карты сайта и индекса карты сайта.
Можно ли уменьшить размер проекта при экспорте документации пользователя?
Читайте об этом в разделе Инструмент сжатия.
Как работать нескольким авторам над одной документацией?
Для совместной работы над проектами используется облачная платформа Tiwri.com.
Можно ли создать пользовательскую онлайн документацию без навыков программирования в Dr.Explain?
Можно. Однако специальные знания расширят возможности разработки профессиональной справочной системы.
Как добавлять и удалять участников проекта при совместной разработке документации?
Читайте об этом в разделе Работа с коллабораторами в Tiwri.com.