Display Custom Examples

How to Display Examples

To display examples such as videos, published program scripts, or other files that illustrate the use of your programs within the MathWorks^® documentation, follow these steps:

1. Create your example files. To create examples from scripts or functions, you can convert the files to formatted HTML files in MATLAB^® using either of these two methods:

   • Create a live script (*.mlx) and export it to HTML. For more information, see Ways to Share and Export Live Scripts and Functions.

   • Create a script (*.m), and publish it to HTML. For more information, see Publish and Share MATLAB Code.

   Store all your example files and any supporting files (such as PNG and CSS files) for your toolbox in the folder (of a subfolder of the folder) that contains your demos.xml file. This folder must be:

   • On the MATLAB search path

   • Outside the matlabroot folder

   • Outside any installed hardware support package help folder

2. Create a demos.xml file that describes the name, type, and display information for your examples. Place the file in the folder (or a subfolder of the folder) that contains your info.xml file. For more information about creating an info.xml file, see Display Custom Documentation.

   For example, suppose that you have a toolbox named My Sample, which contains a script named my_example that you published to HTML. This demos.xml file allows you to display my_example:

   <?xml version="1.0" encoding="utf-8"?>
   <demos>
       <name>My Sample</name>
       <type>toolbox</type>
       <icon>HelpIcon.DEMOS</icon>
       <description>This text appears on the main page for your examples.</description>
       <website><a href="https://www.mathworks.com">Link to your Web site</a></website>
   
       <demosection>
           <label>First Section</label>
           <demoitem>
               <label>My Example Title</label>
               <type>M-file</type>
               <source>my_example</source>
           </demoitem>
       </demosection>
   
   </demos>

3. View your examples.

   In your system web browser, navigate to the MathWorks documentation home page. On the left side of the home page, under Supplemental Software, click the link for your example.

   If your examples do not display under Supplemental Software, the demos.xml file might contain an invalid construct.

Elements of the demos.xml File

Within the demos.xml file, you can include general information in the <demos> tag, define individual examples using the <demoitem> tag, and optionally define categories using the <demosection> tag.

Include General Information Using <demos> Tag

Within the demos.xml file, the root tag is <demos>. This tag includes elements that determine the contents of the main page for your examples.

XML Tag	Notes
<name>	Name of your toolbox or collection of examples.
<type>	Possible values are matlab, simulink, toolbox, or blockset.
<icon>	Ignored in MATLAB R2015a and later. In previous releases, this icon was the icon for your example. In those releases, you can use a standard icon, HelpIcon.DEMOS. Or, you can provide a custom icon by specifying a path to the icon relative to the location of the demos.xml file.
<description>	The description that appears on the main page for your examples. Starting in R2021a, character data is not supported in the description of the demos.xml file. If your demos.xml file contains character data such as &lt;, &gt;, &apos;, &quot;, and &amp; in the description, the description does not appear correctly in the documentation. To automatically replace existing character data with non-character data, use the patchdemoxmlfile function.
<website>	(Optional) Link to a website. For example, MathWorks examples include a link to the product page at https://www.mathworks.com.

Define Examples Using <demoitem> Tag

XML Tag	Notes
<label>	Defines the title to display in the browser.
<type>	Possible values are M-file, model, M-GUI, video, or other. Typically, if you published your example using the publish function, the appropriate <type> is M-file.
<source>	If <type> is M-file, model, M-GUI, then <source> is the name of the associated .m file or model file, with no extension. Otherwise, do not include a <source> element, but include a <callback> element.
<file>	Use this element only for examples with a <type> value other than M-file when you want to display an HTML file that describes the example. Specify a relative path from the location of demos.xml.
<callback>	Use this element only for examples with a <type> value of video or other to specify an executable file or a MATLAB command to run the example.
<dependency>	(Optional) Specifies other products required to run the example, such as another toolbox. The text must match a product name specified in an info.xml file that is on the search path or in the current folder.

Define Categories Using <demosection> Tag

Optionally, define categories for your examples by including a <demosection> for each category. If you include any categories, then all examples must be in categories.

Each <demosection> element contains a <label> that provides the category name, and the associated <demoitem> elements.