iwidgets::hyperhelp(1)

📦 version 4.1.1, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ iwidgets::hyperhelp — the manual page, but make it cute ✨

okay bestie, you're reading the iwidgets::hyperhelp(1) page from the [incr Widgets] set, and I'm gonna walk you through it like we're texting at 2am 💖 every single flag stays, I promise.

🌸 NAME 🌸

iwidgets::hyperhelp — Create and manipulate a hyperhelp widget. that's it, that's the whole vibe. a widget that does help. iconic.

🦋 SYNOPSIS 🦋

iwidgets::hyperhelp pathName ?options?

👑 INHERITANCE 👑

like, the family tree fr fr:

itk::Toplevel <- iwidgets::Shell <- iwidgets::Hyperhelp

✨ STANDARD OPTIONS ✨

these are the standard ones, the classics, no cap:

  • activeBackground
  • background
  • borderWidth
  • closecmd
  • cursor
  • exportSelection
  • foreground
  • highlightColor
  • highlightThickness
  • insertBackground
  • insertBorderWidth
  • insertOffTime
  • insertOnTime
  • insertWidth
  • padX
  • padY
  • relief
  • repeatDelay
  • repeatInterval
  • selectBackground
  • selectBorderWidth
  • selectForeground
  • setGrid
go read the options manual entry if you want the details on any of these, she's the source of truth 💅

🎀 ASSOCIATED OPTIONS 🎀

these ones live next door, they're associated:

  • hscrollmode
  • vscrollmode
  • textbackground
  • fontname
  • fontsize
  • fixedfont
  • link
  • linkhighlight
  • width
  • height
  • state
  • wrap
  • unknownimage
the scrolledhtml widget manual entry has the tea on all of the above ☕

💜 INHERITED OPTIONS 💜

borrowed from the ancestors, as one does:

  • modality
  • title
check the shell manual entry for the deets on these 🫶

🌈 WIDGET-SPECIFIC OPTIONS 🌈

these are hers, main character energy only:

🍓 the topics option

  • Name: topics
  • Class: Topics
  • Command-Line Switch: -topics

Specifies a list of help topics in the form {?topic? ... }. A topic can be either just a topic name — and in that case the document for it should live at helpdir/topic.html — or it can be shaped like {name file}. In that second form, name is what shows up in the topic menu, and picking that name loads file. And if file has a relative path? it's assumed to be relative to helpdir. periodt.

🍓 the helpdir option

  • Name: helpdir
  • Class: Directory
  • Command-Line Switch: -helpdir

Specifies the directory where the help files are located. literally where the help lives.

🍓 the closeCmd option

  • Name: closeCmd
  • Class: CloseCmd
  • Command-Line Switch: -closecmd

Specifies the tcl command to be executed when the close option is selected from the topics menu. bye bye command 💅

🍓 the maxHistory option

  • Name: maxHistory
  • Class: MaxHistory
  • Command-Line Switch: -maxhistory

Specifies the maximum number of entries stored in the history list.

  • Name: beforelink
  • Class: BeforeLink
  • Command-Line Switch: -beforelink

Specifies a command to be eval'ed before a new link is displayed. The path of the link to be displayed gets appended before evaling the command. A suggested use? busy the widget while a new page is being displayed. multitasking queen ✨

  • Name: afterlink
  • Class: AfterLink
  • Command-Line Switch: -afterlink

Specifies a command to be eval'ed after a new link is completely displayed. The path of the link that was displayed gets appended before evaling the command.

💖 DESCRIPTION 💖

The iwidgets::hyperhelp 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 helpdir/topic.html. And if you wanna know which HTML tags are supported, go see scrolledhtml(n). iykyk 📚

🌟 METHODS 🌟

The iwidgets::hyperhelp command creates a new Tcl command whose name is pathName. This command may be used to invoke various operations on the widget. It has the following general form:

pathName option ?arg arg ...?

Option and the args determine the exact behavior of the command. The following commands are possible for dialog widgets:

🧚 INHERITED METHODS 🧚

handed down, still slaying:

  • activate
  • center
  • childsite
  • deactivate
the shell manual entry has the details on the above inherited methods 🌸

⭐ WIDGET-SPECIFIC METHODS ⭐

pathName cget option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the iwidgets::hyperhelp command.

pathName configure ?option? ?value option value ...?

Query or modify the configuration options of the widget. If no option is specified, returns a list describing all of the available options for pathName (see Tk_ConfigureInfo for information on the format of this list). If option is specified with no value, 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 option is specified). If one or more option-value 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. Option may have any of the values accepted by the iwidgets::hyperhelp command.

pathName showtopic topic

Display html file helpdir/topic.html. Topic may optionally be of the form topicname#anchorname. In this form, either topicname or anchorname or both may be empty. If topicname is empty, the current topic is assumed. If anchorname is empty, the top of the document is assumed.

Display html file href. Href may optionally be of the form filename#anchorname. In this form, either filename or anchorname or both may be empty. If filename is empty, the current document is assumed. If anchorname is empty, the top of the document is assumed.

pathName forward

Display html file one forward in history list, if applicable.

pathName back

Display html file one back in history list, if applicable.

🎀 EXAMPLE 🎀

steal this, it works:

package require Iwidgets 4.0
iwidgets::hyperhelp .h -topics { Intro Help } -helpdir ~/help
.h showtopic Intro

🫶 AUTHOR 🫶

Kris Raney — shoutout, legend behavior 👑

🔥 KEYWORDS 🔥

hyperhelp, html, help, shell, widget

and that's the whole page bestie 💖 it comes from the Tk crew, hanging out in section 1 of the manual, right next to iwidgets::hyperhelp(1). go forth and hyperhelp, you got this 🌈✨

📦 where this page comes from