\hy-10{100}{Help on wxHelp: Contents}

\hy-3{110}{wxHelp} is a simple-to-use help system.

It can be used in edit mode to build hypertext help indexes, or
in non-edit mode to view the help without the risk of changing it.

  \hy-13{101}{Basic operations}

  \hy-13{102}{Editing}

  \hy-13{103}{Embedding in wxWindows applications}

\hy-10{104}{Basic operations}

To invoke wxHelp, start it on the command line with an optional
filename, e.g.

  % wxhelp -f help.txt

If you specify the -edit switch, wxHelp will start up in
Edit mode.

A contents page should appear, with highlighted blocks of
text, some of which are mouseable (click with the left mouse button).
Clicking on these takes you to other parts of the help file.

Above the main text area is a panel with buttons for commonly-used
operations, and a menu bar.  See \hy-13{122}{Command buttons}.

\hy-10{105}{Command buttons}

  \hy-13{106}{Contents}

  \hy-13{107}{Search}

  \hy-13{109}{Back}

  \hy-13{112}{<<}

  \hy-13{120}{>>}

\hy-6{111}{Menu bar}

  \hy-13{121}{File}

\hy-10{113}{Contents}

Returns to the top section of the file. You may feel like pressing
the Contents button when you're lost in hyperspace!

\hy-10{115}{Search}

Pops up a dialog box with a text entry widget for entering search
text, and a list box with matching section titles. Type a search
string (or * to match all), press the Search button, and then
click on an item in the list box to go to that section.

\hy-10{117}{Back}

Go back in time to the previously selected section. This works across
different files, since the recorded history includes file names.

\hy-10{118}{<<}

Go to the previous section.

\hy-10{119}{>>}

Go to the next section.

\hy-10{114}{Editing}

If you start wxHelp with the -edit switch you will get more
functionality and some extra menus.

You can now highlight blocks of text by dragging with the left mouse
button, and assigning new block types to them using the Blocks menu.
If you change your mind after selecting a block, deselect the block
before dragging again or you'll have two overlapping selected blocks!
Dragging is fiddly - the rectangle must be just within the block.

Select/deselect a marked block with SHIFT left-click: it will be
marked in cyan (or inverted on a monochrome display) if selected.

Link block A to block B by selecting B, going back to A, right-clicking
on A and selecting the Link block to selection menu item. Use
this menu to unlink or clear the block.

Find out the block type and when the block is linked with CONTROL
left-click.

You can also link blocks to blocks which are in another file, after
loading a file, selecting a block, going back the previous section
(using the Back button) and linking as per usual.

The usual way to proceed is to take an ASCII file with section
headings, then mark it up.  Or you could generate the .xlp file
automatically (as with the wxWindows help file, reconstructed from the
Latex manual.)

\hy-10{124}{Embedding in wxWindows applications}

There will be a library for calling wxHelp from wxWindows
applications. A later version of wxHelp will have an IPC capability so
different sections may be displayed without having to bring up another
copy of wxHelp.



\hyindex{
"Help on the wxHelp System"
101 104 help.xlp
102 114 help.xlp
103 124 help.xlp
106 113 help.xlp
107 115 help.xlp
109 117 help.xlp
112 118 help.xlp
120 119 help.xlp
122 105 help.xlp
}
