home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / p / python / !ibrowse / files / ibrowse < prev    next >
Text File  |  1995-04-10  |  32KB  |  720 lines
  1. This file documents the ibrowse program.  -*-Text-*-
  2. The H command of ibrowse goes to the node Help in this file.
  3. 
  4. File: ibrowse    Node: Top    Up: (DIR)    Next: Expert
  5.  
  6. Ibrowse is a program for reading documentation, which you are using now.
  7. ** Ibrowse uses the file format of the Emacs Info program, and its
  8. ** commands are similar, but not identical.
  9.  
  10. To learn how to use Ibrowse, type the command "h".  It will bring you
  11. to a programmed instruction sequence.
  12.  
  13. * Menu:
  14.  
  15. * Expert::    Advanced Ibrowse commands: c, k, g, s, 1 - 9, arrows.
  16. * Add::        Describes how to add new nodes to the hierarchy.
  17.         Also tells what nodes look like.
  18. * Menus::    How to add to or create menus in Info nodes.
  19. * Cross-refs::    How to add cross-references to Info nodes.
  20. * Tags::    How to make tag tables for Info files.
  21. * Checking::    How to check the consistency of an Info file.
  22. * Texinfo: (texinfo).
  23.         How to generate an Info file and a printed manual
  24.         from the same source file.
  25. 
  26. File: ibrowse    Node: Summary            Next: Help
  27.  
  28. Ibrowse is a Python program for browsing through the Emacs Info
  29. documentation tree.  Documentation in Info is divided into "nodes",
  30. each of which discusses one topic and contains references to other
  31. nodes which discuss related topics.  Ibrowse has commands to follow the
  32. references and show you other nodes.
  33.  
  34. h    Invoke the Ibrowse tutorial.
  35. ?    Display this Summary node.
  36. q    Quit Ibrowse.
  37. w    Close current window.
  38.  
  39. Selecting other nodes:
  40. n    Move to the "next" node of this node.
  41. p    Move to the "previous" node of this node.
  42. m    Pick menu item specified by name (or abbreviation).
  43. 1-9    Pick first..ninth in node's menu.
  44.     Menu items select nodes that are "subsections" of this node.
  45. u    Move "up" from this node (i.e., from a subsection to a section).
  46. f    Follow a cross reference by name (or abbrev).  Type `l' to get back.
  47. l    Move back to the last node you were in.
  48.  
  49. Moving within a node:
  50. Space    Scroll forward a full screen.     DEL, BS Scroll backward.
  51. b    Go to beginning of node.          
  52.  
  53. Advanced commands:
  54. k    Clone current window (create an independent duplicate).
  55. c    Copy text selection to clipboard (for paste in another application).
  56. g    Move to node specified by name.
  57.     You may include a filename as well, as (FILENAME)NODENAME.
  58. d    Go to the main directory of Info files.
  59. t    Go to Top node of this file.
  60. s    Search through this Info file for node with specified regexp.
  61. 
  62. File: ibrowse    Node: Help-Small-Screen        Next: Help
  63.  
  64. Since your terminal has an unusually small number of lines on its
  65. screen, it is necessary to give you special advice at the beginning.
  66.  
  67. If you see the text "--All----" at near the bottom right corner of
  68. the screen, it means the entire text you are looking at fits on the
  69. screen.  If you see "--Top----" instead, it means that there is more
  70. text below that does not fit.  To move forward through the text and
  71. see another screen full, press the Space bar.  To move back up, press
  72. the key labeled Rubout or Delete or DEL.
  73.  
  74. Here are 40 lines of junk, so you can try Spaces and Rubout and
  75. see what they do.  At the end are instructions of what you should do
  76. next.
  77.  
  78. This is line 17
  79. This is line 18
  80. This is line 19
  81. This is line 20
  82. This is line 21
  83. This is line 22
  84. This is line 23
  85. This is line 24
  86. This is line 25
  87. This is line 26
  88. This is line 27
  89. This is line 28
  90. This is line 29
  91. This is line 30
  92. This is line 31
  93. This is line 32
  94. This is line 33
  95. This is line 34
  96. This is line 35
  97. This is line 36
  98. This is line 37
  99. This is line 38
  100. This is line 39
  101. This is line 40
  102. This is line 41
  103. This is line 42
  104. This is line 43
  105. This is line 44
  106. This is line 45
  107. This is line 46
  108. This is line 47
  109. This is line 48
  110. This is line 49
  111. This is line 50
  112. This is line 51
  113. This is line 52
  114. This is line 53
  115. This is line 54
  116. This is line 55
  117. This is line 56
  118.  
  119. If you have managed to get here, go back to the beginning with
  120. Rubout, and come back here again, then you understand Space and
  121. Rubout.  So now type an "n"--just one character; don't type the
  122. quotes and don't type a Return afterward-- to get to the normal start
  123. of the course.
  124. 
  125. File: ibrowse    Node: Help    Next: Help-P    Previous: Help-Small-Screen
  126.  
  127. You are talking to the program Ibrowse, for reading documentation.
  128.  
  129.   Right now you are looking at one "Node" of Information.
  130. A node contains text describing a specific topic at a specific
  131. level of detail.  This node's topic is "how to use Ibrowse".
  132.  
  133.   The top line of a node is its "header".  This node's header (look at
  134. it now) says that it is the node named "Help" in the file "ibrowse".
  135. It says that the Next node after this one is the node called "Help-P".
  136. An advanced Ibrowse command lets you go to any node whose name you know.
  137.  
  138.   Besides a "Next", a node can have a "Previous" or an "Up".
  139. This node has a "Previous" but no "Up", as you can see.
  140.  
  141.   Now it's time to move on to the Next node, named "Help-P".
  142.  
  143. >> Type "n" to move there.  Type just one character;
  144.    don't type the quotes and don't type a Return afterward.
  145.  
  146. ">>" in the margin means it is really time to try a command.
  147. 
  148. File: ibrowse    Node: Help-P    Next: Help-Page    Previous: Help
  149.  
  150. This node is called "Help-P".  The "Previous" node, as you see, is
  151. "Help", which is the one you just came from using the "N" command.
  152. Another "N" command now would take you to the Next node, "Help-Page".
  153.  
  154. >> But don't do that yet.  First, try the "p" command, which takes
  155. you to the Previous node.  When you get there, you can do an "n"
  156. again to return here.
  157.  
  158.   This all probably seems insultingly simple so far, but DON'T be
  159. led into skimming.  Things will get more complicated soon.  Also,
  160. don't try a new command until you are told it's time to.  Otherwise,
  161. you may make Ibrowse skip past an important warning that was coming up.
  162.  
  163. >> Now do an "n" to get to the node "Help-Page" and learn more.
  164. 
  165. File: ibrowse    Node: Help-Page    Next: Help-M    Previous: Help-P
  166.  
  167. Space, Backspace, and B commands.
  168.  
  169.   This node's header tells you that you are now at node "Help-Page", and
  170. that "P" would get you back to "Help-P".  The line starting "Space,"
  171. is a "Title", saying what the node is about (most nodes have titles).
  172.  
  173.   This is a big node and it doesn't all fit on your display screen.
  174. You can tell that there is more that isn't visible because you
  175. the scroll bar on the side of the window has become active (gray).
  176.  
  177.   The Space, Backspace and B commands exist to allow you to "move
  178. around" in a node that doesn't all fit on the screen at once.
  179. Space moves forward, to show what was below the bottom of the screen.
  180. Backspace moves backward, to show what was above the top of the screen
  181. (there isn't anything above the top until you have typed some spaces).
  182.  
  183. >> Now try typing a Space (afterward, type a Backspace to return here).
  184.  
  185.   When you type the space, the two lines that were at the bottom of the 
  186. screen appear at the top, followed by more lines.  Backspace takes the
  187. two lines from the top and moves them to the bottom, USUALLY, but if
  188. there are not a full screen's worth of lines above them they may not
  189. make it all the way to the bottom.
  190.  
  191.   If you type a Space when there is no more to see, it will ring the
  192. bell and otherwise do nothing.  The same goes for a Backspace when
  193. the header of the node is visible.
  194.  
  195.   Of course you can use the mouse and directly move the scroll bar
  196. as well, but Ibrowse has keyboard commands for almost everything,
  197. including scrolling.  These keyboard commands are called "shortcuts",
  198. because it generally takes less effort to press a key on the
  199. keyboard than to move the mouse.  On the other hand, if you are
  200. an infrequent user of Ibrowse, you can do everything with the
  201. mouse that you can do with the keyboard.  Just look in the menus
  202. (I'm sure you must know how to use the menus on this system, or
  203. else you couldn't have gotten this far...).  In fact you'll see that
  204. the commands and shortcuts listed in the menus are the same as those
  205. described in this course.  You can use the shortcuts either with or
  206. without the "Command" or "Meta" key.
  207.  
  208.   Two menus are always available: the "Ibrowse" menu contains commands
  209. pertaining to the Ibrowse program at large, while the "Navigation" menu
  210. contains commands that move around between nodes.  There may be other
  211. menus; these will be explained later.
  212.  
  213.   To move back to the beginning of the node you are on, you ca