1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>
<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>
hyperhelp - Create and manipulate a hyperhelp widget
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>hyperhelp</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Toplevel <- shell <- hyperhelp
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<B>activeBackground</B> <B>background</B> <B>borderWidth</B>
<B>closecmd</B> <B>cursor</B> <B>exportSelection</B>
<DL>
<DT><B>foreground</B> <DD> <B>highlightColor</B> <B>highlightThickness</B>
</DD>
</DL>
<DL>
<DT><B>insertBackground</B> <DD> <B>insertBorderWidth</B> <B>insertOffTime</B>
<B>insertOnTime</B> <B>insertWidth</B> <B>padX</B>
</DD>
</DL>
<DL>
<DT><B>padY</B> <DD> <B>relief</B> <B>repeatDelay</B>
</DD>
</DL>
<DL>
<DT><B>repeatInterval</B> <DD> <B>selectBackground</B> <B>selectBorderWidth</B>
</DD>
</DL>
<DL>
<DT><B>selectForeground</B> <DD> <B>setGrid</B>
<P>
</DD>
</DL>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><B>ASSOCIATED</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>hscrollmode</B> <DD> <B>vscrollmode</B> <B>textbackground</B> <B>fontname</B>
<B>fontsize</B> <B>fixedfont</B> <B>link</B> <B>linkhighlight</B>
<B>width</B> <B>height</B> <B>state</B> <B>wrap</B>
<B>unknownimage</B>
<P>
</DD>
</DL>
See the "scrolledhtml" widget manual entry for details on
the above associated options.
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>INHERITED</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>modality</B> <DD> <B>title</B>
<P>
</DD>
</DL>
See the "shell" manual entry for details on the above inherited
options.
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
Name: <B>topics</B><BR>
Class: <B>Topics</B><BR>
<DL>
<DT>Command-Line Switch: <DD> <B>-topics</B>
<P>
</DD>
</DL>
Specifies a list of help topics in the form {?<I>topic</I>?
... }. <I>Topic</I> may either be a topic name, in which case
the document associated with the topic should be in the
file <B>helpdir</B>/<I>topic</I>.html, or it may be of the form {<I>name</I>
<I>file</I>}. In the latter case, <I>name</I> is displayed in the
topic menu, and selecting the name loads <I>file</I>. If file
has a relative path, it is assumed to be relative to
helpdir.
<P>
Name: <B>helpdir</B><BR>
Class: <B>Directory</B><BR>
<DL>
<DT>Command-Line Switch: <DD> <B>-helpdir</B>
<P>
</DD>
</DL>
Specifies the directory where help files are located.
<P>
Name: <B>closeCmd</B><BR>
Class: <B>CloseCmd</B><BR>
<DL>
<DT>Command-Line Switch: <DD> <B>-closecmd</B>
<P>
</DD>
</DL>
Specifies the tcl command to be executed when the close
option is selected from the topics menu.
<P>
Name: <B>maxHistory</B><BR>
Class: <B>MaxHistory</B><BR>
<DL>
<DT>Command-Line Switch: <DD> <B>-maxhistory</B>
<P>
</DD>
</DL>
Specifies the maximum number of entries stored in the
history list
<P>
Name: <B>beforelink</B><BR>
Class: <B>BeforeLink</B><BR>
<DL>
<DT>Command-Line Switch: <DD> <B>-beforelink</B>
<P>
</DD>
</DL>
Specifies a command to be eval'ed before a new link is
displayed. The path of the link to be displayed is
appended before evaling the command. A suggested use
might be to busy the widget while a new page is being
displayed.
<P>
Name: <B>afterlink</B><BR>
Class: <B>AfterLink</B><BR>
<DL>
<DT>Command-Line Switch: <DD> <B>-afterlink</B>
<P>
</DD>
</DL>
Specifies a command to be eval'ed after a new link is
completely displayed. The path of the link that was
displayed is appended before evaling the command.
<P>
_________________________________________________________________
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>DESCRIPTION</B></A></H2>
The <B>hyperhelp</B> command creates a shell window with a pulldown
menu showing a list of topics. The topics are displayed by
importing a HTML formatted file named <B>helpdir</B>/<I>topic</I>.html.
For a list of supported HTML tags, see <A HREF="http://localhost/cgi-bin/man2html?scrolledhtml?n">scrolledhtml(n)</A>.
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>METHODS</B></A></H2>
The <B>hyperhelp</B> command creates a new Tcl command whose name
is <I>pathName</I>. This command may be used to invoke various
operations on the widget. It has the following general
form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for dialog widgets:
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>INHERITED</B> <B>METHODS</B></A></H2>
<B>activate</B> <B>center</B> <B>childsite</B> <B>deactivate</B>
<P>
See the "shell" manual entry for details on the above inherited
methods.
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>
<I>pathName</I> <B>cget</B> <I>option</I><BR>
Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>hyperhelp</B> command.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (this list will be identical to the corresponding
sublist of the value returned if no <I>option</I> is
specified). If one or more <I>option</I> - <I>value</I> pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>hyperhelp</B> command.
<P>
<I>pathName</I> <B>showtopic</B> <I>topic</I><BR>
Display html file <B>helpdir</B>/<I>topic</I>.html. <I>Topic</I> may optionally
be of the form <I>topicname</I>#<I>anchorname</I>. In this form,
either <I>topicname</I> or <I>anchorname</I> or both may be empty. If
<I>topicname</I> is empty, the current topic is assumed. If
<I>anchorname</I> is empty, the top of the document is assumed
<P>
<I>pathName</I> <B>followlink</B> <I>href</I><BR>
Display html file <I>href</I>. <I>Href</I> may be optionally be of
the form <I>filename</I>#<I>anchorname</I>. In this form, either
<I>filename</I> or <I>anchorname</I> or both may be empty. If
<I>filename</I> is empty, the current document is assumed. If
<I>anchorname</I> is empty, the top of the document is
assumed.
<P>
<I>pathName</I> <B>forward</B>
<P>
Display html file one forward in history list, if
applicable.
<P>
<I>pathName</I> <B>back</B><BR>
Display html file one back in history list, if applicable.
<P>
<H2><A NAME="sect12" HREF="#toc12"><B>EXAMPLE</B></A></H2>
hyperhelp .h -topics { Intro Help } -helpdir ~/help
.h showtopic Intro
<P>
<H2><A NAME="sect13" HREF="#toc13"><B>AUTHOR</B></A></H2>
Kris Raney
<P>
<H2><A NAME="sect14" HREF="#toc14"><B>KEYWORDS</B></A></H2>
hyperhelp, html, help, shell, widget
<P>
<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">ASSOCIATED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">DESCRIPTION</A></LI>
<LI><A NAME="toc9" HREF="#sect9">METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">INHERITED METHODS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc12" HREF="#sect12">EXAMPLE</A></LI>
<LI><A NAME="toc13" HREF="#sect13">AUTHOR</A></LI>
<LI><A NAME="toc14" HREF="#sect14">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|
