Documentation Plan

[ralfHielscher]

We are very proud of our large and extensive documentation. However, documenting a project like MTEX is a challenging and ongoing task. Therefore we are extremely happy about any help, e.g., spelling fixes, examples, theoretical explanations, special use cases, etc. Contributing to the documentation is extremely simple as all the documentation pages are essentially Matlab scripts that are included within MTEX. They can be accessed by

edit OrientationDefinition.m

where OrientationDefinition is just a placeholder for the specific site you are interested in. In this post I keep a list of topics that require more documentation and a list of recently updated documentation pages. Everybody is invited to shorten this list by adding to the documentation or to extending this list if you think a topic requires more documentation. Please comment below if you think a topic is not yet sufficiently covered in the documentation.

• Grain Tutorial
• plot orientation / rotation colored by property
• Misorientation Theory
• Misorientation Twinning
• Misorientation Distribution Function
• Axis Distribution Function
• Angle Distribution Function
• Orientation Export
• EBSD Export - conventions

[nyyssont]

The documentation on exporting CTF files could be expanded.

https://mtex-toolbox.github.io/EBSDExport.html

I, for one, can't seem to get the orientations sorted out correctly when importing a CTF to MTEX and exporting back to CTF. A simple example would help a lot.

If / when I manage to get the export working the way I want I can try to write something. This might require adding a few images separately to a server just for illustration purposes, is that possible to do?

-Tuomo

[ralfHielscher]

Hi Tuomo,

additional images are no problem. Just put them into the directory of the script file and include them as

% 
% <<image.png>>
% 

Ralf.