Documentation edit page

Use the left sidebar to navigate through the different topics. Note that all documentation pages are essentially MTEX scripts. You have a copy of them in your MTEX download, with a file name equal to the last part of the URL with .html swapped for .m (so this page is Documentation.m). This means you can open them in MATLAB by typing

edit fileName

This allows you to execute the sections step by step and investigate the effect of each single MTEX command. It also should motivate you to play around with different parameters, different input files, or further analysis steps. Eventually, these documentation scripts may serve as a good starting point for your own analysis scripts.

Contributing to the Documentation

Documenting a project like MTEX is a challenging and ongoing task. Therefore, we are extremely happy about any spelling fixes, examples, theoretical explanations, special use cases, etc. As a bonus, everybody who contributes to MTEX will automatically appear on the contributors page.

The easiest way to suggest changes to the MTEX documentation is online via GitHub. This is done as follows:

  1. sign into GitHub
  2. open the help page you want to change, e.g., this one
  3. click edit page, which leads you to the file on GitHub
  4. click the little pencil in the top right corner, which allows you to edit the script online
  5. enter or copy and paste your changes into the site
  6. click at the bottom Propose changes
  7. click create pull request

Alternatively, you can send us your changes simply by email.

The Publish Command

You may get a visual preview of your altered documentation page by using the matlab function publish 

publish filename

which creates an folder, named html, in your current directory where you can find the generated html page.