mtexShowDoc edit page

open a page of the MTEX documentation, installed copy or online

Description

The HTML documentation is generated by makeDoc and ships with a release, but doc/html is not part of the repository, and even a local build does not contain every page. A link into it then points at a file that is not there and clicking it does nothing at all - no page, no message. So a page that is not installed is looked up online instead, which keeps the links in the command window working for everyone running MTEX from a clone.

Syntax

mtexShowDoc('EBSDReferenceFrame')
url = mtexShowDoc('EBSDReferenceFrame')  % resolve only, do not open

Input

page name of the documentation page, with or without the .html suffix

Output

url where the page was looked up; asking for it opens nothing

See also

doclink

Citing this page. This page is part of the documentation of MTEX, a free and open source MATLAB toolbox for analyzing and modeling crystallographic textures. It was written by The MTEX Developers and is published at https://mtex-toolbox.github.io/mtexShowDoc.html. If you use MTEX, or reuse text or figures from this page, in your research, please cite

F. Bachmann, R. Hielscher, H. Schaeben: Texture Analysis with MTEX - Free and Open Source Software Toolbox, Solid State Phenomena 160 (2010), 63-68. 10.4028/www.scientific.net/SSP.160.63

BibTeX 
@article{bachmann2010mtex,
  author  = {F. Bachmann and R. Hielscher and H. Schaeben},
  title   = {Texture Analysis with MTEX - Free and Open Source Software Toolbox},
  journal = {Solid State Phenomena},
  volume  = {160},
  pages   = {63-68},
  year    = {2010},
  doi     = {10.4028/www.scientific.net/SSP.160.63},
  url     = {https://doi.org/10.4028/www.scientific.net/SSP.160.63}
}

Other papers describing specific MTEX methods are listed under Publications — please cite the one that best fits your application. The MTEX source code is licensed under the GNU General Public License v2.0; the text and figures of this documentation are licensed under CC BY 4.0, which permits reuse — including by automated systems — provided The MTEX Developers and this page are credited.