GAMMASPHERE information, Tcl/Tk help documentation updates


Each TCL/TK script consists of a .script file and a .hlp file. The .script file contains all the TCL/Tk commands but not the help entries. The .hlp file contains the help entries only. The final script has extension .tcl and is generated by the make_tcl c-program that is invoked via the makefile in the bin directory. This program will also make .html files so that the SAME help text is available both in the Tcl/Tk scrips help and on the WWW server (where it is easy to e.g. print the help text).

The Tcl/Tk help documentation is updated and maintained by editing the scripts .hlp file (e.g, gecal.hlp). Those files reside in the bin directory. The format of these files is very simple:


#help_id_text# text text text text
text text text text
text text text text
text text text text
@

The string 'help_id_text' is the help id that this entry is given in the .script file (e.g. bgocal.script). This is the file that contains all the buttons and other Tcl/Tk procedures; but not the actual help text. For example, the 'introduction' help entry in the gecal.script looks like this:

.h.help.menu add command \
  -label "On Introduction" \
  -command {Help introduction} \
  -underline 3

so the 'help_id_text' in this case is 'introduction'. The text id must be specified between two '#' signs. Then follows the help text and the help entry is terminated with an '@' sign. The relevant part of the gecal.hlp file thus looks like this:

#introduction# This Tcl/Tk script is meant for 
the energy calibration of the GAMMASPHERE germanium array
.
.
.
can be deposited and, finally, the script allows for an 
online gain correction for use during a run (note: the latter 
utility is experimental at this point). @

YOU SHOULD NEVER UPDATE THE .TCL SCRIPTS DIRECTLY SINCE THEN THE HELP AND SCRIPTS GET OUT OF SYNC. The correct procedure for an update is:

    1) edit the .hlp file
    2) edit the .script file
    3) do: make tcl
    4) make install

New .tcl files as well as .html files will be generated. The .html files are rcp'ed to the WWW server at ANL.

The executions should look something like this:

.
.
.
make_tcl ../../src/calib/thr     
<../../src/calib/thr.script> is open for read
<../../src/calib/thr.hlp>    is open for read
<../../src/calib/thr.tcl>    is open for WRITE
<../../src/calib/thr.html>   is open for WRITE

copying ../../src/calib/thr.script to ../../src/calib/thr.tcl  - done!

transferring ../../src/calib/thr.hlp to ../../src/calib/thr.tcl
and generating ../../src/calib/thr.html  - done!
 
rcp ../../src/calib/gecal.html gsp1.phy.anl.gov:/home/WWW/bgo/gs/tclhlp
rcp ../../src/calib/bgocal.html gsp1.phy.anl.gov:/home/WWW/bgo/gs/tclhlp
rcp ../../src/calib/thr.html gsp1.phy.anl.gov:/home/WWW/bgo/gs/tclhlp

web master: webmaster@www.phy.anl.gov