^me.hlp: Creating a your personalize help me file^ - updated 2008-11-18
.-

This is a more advanced topic that assumes you have read Chapters 3 and
4 of The Workflow of Data Analysis Using Stata.

^To personalized your help me file^
---------------------------------

When you install the workflow package, the file name ^me.hlp^ is copied
to your PLUS directory in the subdirectory \m. Notice that the suffix is
^hlp^ and not ^sthlp^. Other help files end with ^sthlp^. The master
workflow help file, ^wf.sthlp^, is copied to the \w subdirectory in PLUS
along with other workflow help files. After initially installing the 
workflow package, entering the command ^help me^ will display the file
^me.hlp^. (This is what you are now viewing.).

^To create a customized help file^
--------------------------------

1. In your PLUS directory, Copy ^me.hlp^ to ^me.sthlp^. That is, make a
copy of the ^me^ file but with the suffix ^sthlp^. You will edit the 
new copy ^me.sthlp^ with the information you want to view when you enter
the command ^help me^.

    Technical aside: Stata allows two suffixes for help files: ^hlp^ and 
    ^sthlp^. If ^me.hlp^ and ^me.sthlp^ are both found, the ^me.sthlp^ 
    file is shown. If you customize your ^me.sthlp^, you don't want to lose
    it if you reinstall the workflow package. So, the workflow package 
    installs only ^me.hlp^. This way the workflow package will never write
    over you customized ^me.sthlp^ file.

2. Customize the ^me.sthlp^ file in your PLUS directory. When you type,
^help me^, this file should appear in your viewer.

3. If you want ^wf.sthlp^ to link to your customized ^me.sthlp^ file, edit 
the ^wf.sthlp^ by changing ^me.hlp^ to ^me.sthlp^. Then, save the changed 
file.

.-
Author: Scott Long - www.indiana.edu/~jslsoc/workflow.htm