主要内容

显示自定义的例子

如何显示示例

显示示例,如视频、已发布的程序脚本或其他文件,以说明您的程序在MATLAB中的使用®帮助浏览器,遵循以下步骤:

  1. 创建示例文件。要从脚本或函数创建示例,您可以使用以下两种方法之一在MATLAB中将文件转换为格式化的HTML文件:

    将工具箱的所有示例文件和支持文件(如PNG和CSS文件)存储在文件夹的子文万博1manbetx件夹中demos.xml文件。这个文件夹必须是:

    • 在MATLAB中搜索路径

    • 外的matlabroot文件夹

    • 外部任何已安装的硬件支持包帮助文件夹万博1manbetx

  2. 创建一个demos.xml文件,用于描述示例的名称、类型和显示信息。将文件放入包含您的文件夹(或文件夹的子文件夹)info.xml文件。有关创建info.xml文件的更多信息,请参考显示自定义文档

    例如,假设您有一个名为我的样本,其中包含一个名为my_example你发布到HTML的。这demos.xml文件允许显示my_example

    <?xml version = " 1.0 " encoding = " utf - 8 " ?>  My Sample toolbox HelpIcon。演示 This text appears on the main page for your examples. Link to your Web site     M-file my_example   
  3. 查看您的例子。

    在帮助浏览器中,导航到主页。在这一页的底部,在补充软件单击示例的链接。您的示例将在主帮助窗口中打开。

    如果你的例子没有显示在补充软件,demos.xml文件可能包含无效的构造。

xml文件的元素

demos.xml文件中,可以包含一般信息<演示>标签,使用< demoitem >标签,并可选地使用< demosection >标签。

包括一般信息<演示>标签

demos.xml文件中,根标记为<演示>.这个标记包含决定示例的主页内容的元素。

XML标记

笔记

<名称>

工具箱或示例集合的名称。

<类型>

可能的值是matlab万博1manbetx工具箱,或blockset

<图标>

在MATLAB R2015a及后续版本中被忽略。

在以前的版本中,此图标是示例的图标。在这些版本中,你可以使用标准图标,HelpIcon。演示.控件的位置指定图标的路径,也可以提供自定义图标demos.xml文件。

<描述>

显示在示例主页面上的描述。

从R2021a开始,字符数据的描述不支持万博1manbetxdemos.xml文件。如果你的demos.xml文件包含字符数据,例如& lt;比;'“;,,在描述中,描述在帮助浏览器中不能正确显示。若要用非字符数据自动替换现有字符数据,请使用patchdemoxmlfile函数。

<网站>

(可选)链接到一个网站。例如,MathWorks®例子包括到产品页面的链接//www.tianjin-qmedu.com

定义示例使用< demoitem >标签

XML标记

笔记

<标识>

定义要在浏览器中显示的标题。

<类型>

可能的值是m文件模型M-GUI视频,或其他

通常,如果您使用publish函数发布示例,则适当的<类型>m文件

源> <

如果<类型>m文件模型M-GUI,然后源> <关联的名称是什么.m文件或模型文件,没有扩展名。否则,不包括a源> <元素,但包含回调> <元素。

<文件>

此元素仅用于带有a的示例<类型>以外的价值m文件当您想要显示一个描述示例的HTML文件时。的位置指定一个相对路径demos.xml

回调> <

此元素仅用于带有a的示例<类型>的价值视频其他指定一个可执行文件或MATLAB命令来运行示例。

< >的依赖

(可选)指定运行示例所需的其他产品,如另一个工具箱。s manbetx 845标签中指定的产品名称必须匹配info.xml在搜索路径或当前文件夹中的文件。

定义分类使用< demosection >标记

可选地,通过包含< demosection >为每个类别。如果你包括任何类别,然后所有例子必须在类别中。

每一个< demosection >元素包含一个<标识>提供类别名称和关联的< demoitem >元素。

另请参阅

相关的话题