| 1 |
578 |
markom |
'\"
|
| 2 |
|
|
'\" Copyright (c) 1996 DSC Technologies Corporation
|
| 3 |
|
|
'\"
|
| 4 |
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
| 5 |
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
| 6 |
|
|
'\"
|
| 7 |
|
|
'\" @(#) Hyperhelp.n
|
| 8 |
|
|
'/"
|
| 9 |
|
|
.so man.macros
|
| 10 |
|
|
.HS hyperhelp iwid
|
| 11 |
|
|
.BS
|
| 12 |
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
| 13 |
|
|
.SH NAME
|
| 14 |
|
|
hyperhelp \- Create and manipulate a hyperhelp widget
|
| 15 |
|
|
.SH SYNOPSIS
|
| 16 |
|
|
\fBhyperhelp\fI \fIpathName \fR?\fIoptions\fR?
|
| 17 |
|
|
.SH "INHERITANCE"
|
| 18 |
|
|
itk::Toplevel <- shell <- hyperhelp
|
| 19 |
|
|
.SH "STANDARD OPTIONS"
|
| 20 |
|
|
.LP
|
| 21 |
|
|
.nf
|
| 22 |
|
|
.ta 5c 10c
|
| 23 |
|
|
\fBactiveBackground\fR \fBbackground\fR \fBborderWidth\fR
|
| 24 |
|
|
\fBclosecmd\fR \fBcursor\fR \fBexportSelection\fR
|
| 25 |
|
|
\fBforeground\fR \fBhighlightColor\fR \fBhighlightThickness\fR
|
| 26 |
|
|
\fBinsertBackground\fR \fBinsertBorderWidth \fBinsertOffTime\fR
|
| 27 |
|
|
\fBinsertOnTime\fR \fBinsertWidth\fR \fBpadX\fR
|
| 28 |
|
|
\fBpadY\fR \fBrelief\fR \fBrepeatDelay\fR
|
| 29 |
|
|
\fBrepeatInterval\fR \fBselectBackground\fR \fBselectBorderWidth\fR
|
| 30 |
|
|
\fBselectForeground\fR \fBsetGrid\fR
|
| 31 |
|
|
.fi
|
| 32 |
|
|
.LP
|
| 33 |
|
|
See the "options" manual entry for details on the standard options.
|
| 34 |
|
|
.SH "ASSOCIATED OPTIONS"
|
| 35 |
|
|
.LP
|
| 36 |
|
|
.nf
|
| 37 |
|
|
.ta 4c 8c 12c
|
| 38 |
|
|
\fBhscrollmode\fR \fBvscrollmode\fR \fBtextbackground\fR \fBfontname\fR
|
| 39 |
|
|
\fBfontsize\fR \fBfixedfont\fR \fBlink\fR \fBlinkhighlight\fR
|
| 40 |
|
|
\fBwidth\fR \fBheight\fR \fBstate\fR \fBwrap\fR
|
| 41 |
|
|
\fBunknownimage\fR
|
| 42 |
|
|
.fi
|
| 43 |
|
|
.LP
|
| 44 |
|
|
See the "scrolledhtml" widget manual entry for details on the above
|
| 45 |
|
|
associated options.
|
| 46 |
|
|
.SH "INHERITED OPTIONS"
|
| 47 |
|
|
.LP
|
| 48 |
|
|
.nf
|
| 49 |
|
|
.ta 4c 8c 12c
|
| 50 |
|
|
\fBmodality\fR \fBtitle\fR
|
| 51 |
|
|
.fi
|
| 52 |
|
|
.LP
|
| 53 |
|
|
See the "shell" manual entry for details on the above inherited options.
|
| 54 |
|
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
| 55 |
|
|
.LP
|
| 56 |
|
|
.nf
|
| 57 |
|
|
Name: \fBtopics\fR
|
| 58 |
|
|
Class: \fBTopics\fR
|
| 59 |
|
|
Command-Line Switch: \fB-topics\fR
|
| 60 |
|
|
.fi
|
| 61 |
|
|
.IP
|
| 62 |
|
|
Specifies a list of help topics in the form {?\fItopic\fR? ... }. \fITopic\fR
|
| 63 |
|
|
may either be a topic name, in which case the
|
| 64 |
|
|
document associated with the topic should be in the file
|
| 65 |
|
|
\fBhelpdir\fR/\fItopic\fR.html, or it may be of the form
|
| 66 |
|
|
{\fIname\fR \fIfile\fR}. In the latter case, \fIname\fR is displayed in the
|
| 67 |
|
|
topic menu, and selecting the name loads \fIfile\fR. If file has a relative
|
| 68 |
|
|
path, it is assumed to be relative to helpdir.
|
| 69 |
|
|
.LP
|
| 70 |
|
|
.nf
|
| 71 |
|
|
Name: \fBhelpdir\fR
|
| 72 |
|
|
Class: \fBDirectory\fR
|
| 73 |
|
|
Command-Line Switch: \fB-helpdir\fR
|
| 74 |
|
|
.fi
|
| 75 |
|
|
.IP
|
| 76 |
|
|
Specifies the directory where help files are located.
|
| 77 |
|
|
.LP
|
| 78 |
|
|
.nf
|
| 79 |
|
|
Name: \fBcloseCmd\fR
|
| 80 |
|
|
Class: \fBCloseCmd\fR
|
| 81 |
|
|
Command-Line Switch: \fB-closecmd\fR
|
| 82 |
|
|
.fi
|
| 83 |
|
|
.IP
|
| 84 |
|
|
Specifies the tcl command to be executed when the close option is selected
|
| 85 |
|
|
from the topics menu.
|
| 86 |
|
|
.LP
|
| 87 |
|
|
.nf
|
| 88 |
|
|
Name: \fBmaxHistory\fR
|
| 89 |
|
|
Class: \fBMaxHistory\fR
|
| 90 |
|
|
Command-Line Switch: \fB-maxhistory\fR
|
| 91 |
|
|
.fi
|
| 92 |
|
|
.IP
|
| 93 |
|
|
Specifies the maximum number of entries stored in the history list
|
| 94 |
|
|
.LP
|
| 95 |
|
|
.nf
|
| 96 |
|
|
Name: \fBbeforelink\fR
|
| 97 |
|
|
Class: \fBBeforeLink\fR
|
| 98 |
|
|
Command-Line Switch: \fB-beforelink\fR
|
| 99 |
|
|
.fi
|
| 100 |
|
|
.IP
|
| 101 |
|
|
Specifies a command to be eval'ed before a new link is displayed. The path
|
| 102 |
|
|
of the link to be displayed is appended before evaling the command. A suggested
|
| 103 |
|
|
use might be to busy the widget while a new page is being displayed.
|
| 104 |
|
|
.LP
|
| 105 |
|
|
.nf
|
| 106 |
|
|
Name: \fBafterlink\fR
|
| 107 |
|
|
Class: \fBAfterLink\fR
|
| 108 |
|
|
Command-Line Switch: \fB-afterlink\fR
|
| 109 |
|
|
.fi
|
| 110 |
|
|
.IP
|
| 111 |
|
|
Specifies a command to be eval'ed after a new link is completely displayed.
|
| 112 |
|
|
The path of the link that was displayed is appended before evaling the command.
|
| 113 |
|
|
.LP
|
| 114 |
|
|
.BE
|
| 115 |
|
|
|
| 116 |
|
|
.SH DESCRIPTION
|
| 117 |
|
|
.PP
|
| 118 |
|
|
The \fBhyperhelp\fR command creates a shell window with a pulldown menu
|
| 119 |
|
|
showing a list of topics. The topics are displayed by importing a HTML
|
| 120 |
|
|
formatted file named \fBhelpdir\fR/\fItopic\fR.html. For a list of
|
| 121 |
|
|
supported HTML tags, see \fBscrolledhtml(n)\fR.
|
| 122 |
|
|
|
| 123 |
|
|
.SH "METHODS"
|
| 124 |
|
|
.PP
|
| 125 |
|
|
The \fBhyperhelp\fR command creates a new Tcl command whose
|
| 126 |
|
|
name is \fIpathName\fR. This
|
| 127 |
|
|
command may be used to invoke various
|
| 128 |
|
|
operations on the widget. It has the following general form:
|
| 129 |
|
|
.DS C
|
| 130 |
|
|
\fIpathName option \fR?\fIarg arg ...\fR?
|
| 131 |
|
|
.DE
|
| 132 |
|
|
\fIOption\fR and the \fIarg\fRs
|
| 133 |
|
|
determine the exact behavior of the command. The following
|
| 134 |
|
|
commands are possible for dialog widgets:
|
| 135 |
|
|
.SH "INHERITED METHODS"
|
| 136 |
|
|
.LP
|
| 137 |
|
|
.nf
|
| 138 |
|
|
.ta 4c 8c 12c
|
| 139 |
|
|
\fBactivate\fR \fBcenter\fR \fBchildsite\fR \fBdeactivate\fR
|
| 140 |
|
|
.fi
|
| 141 |
|
|
.LP
|
| 142 |
|
|
See the "shell" manual entry for details on the above inherited methods.
|
| 143 |
|
|
|
| 144 |
|
|
.SH "WIDGET-SPECIFIC METHODS"
|
| 145 |
|
|
.TP
|
| 146 |
|
|
\fIpathName \fBcget\fR \fIoption\fR
|
| 147 |
|
|
Returns the current value of the configuration option given
|
| 148 |
|
|
by \fIoption\fR.
|
| 149 |
|
|
\fIOption\fR may have any of the values accepted by the \fBhyperhelp\fR
|
| 150 |
|
|
command.
|
| 151 |
|
|
.TP
|
| 152 |
|
|
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
| 153 |
|
|
Query or modify the configuration options of the widget.
|
| 154 |
|
|
If no \fIoption\fR is specified, returns a list describing all of
|
| 155 |
|
|
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
| 156 |
|
|
information on the format of this list). If \fIoption\fR is specified
|
| 157 |
|
|
with no \fIvalue\fR, then the command returns a list describing the
|
| 158 |
|
|
one named option (this list will be identical to the corresponding
|
| 159 |
|
|
sublist of the value returned if no \fIoption\fR is specified). If
|
| 160 |
|
|
one or more \fIoption\-value\fR pairs are specified, then the command
|
| 161 |
|
|
modifies the given widget option(s) to have the given value(s); in
|
| 162 |
|
|
this case the command returns an empty string.
|
| 163 |
|
|
\fIOption\fR may have any of the values accepted by the \fBhyperhelp\fR
|
| 164 |
|
|
command.
|
| 165 |
|
|
.TP
|
| 166 |
|
|
\fIpathName\fR \fBshowtopic\fR \fItopic\fR
|
| 167 |
|
|
Display html file \fBhelpdir\fR/\fItopic\fR.html. \fITopic\fR may
|
| 168 |
|
|
optionally be of the form \fItopicname\fR#\fIanchorname\fR. In
|
| 169 |
|
|
this form, either \fItopicname\fR or \fIanchorname\fR or both may be empty. If
|
| 170 |
|
|
\fItopicname\fR is empty, the current topic is assumed. If \fIanchorname\fR
|
| 171 |
|
|
is empty, the top of the document is assumed
|
| 172 |
|
|
.TP
|
| 173 |
|
|
\fIpathName\fR \fBfollowlink\fR \fIhref\fR
|
| 174 |
|
|
Display html file \fIhref\fR. \fIHref\fR may
|
| 175 |
|
|
be optionally be of the form \fIfilename\fR#\fIanchorname\fR. In
|
| 176 |
|
|
this form, either \fIfilename\fR or \fIanchorname\fR or both may be empty. If
|
| 177 |
|
|
\fIfilename\fR is empty, the current document is assumed. If \fIanchorname\fR
|
| 178 |
|
|
is empty, the top of the document is assumed.
|
| 179 |
|
|
.TP
|
| 180 |
|
|
\fIpathName\fR \fBforward\fR
|
| 181 |
|
|
Display html file one forward in history list, if applicable.
|
| 182 |
|
|
.TP
|
| 183 |
|
|
\fIpathName\fR \fBback\fR
|
| 184 |
|
|
Display html file one back in history list, if applicable.
|
| 185 |
|
|
|
| 186 |
|
|
.SH EXAMPLE
|
| 187 |
|
|
.DS
|
| 188 |
|
|
hyperhelp .h -topics { Intro Help } -helpdir ~/help
|
| 189 |
|
|
.h showtopic Intro
|
| 190 |
|
|
|
| 191 |
|
|
.DE
|
| 192 |
|
|
.SH AUTHOR
|
| 193 |
|
|
Kris Raney
|
| 194 |
|
|
.SH KEYWORDS
|
| 195 |
|
|
hyperhelp, html, help, shell, widget
|
