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