Once you have registered and tested your new custom study formula there is one (optional) step left and that is to add some parameter and usage help information into the studyInfoUser.txt configuration file. This help information is used in the Wizard Study Selection box as well as in the Parameter dialog to display usage information to the user.
When you open the studyInfoUser.txt file for the first time, it will most likely be empty. You can refer to the built-in study version of this file (called studyInfoSystem.txt) for an example of how to format the help information. Both of these files are located in the Studies folder of the ScanExpert data directory, under My Documents.
As you can see from the example above, the formatting of this help information is fairly straightforward.
| • | The first line of a help text block begins with the string "Function:" followed by the name of your custom study formula. The name you type in here must exactly match the function name used to declare the study formula in the functionsUser.pas file. |
| • | The next line is the string "[start]". Note the use of the square brackets, which are required. |
| • | You can use as many lines as you need to describe all of the input parameters and streams. After all of the study inputs have been described, enter a blank line and then type in a brief description of the study formula. Do not use any carriage returns when you type in this description, however you can turn on the Word Wrap feature in the Editor if needed. |
| • | The last line of a help text block contains the string "[end]". Again, note the use of the square brackets. |
| • | When you are done, save your work and launch the ScanExpert Wizard. Find your custom study formula in the Study Selection box and right-click your mouse. This will call up the dialog that will display the help text. |
You should enter a help text block in the studyInfoUser.txt file for each custom study formula that you define.