diff options
Diffstat (limited to 'iwidgets/doc/hyperhelp.n')
| -rw-r--r-- | iwidgets/doc/hyperhelp.n | 196 |
1 files changed, 196 insertions, 0 deletions
diff --git a/iwidgets/doc/hyperhelp.n b/iwidgets/doc/hyperhelp.n new file mode 100644 index 00000000000..1f668a2b3c4 --- /dev/null +++ b/iwidgets/doc/hyperhelp.n @@ -0,0 +1,196 @@ +'\" +'\" Copyright (c) 1996 DSC Technologies Corporation +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" @(#) Hyperhelp.n +'\" +.so man.macros +.HS iwidgets::hyperhelp iwid +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +iwidgets::hyperhelp \- Create and manipulate a hyperhelp widget +.SH SYNOPSIS +\fBiwidgets::hyperhelp\fI \fIpathName \fR?\fIoptions\fR? +.SH "INHERITANCE" +itk::Toplevel <- iwidgets::Shell <- iwidgets::Hyperhelp +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5c 10c +\fBactiveBackground\fR \fBbackground\fR \fBborderWidth\fR +\fBclosecmd\fR \fBcursor\fR \fBexportSelection\fR +\fBforeground\fR \fBhighlightColor\fR \fBhighlightThickness\fR +\fBinsertBackground\fR \fBinsertBorderWidth \fBinsertOffTime\fR +\fBinsertOnTime\fR \fBinsertWidth\fR \fBpadX\fR +\fBpadY\fR \fBrelief\fR \fBrepeatDelay\fR +\fBrepeatInterval\fR \fBselectBackground\fR \fBselectBorderWidth\fR +\fBselectForeground\fR \fBsetGrid\fR +.fi +.LP +See the "options" manual entry for details on the standard options. +.SH "ASSOCIATED OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fBhscrollmode\fR \fBvscrollmode\fR \fBtextbackground\fR \fBfontname\fR +\fBfontsize\fR \fBfixedfont\fR \fBlink\fR \fBlinkhighlight\fR +\fBwidth\fR \fBheight\fR \fBstate\fR \fBwrap\fR +\fBunknownimage\fR +.fi +.LP +See the "scrolledhtml" widget manual entry for details on the above +associated options. +.SH "INHERITED OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fBmodality\fR \fBtitle\fR +.fi +.LP +See the "shell" manual entry for details on the above inherited options. +.SH "WIDGET-SPECIFIC OPTIONS" +.LP +.nf +Name: \fBtopics\fR +Class: \fBTopics\fR +Command-Line Switch: \fB-topics\fR +.fi +.IP +Specifies a list of help topics in the form {?\fItopic\fR? ... }. \fITopic\fR +may either be a topic name, in which case the +document associated with the topic should be in the file +\fBhelpdir\fR/\fItopic\fR.html, or it may be of the form +{\fIname\fR \fIfile\fR}. In the latter case, \fIname\fR is displayed in the +topic menu, and selecting the name loads \fIfile\fR. If file has a relative +path, it is assumed to be relative to helpdir. +.LP +.nf +Name: \fBhelpdir\fR +Class: \fBDirectory\fR +Command-Line Switch: \fB-helpdir\fR +.fi +.IP +Specifies the directory where help files are located. +.LP +.nf +Name: \fBcloseCmd\fR +Class: \fBCloseCmd\fR +Command-Line Switch: \fB-closecmd\fR +.fi +.IP +Specifies the tcl command to be executed when the close option is selected +from the topics menu. +.LP +.nf +Name: \fBmaxHistory\fR +Class: \fBMaxHistory\fR +Command-Line Switch: \fB-maxhistory\fR +.fi +.IP +Specifies the maximum number of entries stored in the history list +.LP +.nf +Name: \fBbeforelink\fR +Class: \fBBeforeLink\fR +Command-Line Switch: \fB-beforelink\fR +.fi +.IP +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. +.LP +.nf +Name: \fBafterlink\fR +Class: \fBAfterLink\fR +Command-Line Switch: \fB-afterlink\fR +.fi +.IP +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. +.LP +.BE + +.SH DESCRIPTION +.PP +The \fBiwidgets::hyperhelp\fR 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 \fBhelpdir\fR/\fItopic\fR.html. For a list of +supported HTML tags, see \fBscrolledhtml(n)\fR. + +.SH "METHODS" +.PP +The \fBiwidgets::hyperhelp\fR command creates a new Tcl command whose +name is \fIpathName\fR. This +command may be used to invoke various +operations on the widget. It has the following general form: +.DS C +\fIpathName option \fR?\fIarg arg ...\fR? +.DE +\fIOption\fR and the \fIarg\fRs +determine the exact behavior of the command. The following +commands are possible for dialog widgets: +.SH "INHERITED METHODS" +.LP +.nf +.ta 4c 8c 12c +\fBactivate\fR \fBcenter\fR \fBchildsite\fR \fBdeactivate\fR +.fi +.LP +See the "shell" manual entry for details on the above inherited methods. + +.SH "WIDGET-SPECIFIC METHODS" +.TP +\fIpathName \fBcget\fR \fIoption\fR +Returns the current value of the configuration option given +by \fIoption\fR. +\fIOption\fR may have any of the values accepted by the \fBiwidgets::hyperhelp\fR +command. +.TP +\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? +Query or modify the configuration options of the widget. +If no \fIoption\fR is specified, returns a list describing all of +the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for +information on the format of this list). If \fIoption\fR is specified +with no \fIvalue\fR, 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 \fIoption\fR is specified). If +one or more \fIoption\-value\fR 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. +\fIOption\fR may have any of the values accepted by the \fBiwidgets::hyperhelp\fR +command. +.TP +\fIpathName\fR \fBshowtopic\fR \fItopic\fR +Display html file \fBhelpdir\fR/\fItopic\fR.html. \fITopic\fR may +optionally be of the form \fItopicname\fR#\fIanchorname\fR. In +this form, either \fItopicname\fR or \fIanchorname\fR or both may be empty. If +\fItopicname\fR is empty, the current topic is assumed. If \fIanchorname\fR +is empty, the top of the document is assumed +.TP +\fIpathName\fR \fBfollowlink\fR \fIhref\fR +Display html file \fIhref\fR. \fIHref\fR may +be optionally be of the form \fIfilename\fR#\fIanchorname\fR. In +this form, either \fIfilename\fR or \fIanchorname\fR or both may be empty. If +\fIfilename\fR is empty, the current document is assumed. If \fIanchorname\fR +is empty, the top of the document is assumed. +.TP +\fIpathName\fR \fBforward\fR +Display html file one forward in history list, if applicable. +.TP +\fIpathName\fR \fBback\fR +Display html file one back in history list, if applicable. + +.SH EXAMPLE +.DS + package require Iwidgets 4.0 + iwidgets::hyperhelp .h -topics { Intro Help } -helpdir ~/help + .h showtopic Intro + +.DE +.SH AUTHOR +Kris Raney +.SH KEYWORDS +hyperhelp, html, help, shell, widget |