为模型驱动应用程序创建引导式帮助

使用自定义帮助窗格和向导型任务，为您的统一接口应用程序提供为您的组织定制的自定义产品内帮助体验。 使用自定义帮助窗格提供针对表格、窗体和特定语言的帮助和指导内容，其中包括富文本、内容链接、图像和视频链接。

重要

  • 自定义帮助窗格取代了以前用于旧版 Web 客户端应用的学习路径引导式帮助功能。
  • 自定义帮助窗格不适用于在移动设备（如 Android 和 iOS 平板电脑和智能手机）上运行的统一接口应用。

自定义帮助窗格和学习路径

自定义帮助窗格的新的引导式帮助实现不同于以前的学习路径引导式帮助功能。 这两种功能都可以为您的应用程序创建自定义帮助。 但是，自定义帮助窗格针对最常见的引导式帮助场景进行了优化。

自定义帮助窗格提供了学习路径未提供的以下关键功能：

  • 自由格式富文本，包括项目符号和编号。
  • 可见链接指导标记和帮助提示框。
  • 更多视频源选项，包括私人源。
  • 将帮助内容作为解决方案的一部分存储在 Microsoft Dataverse 中。

自定义帮助窗格不提供学习路径提供的以下关键功能：

  • 顺序帮助提示框。
  • 按角色提供帮助页面。
  • 按设备外形分类的帮助页面，例如智能手机。

先决条件

要使用自定义帮助面板功能，您的环境需要启用自定义帮助面板环境设置。

为您的环境启用自定义帮助窗格

  1. 在 https://admin.powerplatform.microsoft.com 登录到 Power Platform 管理中心。
  2. 在左窗格中选择“ 管理 ”，然后打开所需的环境。
  3. 在命令栏上选择设置，然后选择产品>功能。
  4. 在帮助功能下，将启用自定义帮助面板设为开。

重要

确保 可自定义实体的自定义帮助 设置为 “否”，否则无法启用 “启用自定义帮助窗格”。 这是因为不能同时使用自定义帮助窗格和可自定义帮助。

所需权限

  • 要编写帮助窗格，应用创建者需要拥有对帮助页面表的全局创建、读取、写入、删除、附加和附加到权限。 默认情况下，系统管理员和系统定制员安全角色均具有此特权。
  • 要查看应用中的帮助窗格，用户需要对帮助页面表具有读取特权。 默认情况下，“帮助页面用户”安全角色具有此特权。 默认情况下，基本用户安全角色对帮助页面表没有任何特权。

详细信息：安全角色和特权

上下文相关的自定义帮助

每个帮助窗格对于以下上下文是唯一的：

  • 表
  • 表格
  • 仪表板​​
  • 语言
  • 应用程序

帮助窗格导航

默认情况下，帮助窗格保持打开状态并位于您使用它第一次打开的帮助内容上，即使您导航到其他窗体。 这样，当您将用户定向到应用的不同部分时，帮助内容将保持不变。

编写帮助窗格内容

  1. 要查看帮助窗格，请打开模型驱动应用，然后在命令栏上选择帮助。

    帮助

  2. 在“帮助”窗格上，选择垂直省略号，然后选择编辑。

    编辑帮助。

    帮助窗格现在处于编辑模式，光标位于帮助窗格标题上。

  3. 在编辑窗格中可以执行以下任务：

    • 直接在帮助窗格中键入文本。
    • 使用富文本功能对文本进行格式设置，并添加项目符号列表和编号列表、章节、视频、图像、链接、引导标记和气泡帮助。

  4. 要保存更改，请选择保存。

自由形式的文本

文本可以放在帮助窗格中的任何位置。 在各部分之前、之中或之后输入自由形式的文本。 文本支持粗体、斜体、下划线和删除线格式。 支持剪切、复制、粘贴以及多级撤销操作。

项目符号和编号列表

选择项目符号或编号图标可切换当前行，使其加上项目符号或编号。 如果您在列表中选择了多行，则每行都将加上项目符号或编号。 制表符和缩进子编号在列表中对齐。

章节

部分是可折叠的文本框。 您可以在其中放置链接或自由形式的文本。 使用分区对相似项进行分组。 部分可以默认打开或折叠。

视频和静态图像

您可以将视频和静态图像插入帮助窗格。 视频和图像是 Internet 上内容的链接。 自定义帮助窗格不会在您的帮助窗格中存储视频和图像文件。 打开帮助窗格时，自定义帮助窗格会将内容从链接引入以显示它。 如果要引用企业专用内容，可以使用指向 Microsoft Stream 视频的链接。

小费

请记住复制所需视频或图像的链接 URL，以便将其粘贴到帮助窗格中。

自定义帮助窗格支持以下视频源：

  • Microsoft Stream（经典）（用于专用内容）
  • YouTube
  • Facebook
  • Vimeo

