File Help
Since version 9.
Contents
Introduction
The FileHelp function gives you access to the headers of all of the functions in the Spacecraft Control Toolbox. You can browse the headers and try out examples associated with each function. You can also edit the examples, create new examples and save them into the help database.
When you type FileHelp the FileHelp GUI appears. There are four main panes in the window. On the left hand side is a display of all files in the toolbox. The top list is hierarchical and the bottom list is alphabetical. The right-hand-side will display the selected file header. Immediately below the header display is the editable example. To its left is a template for the function. You can cut and past it into your script or function.
The List Pane
The hierarchical list contains the names of the SCT directories in your path. A + sign is in front of each name. Click the name with a plus sign to see which toolbox functions are in each directory. To view a file's header, example and template, click on the file name.
This list is of the toolbox as you receive it on CD ROM or as downloaded from the web. It will not show any of your functions.
You can click in either list and the selected header will be displayed.
The Example Pane
This pane gives an example for the function displayed. Not all functions have examples. The edit display has scroll bars. You can edit the example, create new examples and save them using the buttons below the display. To run an example hit the "Run Example" button.
You can have comments in the example by using the % symbol.
Buttons
- Find All: Find All resets the alphabetical list to show all of the functions. This is used after one of the search options has been used. Find All will reenable the hierarchical list.
- Edit: This opens the selected function in the Matlab editor.
- Search File Names: Search file names for a string. This function looks for exact, but not case sensitive, matches. The alphabetical display displays all matches. The hierarchical display will be disabled until you hit 'Find All' to return to the default file display.
- Search Headers: Search headers for a string. This function looks for exact, but not case sensitive, matches. The alphabetical display displays all matches. The hierarchical display will be disabled until you hit 'Find All' to return to the default file display.
- Search String: This is the search string. Spaces will be matched so if you type 'attitude control' (with two spaces) it will not match 'attitude control' (with one space).
- Run Example: Run the example in the display. Some of the examples are just the name of the function. These are functions with built-in demos.
- Save Example: Save the example in the edit window. Hitting this button only saves it in the temporary memory used by the GUI. You can save the example permanently when you Quit.
- Help: Open this help system.
- Quit: Quit the GUI. If you have edited an example, it will ask you whether you want to save the example before you quit.
Back to GUIindex.html