Создание интерактивной справки для вашего приложения на основе модели

Используйте настраиваемые панели справки и пошаговые задачи, чтобы обеспечить в приложении Unified Interface настраиваемую встроенную систему справки, адаптированную под вашу организацию. Используйте настраиваемые панели справки для предоставления справки и руководств по таблицам, формам и языкам, включая форматированный текст, ссылки на содержимое, изображения и ссылки на видео.

Внимание!

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

Настраиваемые панели справки и траектория обучения

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

Пользовательские панели справки предоставляют следующие главные функции, не поддерживаемые в схемах обучения:

• Форматированный текст произвольной структуры, включая маркированные и нумерованные списки.
• Визуально связанные обучающие метки и всплывающие подсказки.
• Дополнительные варианты для источников видео, включая частные источники.
• Хранение содержимого справки в Microsoft Dataverse в составе решения.

Пользовательские панели справки не поддерживают следующие ключевые возможности, доступные в маршруте обучения:

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

Предварительные условия

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

Включите настраиваемые панели справки для вашей среды

1. Войдите в центр администрирования Power Platform по адресу https://admin.powerplatform.microsoft.com.
2. Выберите "Управление " на левой панели и откройте нужную среду.
3. Выберите Параметры на панели команд, затем выберите Продукт>Функции.
4. В разделе Функции справки установите для параметра Включить настраиваемые области справки значение Вкл..

Внимание!

Убедитесь, что для настраиваемой справки для настраиваемых сущностей установлено значение Нет, иначе вы не сможете включить настраиваемые области справки. Это связано с тем, что нельзя одновременно использовать пользовательские панели справки и настраиваемую справку.

Требуемые привилегии

• Для создания панелей справки разработчикам приложений необходимо глобальное создание, чтение, запись, удаление, добавление и добавление к привилегиям в таблице Страница справки. По умолчанию роли безопасности "Системный администратор" и "Настройщик системы" обе включают эту привилегию.
• Для просмотра панелей справки в приложении пользователям необходимы права на чтение в таблице Страница справки. По умолчанию роль безопасности "Пользователь страницы справки" обладает этой привилегией. По умолчанию роль безопасности "базовый пользователь" не имеет никаких привилегий в таблице страницы справки.

Дополнительные сведения: Роли безопасности и привилегии

Контекстно-зависимая настраиваемая справка

Каждая панель справки отдельна для каждого из этих контекстов:

• Таблица
• Форма
• Информационная панель
• Язык
• Приложение

Навигация по панели справки

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

Создавать содержимое панели справки

1. Чтобы просмотреть панель справки, откройте управляемое моделью приложение, затем на панели команд выберите Справка.

   

2. На панели Справка выберите вертикальное многоточие, затем выберите Изменить.

   

   Область справки теперь в режиме правки, и курсор расположен в заголовке панели справки.

3. Из панели редактирования можно выполнять следующие задачи:

   • Введите текст, вводя его непосредственно в области панели справки.
   • Форматируйте текст с помощью возможностей форматированного текста и добавляйте маркированные/нумерованные списки, разделы, видео, изображения, ссылки, пометки тренера и всплывающую подсказку.

4. Чтобы сохранить изменения, выберите Сохранить.

Произвольный текст

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

Маркированные и нумерованные списки

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

Разделы

Раздел — это сворачиваемое текстовое поле. В него можно помещать ссылки или произвольный текст. Используйте раздел, чтобы сгруппировать похожие элементы. Раздел может быть открытым или свернутым по умолчанию.

Видео и статические изображения

Можно вставить видеоролики и статические изображения в область справки. Видеоролики и изображения являются ссылками на содержимое в Интернете. Пользовательские панели справки не хранят видео и графические файлы в панели справки. Когда открыта область справки, пользовательские панели справки получают содержимое из ссылки для его отображения. Можно использовать ссылки на видео Microsoft Stream, если требуется ссылаться на корпоративное частное содержимое.

Совет

Обязательно скопируйте URL-адрес ссылки для видеозаписи или изображения, которое требуется, чтобы можно было вставить его в свою область справки.

Пользовательские панели справки поддерживают следующие источники видео:

• Microsoft Stream (классическая версия) (используйте для частного содержимого)
• YouTube
• Facebook
• Vimeo

Ссылки

Ссылки могут указывать на веб-сайты и открываться в том же окне (по умолчанию) или открываться в отдельном окне. Возможность задавать ссылку на существующую страницу справки еще не включена.

Выноски и обучающие подсказки

Выноски и обучающие метки можно использовать, чтобы указывать на определенные элементы интерфейса. Выноска может содержать текст.

Отметка тренера просто выделяет элемент с помощью указателя тренера, привлекая внимание пользователя к этому элементу в пользовательском интерфейсе.

Автору необходимо определить цель с помощью функции перетаскивания в свойствах всплывающих окон и меток тренера. Автор может ввести текст для заголовка и описания для меток тренера.

Заметка

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

Решения и содержимое настраиваемой панели справки

