WaveHelp (issie)

WaveHelp Module

Namespace: global
Assembly: Renderer.dll
Parent Module: AppMessages

The waveform simulator's help panels. Three of these names come from the "WaveSimHelp" right-click menu in ContextMenus.fs and must stay spelled the same as the items there; the other two come from the viewer's own Info button. The names are matched in UIPopups.viewWaveInfoPopup, which is where that correspondence is enforced.

Functions and values

Function or value	Description
`gettingStarted` Full Usage: `gettingStarted` Returns: `string`	"Getting Started" - the viewer's Info button opens on this. Returns: `string`
`instructions` Full Usage: `instructions` Returns: `string`	"Instructions" - the long one, from the viewer's own Info button. The scroll bullet used to draw the zoom-out and zoom-in icons inline, from DiagramStyle. Markdown holds text, so it names the controls instead - which also survives the icons being redrawn. Returns: `string`
`miscellaneous` Full Usage: `miscellaneous` Returns: `string`	"Miscellaneous" - from the viewer's right-click help menu. Returns: `string`
`noHelpFor feature` Full Usage: `noHelpFor feature` Parameters: feature : `string` Returns: `string`	Shown when a help panel is asked for by a name nothing here answers to - which can only happen if the menu in ContextMenus.fs and the names matched in UIPopups have drifted apart. Says what to do next rather than leaving the user in the help system with nothing. feature : `string` Returns: `string`
`selection` Full Usage: `selection` Returns: `string`	"Waveform and RAM selection" - from the viewer's right-click help menu. Returns: `string`
`viewingWaveforms` Full Usage: `viewingWaveforms` Returns: `string`	"Viewing Waveforms" - from the viewer's right-click help menu. Returns: `string`