Define an equation in the html file for custom documentation

Hello everybody,

I am writing a custom documentation for a toolbox, we developed, using this tutorial

https://de.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html

In the HTML Help Files I want to define mathematical equations using Latex. We want to display the documentation in the Help Menu of Matlab. We don't want to depend on other external libraies like MathJax, etc.

I tried using the '&&' symbol, but the Help menu won't render the equations:

What am I doing wrong? What would be the correct approach to define equations in the html files?

Thank you everybody and with best wishes,

Lars

Answer 1

[Les Beckham]

If you create your help html file(s) using this approach (from the link you referenced): Create a live script (*.mlx) and export it to HTML., you can include Latex equations using the methods outlined here: Insert Equations into the Live Editor.

[Lars Lindner]

He Les Beckham, so, your approach is working, I have tried it out. Nevertheless, I still had to tweak the latex formulas in the Live Editor to make them fit :(

Anyway, I haven't found a reasonable description from Matlab on how to create html files for custom documentation without using the Live Editor or .m files. This description here is not very helpful:

https://de.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html

My goal is to have full control over the html files when creating them. I want to use my own editor (e.g. VSCode) to create the html files and not the Live Editor, because I don't really understand what the Live Editor outputs when converting .mlx to .html.

So, if someone can offer me some help on what the basic structure of an html file (which you want to include as costum documentation and including equations) must looks like, then I would be very happy.

Thank you everybody and with best wishes,

Lars

Answer 2

[Lars Lindner]

Hello Les Beckham, thank you very much for your quick reply.

Your solution is of course the trivial solution, but it is not quite suitable for my case, because I already have html files with defined latex formulas. When I open these html files with Brave or Firefox, the latex formulas are displayed normally.

For some reason unknown to me, the latex formulas are not displayed correctly in the Matlab Help Menu! Maybe I have to make a setting in Matlab or install an additional tool?

However, I first wanted to try to create the html files using an external editor (e.g. VSCode) without having to use the Matlab Live Editor.

Maybe you have another idea? Thank you again and with best wishes,

Lars

[Les Beckham]

You're welcome.

I'm afraid I don't have any ideas about why the equations look right in a browser and not in the Help system.

Hopefully someone else can help. You should also consider filing a service request here (if you have current software maintenance): Contact Support

Have a good weekend.