1iwidgets::hyperhelp − Create and manipulate a hyperhelp widget
3gets::Shell <‐ iwidgets::Hyperhelp
12See the "options" manual entry for details on the standard op‐
13tions.
18See the "scrolledhtml" widget manual entry for details on the
19above associated options.
21See the "shell" manual entry for details on the above inherited
22options.
23Name: topics
24Class: Topics
25Command‐Line Switch: ‐topics
26Specifies a list of help topics in the form {?topic? ... }. Topic
27may either be a topic name, in which case the document associated
28with the topic should be in the file helpdir/topic.html, or it
29may be of the form {name file}. In the latter case, name is dis‐
30played in the topic menu, and selecting the name loads file. If
31file has a relative path, it is assumed to be relative to
32helpdir.
33Name: helpdir
34Class: Directory
35Command‐Line Switch: ‐helpdir
36Specifies the directory where help files are located.
37Name: closeCmd
38Class: CloseCmd
39Command‐Line Switch: ‐closecmd
40Specifies the tcl command to be executed when the close option is
41selected from the topics menu.
42Name: maxHistory
43Class: MaxHistory
44Command‐Line Switch: ‐maxhistory
45Specifies the maximum number of entries stored in the history
46list
47Name: beforelink
48Class: BeforeLink
49Command‐Line Switch: ‐beforelink
50Specifies a command to be eval’ed before a new link is displayed.
51The path of the link to be displayed is appended before evaling
52the command. A suggested use might be to busy the widget while a
53new page is being displayed.
54Name: afterlink
55Class: AfterLink
56Command‐Line Switch: ‐afterlink
57Specifies a command to be eval’ed after a new link is completely
58displayed. The path of the link that was displayed is appended
59before evaling the command.
60The iwidgets::hyperhelp command creates a shell window with a
62pulldown menu showing a list of topics. The topics are displayed
63by importing a HTML formatted file named helpdir/topic.html. For
64a list of supported HTML tags, see scrolledhtml(n).
65The iwidgets::hyperhelp command creates a new Tcl command whose
67name is pathName. This command may be used to invoke various op‐
68erations on the widget. It has the following general form: path‐
70act behavior of the command. The following commands are possible
71for dialog widgets:
73See the "shell" manual entry for details on the above inherited
74methods.
75
77tion option given by option. Option may have any of the values
78accepted by the iwidgets::hyperhelp command. pathName configure
79?option? ?value option value ...? Query or modify the configura‐
80tion options of the widget. If no option is specified, returns a
81list describing all of the available options for pathName (see
84list describing the one named option (this list will be identical
85to the corresponding sublist of the value returned if no option
86is specified). If one or more option−value pairs are specified,
87then the command modifies the given widget option(s) to have the
88given value(s); in this case the command returns an empty
89string. Option may have any of the values accepted by the iwid‐
91file helpdir/topic.html. Topic may optionally be of the form top‐
93or both may be empty. If topicname is empty, the current topic is
94assumed. If anchorname is empty, the top of the document is as‐
95sumed pathName followlink href Display html file href. Href may
96be optionally be of the form filename#anchorname. In this form,
97either filename or anchorname or both may be empty. If filename
98is empty, the current document is assumed. If anchorname is emp‐
99ty, the top of the document is assumed. pathName forward Display
100html file one forward in history list, if applicable. pathName
102 package require Iwidgets 4.0
104 iwidgets::hyperhelp .h ‐topics { Intro Help } ‐helpdir ~/help
105 .h showtopic Intro
106Kris Raney hyperhelp, html, help, shell, widget
108