Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Potential applications of editHelps focus on: projects where a number of m-files have been developed that qualify as potential McTools files.

Help on the help editor

...

"editHelps" 

  • Left pane shows existing help, right pane existing and prepared combined
  • You can edit in the right pane
  • Possible to browse for an M-file or scroll in the current directory with the < (previous) and > (next) buttons
  • The editor checks the function name to be the same as the file name of the M-file. (Look for the red warning when there is a difference)
  • Possible to Preview the body of the M-file with the new setting of the help block according to the right pane. "View As is" shows the current body of the M-file
  • The help editor sets help as complete as possible
  • "Scroll, no changes" check box
    • not activated: when the save button is enabled, you are asked for a save before a new M-file can be selected
    • activated      : you can select another file without saving. Be carefull: changes will be lost
  • "Save original help also" check box. When activated the help as is in the file is saved following the new help block
  • Editing the parameter description is done in the box beneath the list box, for the selected parameter. When in the list box, new text is added to the current description text