Borrar filtros
Borrar filtros

Adding custom documentation to Matlab

22 visualizaciones (últimos 30 días)
EvanW
EvanW el 12 de Jul. de 2019
Respondida: Shubham el 21 de Ag. de 2024 a las 4:10
I'm trying to add my own custom Matlab documentation to the Matlab Help (doc).
Previously, I used custom html files which could be viewed in the Matlab browser (web), but I prefer to use the standard documentation browser such that the environment of the documentation aligns with the Matlab documentation.
I've found the article that has been written about adding custom documentation (Display Custom Examples), but I still don't get it working. This Question is related to my question, but my documentation does not show up in the Help when I follow the givern answer.
Does anyone have an example (preferably in downloadable files) that does work, which I can use as reference?

Iniciar sesión para responder a esta pregunta.

Respuesta aceptada

EvanW
EvanW el 15 de Jul. de 2019
I've found supplemental software for Matlab which uses custom documentation and I've used this as an example. I got it working now.
  2 comentarios
Tobias Held
Tobias Held el 27 de Mayo de 2022
Thank you for your follow up but could you also share the supplemental software? :)
Yuhang Li
Yuhang Li el 15 de Feb. de 2023
I think you need to create a tool box first

Iniciar sesión para comentar.

Más respuestas (1)

Shubham
Shubham el 21 de Ag. de 2024 a las 4:10
Hi Evan,
As per my understanding, you want to add "Custom Documentation" to the MATLAB Help Browser.
You can do so by following these steps:
1. Creating HTML Help Files containing your custom documentation information
<html lang="en">
<head>
<meta charset="UTF-8">
<title>MathJax Test</title>
</head>
<body>
<h1>MathJax Equation</h1>
<p>Here is an equation:</p>
<p>
a=b+c
</p>
</body>
</html>
2. Creating "info.xml" file for identifying your HTML help files
<?xml version="1.0" encoding="utf-8"?>
<productinfo
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="optional">
<?xml-stylesheet type="text/xsl" href="optional"?>
<matlabrelease>R2024a</matlabrelease>
<name>MyToolbox</name>
<type>toolbox</type>
<icon></icon>
<help_location>help</help_location>
</productinfo>
3. Creating "helptoc.xml" file defining the "Table of Contents" displayed in the Contents pane of the Supplemental Software browser
<?xml version="1.0" encoding="utf-8"?>
<toc version="2.0">
<tocitem target="example.html">MathJax Example</tocitem>
</toc>
4. To make your documentatoin searchable, create a search database using the "builddocsearchdb" function.
builddocsearchdb('path_to_your_html_help_files')
5. Updating the documentation using the command "rehash toolboxcache".
Please note that you need to place the HTML help files and "helptoc.xml" file in the same folder which in the above example is named as "help".
Refer to the following documentation link for more information on creating "Custom Documentation":
https://mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html
Hope this helps.

Categorías

Más información sobre Adding custom doc en Help Center y File Exchange.

Etiquetas

Productos


Versión

R2019a

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Translated by