主要内容

显示自定义的例子

如何显示的例子

显示的例子,如视频,发布程序脚本,或其他文件,说明了使用MATLAB的程序®帮助浏览器,遵循这些步骤:

  1. 创建你的例子文件。创建脚本的例子或功能,您可以将文件转换为格式化的HTML文件在MATLAB使用这两个方法:

    存储所有示例文件和任何支持文件(如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 " ?> <演示> <名称>样本< /名称> <类型>工具箱< /类型> <图标> HelpIcon。演示< /图标> <描述>这个文本出现在主页的例子。< /描述> <网站> < a href = " //www.tianjin-qmedu.com " >链接到你的网站< / > < /网站> < demosection > <标记>第一节< /标签> < demoitem > <标记>我的例子标题标签< / > < >型m文件< /类型> <源> my_example < /源> < / demoitem > < / demosection > < /演示>

  3. 查看您的例子。

    在帮助浏览器,导航到主页。在页面的底部,下补充软件点击你的链接的例子。你的例子主要帮助窗口打开。

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

演示的元素。xml文件

在demos.xml文件,您可以包括一般信息<演示>标签定义个人使用例子< demoitem >使用标签,选择定义类别< demosection >标签。

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

在demos.xml文件,根标签<演示>。这个标签包含元素,确定主页的内容对你的例子。

XML标记

笔记

<名称>

名字你的工具箱或集合的例子。

<类型>

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

<图标>

在MATLAB R2015a忽略,后来。

在以前的版本中,这个图标的图标的例子。在这些版本中,您可以使用一个标准的图标,HelpIcon.DEMOS。或者,你可以提供一个自定义图标图标通过指定路径相对的位置demos.xml文件。

<描述>

出现在主页的描述你的例子。

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

<网站>

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

定义示例使用< demoitem >标签

XML标记

笔记

<标识>

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

<类型>

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

通常,如果你发表你的例子使用发布功能,适当的<类型>是m文件。

<源>

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

<文件>

使用这个元素只与一个例子<类型>以外的价值m文件当你想要显示一个HTML文件,描述了示例。指定一个位置的相对路径demos.xml。

<调>

使用这个元素只与一个例子<类型>的价值视频或其他指定一个可执行文件或MATLAB命令来运行示例。

<依赖>

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

定义分类使用< demosection >标签

可选地,为你的例子包括定义类别< demosection >为每个类别。如果你包括任何类别,然后所有必须在类实例。

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

另请参阅

相关的话题