Поділитися через

Створіть інтерактивну довідку для вашої програми єдиного інтерфейсу

  • Стаття

Використовуйте настроювані області довідки та відстежувані завдання, щоб додати до вашої програми єдиного інтерфейсу настроювану, вбудовану в програму довідку, створену з урахуванням потреб вашої організації. Використовуйте настроювані області довідки для надання контекстної довідки та вказівок у таблицях та формах різними мовами, використовуючи форматований текст, посилання на вміст, зображення та посилання на відео.

Важливо

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

Настроювані області довідки та навчальний шлях

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

Настроювані області довідки пропонують такі ключові функції, що не є доступними при використанні навчального шляху:

  • Форматований текст довільної форми, зокрема маркери та нумерація.
  • Візуально цілісні помітки лектора та довідкові виноски.
  • Більше варіантів джерел відео, зокрема приватні джерела.
  • Зберігання вмісту довідки в Microsoft Dataverse в якості частини вашого рішення.

Настроювані області довідки не мають таких ключових функцій, що доступні при використанні навчального шляху:

  • Послідовні довідкові виноски.
  • Сторінки довідки для кожної ролі.
  • Сторінки довідки для кожного форм-фактору пристрою, наприклад, для смартфонів.

вимоги

Щоб скористатися функцією настроюваних областей довідки, слід використовувати таке середовище:

Увімкніть настроювані області довідки для вашого середовища

  1. Відкрийте модельну програму, а потім на панелі команд виберіть Настройки Настройки. > Додаткові настройки.

  2. Виберіть Настройки > Система > Адміністрування.

  3. На сторінці Адміністрування натисніть Настройки системи.

  4. На вкладці Загальне у розділі Встановити URL-адресу настроюваної довідки, виберіть Так для Включити настроювані довідкові сторінки та відстежувані завдання, а потім виберіть ОК.

    Увімкнути настроювані області довідки.

Важливо

  • Ви можете включити настроювані області довідки або настроювану довідку, але не обидві опції одночасно. Значення обох параметрів Використовувати настроювану довідку для настроюваних таблиць і Додавати параметри до URL-адреси обов’язково мають бути встановлені як Ні.
  • У деяких середовищах потрібно задати для Увімкнути навчальний шлях значення Так.

Необхідні права

  • Для створення областей довідки, розробникам програм потрібні глобальні створення, читання, записування, видалення, додавання та додавання прав на сторінці Довідка. За замовчуванням ролі безпеки системного адміністратора та настроювача системи включають це право.
  • Для перегляду областей довідки у програмі користувачам потрібне право на читання в таблиці Довідка. За замовчуванням роль безпеки «Користувач сторінки довідки» має такий дозвіл. За замовчуванням у роль безпеки «Основний користувач» немає прав на таблицю «Довідка».

Додаткові відомості: Ролі безпеки і права

Контекстна настроювана довідка

Кожна область довідки є унікальною для таких контекстів:

  • Додаток
  • Таблиця
  • Форма
  • Language

Навігація в області довідки

За замовчуванням область довідки лишається відкритою і відображає вміст довідки, який ви відкрили першим, навіть якщо ви переходите до іншої форми. Це дозволяє лишити вміст довідки незмінним, якщо ви спрямуєте користувачів до інших областей програми.

Для створення власного вмісту області довідки

  1. Щоб побачити область довідки, відкрийте програму на основі моделі, а потім виберіть Довідка на панелі команд.

    Довідка.

  2. У області довідки виберіть три вертикальні крапки, а потім виберіть Редагувати.

    Редагування довідки.

    Тепер область довідки перебуває в режимі редагування, а курсор знаходиться у заголовку області довідки.

  3. У області редагування можна виконати наступні завдання:

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

  4. Щоб зберегти зміни, виберіть Зберегти.

Текст довільної форми

Текст можна розміщати будь-де в межах області довідки. Введіть текст довільної форми перед розділами, в розділах або після них. Текст підтримує формати шрифту «жирний», «курсив», «підкреслений» та «закреслений». Можна використовувати команди «вирізати», «копіювати» та «вставити», а також скасування кількох дій.

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

Якщо вибрати піктограму маркера або номера, поточний рядок перетвориться на маркірований або нумерований. Якщо вибрати кілька рядків у списку, кожен рядок стане маркірованим або нумерованим. Табуляція та відступ пронумерує відповідно до списку.

Розділи

Розділ – це текстове поле, яке можна згорнути. Ви можете розмістити в ньому посилання або текст довільної форми. Використовуйте розділи для групування подібних елементів. За замовчуванням розділ може бути відкритим або згорнутим.

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

Ви можете вставляти відео та статичні зображення у вашу область довідки. Відео та зображення — це посилання на вміст в інтернеті. Настроювані області довідки не зберігають відеофайли та файли зображень у вашій області довідки. Коли область довідки відкривається, настроювані області довідки завантажують вміст за посиланням, щоб відобразити його. Ви можете використовувати посилання на відео Microsoft Stream, якщо хочете навести корпоративний приватний вміст.

Підказка

Не забудьте скопіювати URL-адресу потрібного відео або зображення, щоб потім вставити його у вашу область довідки.

Настроювані довідкові сторінки підтримують такі джерела відео:

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

Посилання можуть вести на веб-сторінки і відкриватися у тому ж вікні (за замовчуванням) або в окремому вікні. Наразі немає можливості додати посилання на наявну довідкову сторінку.

Довідкові виноски та помітки лектора

Виноски та помітки лектора можуть вказувати на певні елементи інтерфейсу користувача. Виноска може мати на собі текст.

Вставити виноску

Помітка лектора просто виділяє елемент за допомогою вказівника лектора, щоб привернути увагу користувача до цього елемента інтерфейсу.

Вставити помітку лектора

Автору потрібно визначити цільовий об’єкт, перетягнувши можливості у властивостях виносок та поміток лектора. Автор може ввести текст заголовка та опису для поміток лектора.

Перетягнути

Примітка

  • Виноски й помітки лектора працюють не надто добре з користувацькими компонентами. Ця функція застосовується лише до стандартних компонентів єдиного інтерфейсу.
  • Послідовні довідкові виноски й помітки лектора наразі не підтримуються.

Рішення і вміст настроюваних областей довідки

Увесь вміст довідки зберігається у компоненті довідкової сторінки в Dataverse в якості частини вашого рішення. Під час переміщення рішення з одного середовища до іншого, наприклад, з тестового до виробничого, можна визначити, які рядки довідки буде експортовано та додано до рішення. Це дозволить вам підтримувати вміст довідки у відповідності до функцій вашого рішення, яке переходить до інших середовищ. Як частина рішення, настроювані області довідки підтримують усі стандартні функції керування життєвим циклом рішення.

Перенесення вмісту за допомогою рішень

За замовчуванням усі нові довідкові сторінки з’являються у рішенні за замовчуванням. Якщо ви хочете перенести вміст до іншого середовища, спершу додайте наявні довідкові сторінки до некерованого рішення, і лише після цього експортуйте їх. Щоб додати довідкову сторінку до некерованого рішення, виконайте такі дії:

  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: вказує вміст, що відображатиметься всередині виноски.

Примітка

Розкажіть нам про свої уподобання щодо мови документації? Візьміть участь в короткому опитуванні. (зверніть увагу, що це опитування англійською мовою)

Проходження опитування займе близько семи хвилин. Персональні дані не збиратимуться (декларація про конфіденційність).