Все содержимое справки хранится в компоненте страницы справки в Dataverse как часть решения. При перемещении решения из одной среды в другую, например из тестовой в рабочую, вы можете указать, что строки справки должны экспортироваться, чтобы они были включены в состав решения. Это позволяет синхронизировать содержимое справки с функциями решения по мере его перемещения между различными средами. Как часть решения, пользовательские панели справки поддерживают все стандартные функции управления жизненным циклом приложений (ALM).

Перемещение содержимого с помощью решений

По умолчанию все новые страницы справки появляются в решении по умолчанию. Если требуется перенести содержимое с другую среду, сначала добавьте имеющиеся страницы справки в неуправляемое решение перед экспортом их. Для добавления страницы справки к неуправляемому решению выполните следующие действия:

1. Выполните вход в Power Apps.
2. В левой области навигации выберите Решения. Если этого пункта нет на боковой панели, выберите …Еще, а затем выберите нужный пункт.
3. Откройте неуправляемое решение, которое вы хотите.
4. Выберите Добавить существующий на панели команд, а затем выберите Страница справки.
5. Выберите страницы справки, которые требуется добавить, затем выберите Добавить. Дополнительные сведения: Экспорт решений

Автоматизация документации справочной страницы

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

Пользовательские панели справки поддерживают настраиваемый формат XML. Этот формат документирован ниже. Дополнительные сведения: Определение XML-кода настраиваемой справки

При экспорте каждая страница справки экспортируется как отдельный файл.

Сведения об управляемом решении «Контекстная справка»

Функция настраиваемых панелей справки и пошаговых задач включает компоненты решения в управляемом решении «Контекстная справка». Настройка или создание записей с использованием таблиц за пределами настраиваемых областей справки и функции пошаговых задач не поддерживается.

Обратите внимание, что некоторые приложения, такие как Dynamics 365 Sales и Dynamics 365 Service, включают возможности первого запуска, созданные с использованием таблиц, включенных в управляемое решение контекстной справки. Например, обе таблицы — Страница справки (msdyn_helppage) и Пошаговое руководство (msdyn_tour) — используются для создания этих сценариев первого запуска. В настоящее время настраиваемые области справки и функция пошаговых задач не поддерживают создание таких интерфейсов первого запуска.

Вопросы и ответы

В этом разделе перечислены часто задаваемые вопросы о настраиваемых страницах справки.

Пользовательские страницы справки — то же самое, что и настраиваемая справка?

Пользовательские панели справки и управляемые задачи — это варианты в разделе Задать URL-адрес настраиваемой справки системных параметров. Пользовательские панели справки и управляемые задачи включают настраиваемую панель справки, которая отображается непосредственно рядом с формой пользователя. Другие параметры в этом разделе «Настраиваемая справка» данного набора системных настроек относятся к настраиваемым функциям справки. С их помощью можно заменить стандартную справку приложений и указать для пользователей вашей организации другой URL-адрес справки. Альтернативно можно переопределить справку для таблицы с широкими возможностями настройки, чтобы лучше описать бизнес-процесс.

Дополнительные сведения о настраиваемой справке см. в разделе Включение и использование настраиваемой справки.

Как перенести мои данные из траектории обучения на пользовательские страницы справки?

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

В зависимости от того, сколько текста содержится в пошаговой справке, проще всего может быть просто скопировать информацию непосредственно из пользовательского интерфейса траектории обучения в пользовательский интерфейс новой настраиваемой панели справки. Однако вы также можете экспортировать содержимое справочного раздела траектории обучения. Проще всего это сделать, выполнив экспорт содержимого с помощью функции Схема обучения>Библиотека содержимого>Локализовать>Экспорт. Выберите нужные строки и затем экспортируйте их. При этом создается XLIFF-файл для каждой области справки и управляемой задачи. Затем используйте общедоступный редактор XLIFF или конвертер XLIFF в HTML для извлечения содержимого.

Определение XML-кода настраиваемой справки

В этом разделе описывается определение XML-кода настраиваемой справки.

PPHML

<pphml>
    <h1>FAQ</h1>
    <collapsible title="What is PPHML?">
        <p>PPHML is a domain specific language for help content. It is used to create help content that includes elements such as images, videos, balloons, coach marks, etc.</p>
    </collapsible>
    <collapsible title="What does PPHML stand for?">
        <p>PPHML stands for Power Platform Help Markup Language</p>
    </collapsible>
</pphml>

Определение и использование

Элемент <pphml> сообщает браузеру справки, что это документ PPHML.

Элемент <pphml> представляет корень документа PPHML.

Элемент <pphml> является контейнером для всех других элементов PPHML.

Заголовок

Представляет собой заголовок на странице справки.

<h1>This will be displayed at the top of the help page</h1>

Определение и использование

Элемент <h1> определяет заголовок страницы справки.

<h1> Это должно быть первым элементом внутри <pphml>.

Изображение

Отображает изображение на странице справки.

<img src="smiley.gif" alt="Smiley face" title="Smiley face"/>