链接可以指向网站，并且可以在同一窗口（默认）中打开，也可以在单独的窗口中打开。 链接到现有帮助页面的功能尚未启用。

气泡提示和引导标记

提示框和引导提示可用于指示特定的 UI 元素。 气泡中可以包含文本。

插入气球

指导标记只是用指导指针突出显示一个元素，以将用户的注意力吸引到该 UI 元素上。

插入引导标记

作者需要在提示框和指导标记的属性中通过拖放功能定义目标对象。 作者可以输入标题的文本和指导标记的描述。

拖放

备注

  • 气泡提示和引导标注在自定义组件中效果不佳。 此功能仅适用于默认统一接口 UI 组件。
  • 尚不支持按顺序显示的帮助气泡和引导标记。

解决方案和自定义帮助窗格的内容

所有帮助内容都作为解决方案的一部分存储在 Dataverse 的帮助页面组件中。 当您将解决方案从一个环境移到另一个环境（如从测试到生产）时，可以定义导出帮助行，以将其包含在解决方案中。 这使您可以在解决方案移到其他环境时将帮助内容与解决方案中的功能同步。 作为解决方案的一部分，自定义帮助窗格支持所有标准解决方案应用程序生命周期管理 (ALM) 功能。

通过解决方案迁移内容

默认情况下，所有新的帮助页面都会显示在默认解决方案中。 如果要将内容移动到另一个环境，请先将现有帮助页面添加到非托管解决方案中，然后再导出它们。 要将帮助页面添加到非托管解决方案，请按照下列步骤操作：

  1. 登录到 Power Apps。
  2. 在左侧导航窗格中，选择解决方案。 如果项目不在侧面板窗格中，请选择 …更多，然后选择所需项目。
  3. 打开所需的非托管解决方案。
  4. 在命令栏中选择添加现有，然后选择帮助页。
  5. 选择想要添加的帮助页，然后选择添加。 详细信息：导出解决方案

帮助页面文档自动生成

您可能希望将内容备份或存储在源代码控制系统中。 您可能还希望在帮助窗格内容上使用文档自动化工具，例如翻译工具或检查器。 自定义帮助窗格数据直接存储在 Dataverse 中，并且可以为此目的导出和导入。

自定义帮助窗格支持自定义 XML 格式。 此格式在下面有记录。 更多信息：自定义帮助 XML 定义

导出后，每个帮助页面都将导出为单独的文件。

关于上下文帮助托管解决方案

自定义帮助窗格和引导式任务功能由“上下文帮助”托管解决方案中的各个解决方案组件构成。 不支持使用自定义帮助窗格和向导型任务功能之外的表自定义或创建记录。

请注意，某些应用（如 Dynamics 365 Sales 和 Dynamics 365 Service）包含首次运行体验功能，这些功能基于“上下文相关帮助”托管解决方案中包含的表构建。 例如，帮助页面 (msdyn_helppage) 和教程 (msdyn_tour) 表都用于创建这些首次运行体验。 目前，自定义帮助窗格和向导型任务功能不支持创建这些首次运行体验。

常见问题解答

本节讨论有关自定义帮助页面的常见问题。

自定义帮助页面与可自定义帮助相同吗？

自定义帮助窗格和向导型任务是系统设置的设置自定义帮助 URL 部分的一个选项。 自定义帮助窗格和引导式任务可实现可自定义的帮助窗格，使其显示在用户表单旁边。 此系统设置的“设置自定义帮助”部分中的其他选项包括可自定义的帮助功能。 它们使您可以替代默认的应用帮助，并将组织中的用户指向其他 URL 以获得帮助。 或者，您可以覆盖高度自定义表格的帮助内容，以便更好地描述您的工作流程。

有关可自定义帮助的更多信息，请参阅启用和使用可自定义帮助。

如何将数据从学习路径迁移到自定义帮助页面？

学习路径有两种类型的帮助：帮助窗格和顺序帮助提示框。 顺序帮助提示框位置已与旧版 Web 客户端 UI 深度集成，无法转移到新的自定义帮助窗格。

这取决于您的引导式帮助中的文本量；最简单的做法可能是直接将信息从学习路径用户界面复制到新的自定义帮助窗格用户界面。 不过，您也可以导出学习路径帮助内容。 最简单的方法是使用学习路径>内容库>本地化>导出功能导出您的内容。 选择所需的行，然后将其导出。 这将为每个帮助窗格和向导型任务创建一个 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>

定义和使用

指导标记是一个交互式元素，可用于将用户的注意力吸引到托管帮助浏览器的应用程序 UI 中的特定点。

属性

  • target：指定在其上显示指导标记的 HTML 元素的 CSS 选择器。 此属性是必需的。

气球提示

在帮助页中显示气泡提示。

<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：指定将显示气泡提示链接的 HTML 元素的 CSS 选择器。 此属性是必需的。
  • title：指定气球提示的标题。
  • details：指定要在气泡中显示的内容。
  • Last updated on