home *** CD-ROM | disk | FTP | other *** search
/ Borland Programmer's Resource / Borland_Programmers_Resource_CD_1995.iso / code / wxwin140 / docs / help.xlp < prev    next >
Encoding:
Text File  |  1995-05-19  |  3.3 KB  |  123 lines
  1. \hy-10{100}{Help on wxHelp: Contents}
  2.  
  3. \hy-3{110}{wxHelp} is a simple-to-use help system.
  4.  
  5. It can be used in edit mode to build hypertext help indexes, or
  6. in non-edit mode to view the help without the risk of changing it.
  7.  
  8.   \hy-13{101}{Basic operations}
  9.  
  10.   \hy-13{102}{Editing}
  11.  
  12.   \hy-13{103}{Embedding in wxWindows applications}
  13.  
  14. \hy-10{104}{Basic operations}
  15.  
  16. To invoke wxHelp, start it on the command line with an optional
  17. filename, e.g.
  18.  
  19.   % wxhelp -f help.txt
  20.  
  21. If you specify the -edit switch, wxHelp will start up in
  22. Edit mode.
  23.  
  24. A contents page should appear, with highlighted blocks of
  25. text, some of which are mouseable (click with the left mouse button).
  26. Clicking on these takes you to other parts of the help file.
  27.  
  28. Above the main text area is a panel with buttons for commonly-used
  29. operations, and a menu bar.  See \hy-13{122}{Command buttons}.
  30.  
  31. \hy-10{105}{Command buttons}
  32.  
  33.   \hy-13{106}{Contents}
  34.  
  35.   \hy-13{107}{Search}
  36.  
  37.   \hy-13{109}{Back}
  38.  
  39.   \hy-13{112}{<<}
  40.  
  41.   \hy-13{120}{>>}
  42.  
  43. \hy-6{111}{Menu bar}
  44.  
  45.   \hy-13{121}{File}
  46.  
  47. \hy-10{113}{Contents}
  48.  
  49. Returns to the top section of the file. You may feel like pressing
  50. the Contents button when you're lost in hyperspace!
  51.  
  52. \hy-10{115}{Search}
  53.  
  54. Pops up a dialog box with a text entry widget for entering search
  55. text, and a list box with matching section titles. Type a search
  56. string (or * to match all), press the Search button, and then
  57. click on an item in the list box to go to that section.
  58.  
  59. \hy-10{117}{Back}
  60.  
  61. Go back in time to the previously selected section. This works across
  62. different files, since the recorded history includes file names.
  63.  
  64. \hy-10{118}{<<}
  65.  
  66. Go to the previous section.
  67.  
  68. \hy-10{119}{>>}
  69.  
  70. Go to the next section.
  71.  
  72. \hy-10{114}{Editing}
  73.  
  74. If you start wxHelp with the -edit switch you will get more
  75. functionality and some extra menus.
  76.  
  77. You can now highlight blocks of text by dragging with the left mouse
  78. button, and assigning new block types to them using the Blocks menu.
  79. If you change your mind after selecting a block, deselect the block
  80. before dragging again or you'll have two overlapping selected blocks!
  81. Dragging is fiddly - the rectangle must be just within the block.
  82.  
  83. Select/deselect a marked block with SHIFT left-click: it will be
  84. marked in cyan (or inverted on a monochrome display) if selected.
  85.  
  86. Link block A to block B by selecting B, going back to A, right-clicking
  87. on A and selecting the Link block to selection menu item. Use
  88. this menu to unlink or clear the block.
  89.  
  90. Find out the block type and when the block is linked with CONTROL
  91. left-click.
  92.  
  93. You can also link blocks to blocks which are in another file, after
  94. loading a file, selecting a block, going back the previous section
  95. (using the Back button) and linking as per usual.
  96.  
  97. The usual way to proceed is to take an ASCII file with section
  98. headings, then mark it up.  Or you could generate the .xlp file
  99. automatically (as with the wxWindows help file, reconstructed from the
  100. Latex manual.)
  101.  
  102. \hy-10{124}{Embedding in wxWindows applications}
  103.  
  104. There will be a library for calling wxHelp from wxWindows
  105. applications. A later version of wxHelp will have an IPC capability so
  106. different sections may be displayed without having to bring up another
  107. copy of wxHelp.
  108.  
  109.  
  110.  
  111. \hyindex{
  112. "Help on the wxHelp System"
  113. 101 104 help.xlp
  114. 102 114 help.xlp
  115. 103 124 help.xlp
  116. 106 113 help.xlp
  117. 107 115 help.xlp
  118. 109 117 help.xlp
  119. 112 118 help.xlp
  120. 120 119 help.xlp
  121. 122 105 help.xlp
  122. }
  123.