显示示例,如视频、已发布的程序脚本或其他文件,以说明您的程序在MATLAB中的使用®帮助浏览器,遵循以下步骤:
创建示例文件。要从脚本或函数创建示例,您可以使用以下两种方法之一在MATLAB中将文件转换为格式化的HTML文件:
创建活动脚本(* .mlx
),并将其导出为HTML。有关更多信息,请参见共享实时脚本和功能.
创建脚本(* 00
),并将其发布为HTML。有关更多信息,请参见发布和共享MATLAB代码.
将工具箱的所有示例文件和支持文件(如PNG和CSS文件)存储在文件夹的子文万博1manbetx件夹中demos.xml
文件。这个文件夹必须是:
在MATLAB中搜索路径
外的
文件夹matlabroot
外部任何已安装的硬件支持包帮助文件夹万博1manbetx
创建一个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
查看您的例子。
在帮助浏览器中,导航到主页。在这一页的底部,在补充软件单击示例的链接。您的示例将在主帮助窗口中打开。
如果你的例子没有显示在补充软件,demos.xml
文件可能包含无效的构造。
在demos.xml
文件中,可以包含一般信息<演示>
标签,使用< demoitem >
标签,并可选地使用< demosection >
标签。
<演示>
标签在demos.xml
文件中,根标记为<演示>
.这个标记包含决定示例的主页内容的元素。
XML标记 |
笔记 |
---|---|
|
工具箱或示例集合的名称。 |
|
可能的值是 |
|
在MATLAB R2015a及后续版本中被忽略。 在以前的版本中,此图标是示例的图标。在这些版本中,你可以使用标准图标, |
|
显示在示例主页面上的描述。 从R2021a开始,字符数据的描述不支持万博1manbetx |
|
(可选)链接到一个网站。例如,MathWorks®例子包括到产品页面的链接 |
< demoitem >
标签XML标记 |
笔记 |
---|---|
|
定义要在浏览器中显示的标题。 |
|
可能的值是 通常,如果您使用publish函数发布示例,则适当的 |
|
如果 |
|
此元素仅用于带有a的示例 |
|
此元素仅用于带有a的示例 |
|
(可选)指定运行示例所需的其他产品,如另一个工具箱。s manbetx 845标签中指定的产品名称必须匹配 |
< demosection >标记
可选地,通过包含< demosection >
为每个类别。如果你包括任何类别,然后所有例子必须在类别中。
每一个< demosection >
元素包含一个<标识>
提供类别名称和关联的< demoitem >
元素。