Определение и использование

Элемент <img> внедряет изображение на страницу справки.

Атрибуты

• src: Указывает URL-адрес изображения. Это обязательный атрибут.

• title: Определяет заголовок, отображаемый вместе с изображением, обычно как подсказка при наведении указателя.

• alt: Указывает альтернативный текст для изображения. Этот текст используется средствами чтения с экрана.

Видео

Отображает видео на справочной странице.

<video src="https://www.youtube.com/watch?v=WSWmn7WM3i4" />

Определение и использование

Элемент <video> внедряет видео, например учебное или обучающее видео, на страницу справки.

Поддерживаемые источники

• Microsoft Stream
• YouTube
• Facebook
• Vimeo

Атрибуты

• src: Указывает URL-адрес видео. Это обязательный атрибут.

• allowFullScreen: Определяет, может ли пользователь переключить видео в полноэкранный режим. Возможные значения: "true" или "false". Этот атрибут поддерживается не для всех источников видео.

• autoplay: Указывает, что воспроизведение видеозаписи начинается сразу же после загрузки страницы справки. Возможные значения: "true" или "false". Этот атрибут поддерживается не для всех источников видео.

• startTime: Определяет, в секундах, с какого места начинается воспроизведение видео.

Абзац

Представляет собой абзац на странице справки.

<p>This is some text in a paragraph.</p>

Определение и использование

Элемент <p> определяет абзац.

Текст внутри абзаца может быть оформлен следующими способами:

• Жирный, с элементом <strong>
• Курсив, с помощью элемента <em>
• Перечеркивание, с помощью элемента <del>
• Подчеркивание, с помощью элемента <u>

Эти элементы оформления можно комбинировать. Например, сделать фрагмент текста одновременно полужирным и подчеркнутым.

Маркированный список

Отображает маркированный список на странице справки.

<ul>
    <li>Coffee</li>
    <li>Tea</li>
    <li>Milk</li>
</ul>

Определение и использование

Элемент <ul> определяет маркированный список.

Используйте элемент <ul> вместе с элементом <li> для создания маркированных списков.

Нумерованный список

Представляет нумерованный список на странице справки.

<ol>
    <li>First step</li>
    <li>Second step</li>
    <li>Third step</li>
</ol>

Определение и использование

Элемент <ol> определяет упорядоченный (нумерованный) список. Используйте тег <ol> вместе с элементом <li> для создания нумерованных списков.

Сворачиваемый

Отображает сворачиваемый раздел на странице справки.

<collapsible title="This is a Section">
    <p>This is a paragraph inside a section</p>
    <img src=smiley.gif" title="This is an image inside a section" />
</collapsible>

Определение и использование

Элемент <collapsible> указывает раздел содержимого, который пользователь сможет просмотреть или скрыть по запросу.

Атрибуты

• collapsed: Указывает, будет ли раздел изначально свернут или развернут. Возможные значения: "true" (свернут) или "false" (развернут).

Ссылка

Отображает ссылку на странице справки.

Ссылка на веб-сайт, которая откроется в новом окне браузера:

<a href="https://www.microsoft.com" target="_blank">Microsoft Home Page</a>

Ссылка на другую страницу справки:

<a href="./LearnMore">Learn More</a>

Определение и использование

<a> Тэг указывает ссылку, которая позволяет пользователю переходить со страницы справки на веб-сайт или на другую страницу справки.

Атрибуты

• href: Указывает URL-адрес веб-сайта или страницы справки, на который требуется перейти. Это обязательный атрибут.
• target: Определяет, где требуется открыть URL-адрес ссылки.
  • Если отсутствует или имеет значение _self, принимается, что это ссылка на другую страницу справки и она открывается в браузере справки.
  • Если задано значение _blank, ссылка открывается в новом окне браузера.
  • Если задано значение _top, ссылка открывается в текущем окне браузера.
  • Если значение является именем элемента iframe, ссылка открывается в этом фрейме iframe.

Обучающая подсказка

Отображает обучающую подсказку на странице справки.

<coachmark target="#my-html-button">Click to highlight the HTML element with id [my-html-button]</coachmark>

Определение и использование

Указатель — это интерактивный элемент, который можно использовать, чтобы привлечь внимание пользователя к определённому элементу пользовательского интерфейса приложения, в котором размещён браузер справки.

Атрибуты

• target: селектор CSS, который задаёт HTML-элемент, над которым будет отображаться обучающая подсказка. Это обязательный атрибут.

Всплывающая подсказка

Отображает всплывающую подсказку на странице справки.

<balloon target="#my-html-button" title="This button submits the form" details="Please click this button to continue and submit the form">Click to show a balloon over the HTML element with id [my-html-button]</balloon>

Определение и использование

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

Атрибуты

• target: селектор CSS, который указывает HTML-элемент, над которым отображается ссылка всплывающей подсказки. Это обязательный атрибут.
• title: Определяет заголовок выноски.
• details: Указывает содержимое, отображаемое внутри выноски.