home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-385-Vol-1of3.iso / f / funnel-x.zip / userman / u_manual.toc < prev   
Text File  |  1992-07-29  |  11KB  |  167 lines
  1. \contentsline {chapter}{Preface}{9}
  2. \contentsline {chapter}{Acknowledgements}{11}
  3. \contentsline {chapter}{Presentation Notes}{13}
  4. \contentsline {chapter}{\numberline {1}A Tutorial Introduction}{15}
  5. \contentsline {section}{\numberline {1.1}What is Literate Programming?}{15}
  6. \contentsline {section}{\numberline {1.2}What is FunnelWeb?}{18}
  7. \contentsline {section}{\numberline {1.3}The Name FunnelWeb}{19}
  8. \contentsline {section}{\numberline {1.4}A FunnelWeb Tutorial}{19}
  9. \contentsline {section}{\numberline {1.5}A Hello World Document}{20}
  10. \contentsline {section}{\numberline {1.6}Macro Facilities}{22}
  11. \contentsline {subsection}{\numberline {1.6.1}Simple Macros}{22}
  12. \contentsline {subsection}{\numberline {1.6.2}Number of Times Called}{23}
  13. \contentsline {subsection}{\numberline {1.6.3}Indentation}{25}
  14. \contentsline {subsection}{\numberline {1.6.4}Additive Macros}{26}
  15. \contentsline {subsection}{\numberline {1.6.5}Parameterized Macros}{28}
  16. \contentsline {subsection}{\numberline {1.6.6}Macro Expansion}{30}
  17. \contentsline {subsection}{\numberline {1.6.7}Include Files}{30}
  18. \contentsline {section}{\numberline {1.7}Typesetting Facilities}{32}
  19. \contentsline {subsection}{\numberline {1.7.1}Overview}{32}
  20. \contentsline {subsection}{\numberline {1.7.2}Typesetter Independence}{34}
  21. \contentsline {subsection}{\numberline {1.7.3}Hierarchical Structure}{34}
  22. \contentsline {subsection}{\numberline {1.7.4}Understanding the Printed Documentation}{35}
  23. \contentsline {subsection}{\numberline {1.7.5}Literals and Emphasis}{37}
  24. \contentsline {subsection}{\numberline {1.7.6}Adding a Header Page}{37}
  25. \contentsline {subsection}{\numberline {1.7.7}Comments}{37}
  26. \contentsline {section}{\numberline {1.8}A Complete Example}{38}
  27. \contentsline {section}{\numberline {1.9}Summary}{39}
  28. \contentsline {chapter}{\numberline {2}FunnelWeb Hints}{41}
  29. \contentsline {section}{\numberline {2.1}Macro Names}{41}
  30. \contentsline {section}{\numberline {2.2}Quick Names}{42}
  31. \contentsline {section}{\numberline {2.3}FunnelWeb the Martinet}{42}
  32. \contentsline {section}{\numberline {2.4}Fiddling With End of Lines}{43}
  33. \contentsline {section}{\numberline {2.5}Fudging Conditionals}{44}
  34. \contentsline {section}{\numberline {2.6}Changing the Strength of Headings}{46}
  35. \contentsline {section}{\numberline {2.7}Efficiency Notes}{47}
  36. \contentsline {section}{\numberline {2.8}Interactive Mode}{47}
  37. \contentsline {section}{\numberline {2.9}Setting Up Default Options}{49}
  38. \contentsline {section}{\numberline {2.10}FunnelWeb and Make}{49}
  39. \contentsline {section}{\numberline {2.11}The Dangers of FunnelWeb}{50}
  40. \contentsline {section}{\numberline {2.12}Wholistic Debugging}{53}
  41. \contentsline {section}{\numberline {2.13}Examples of FunnelWeb Applications}{53}
  42. \contentsline {subsection}{\numberline {2.13.1}Analyzing the Monster Postscript Header File}{54}
  43. \contentsline {subsection}{\numberline {2.13.2}Making Ada ADTs more A}{55}
  44. \contentsline {subsection}{\numberline {2.13.3}Multiple Language Systems}{55}
  45. \contentsline {subsection}{\numberline {2.13.4}The Case of the Small Function}{56}
  46. \contentsline {subsection}{\numberline {2.13.5}When Comments are Bad}{57}
  47. \contentsline {subsection}{\numberline {2.13.6}Documents That Share Text}{58}
  48. \contentsline {subsection}{\numberline {2.13.7}Generics}{59}
  49. \contentsline {section}{\numberline {2.14}Summary}{62}
  50. \contentsline {chapter}{\numberline {3}FunnelWeb Definition}{63}
  51. \contentsline {section}{\numberline {3.1}Introduction}{63}
  52. \contentsline {section}{\numberline {3.2}Notation}{63}
  53. \contentsline {section}{\numberline {3.3}Terminology}{63}
  54. \contentsline {section}{\numberline {3.4}An Architectural Overview}{64}
  55. \contentsline {section}{\numberline {3.5}Diagnostics}{65}
  56. \contentsline {section}{\numberline {3.6}Typesetter Independence}{65}
  57. \contentsline {section}{\numberline {3.7}Command Line Interface}{66}
  58. \contentsline {subsection}{\numberline {3.7.1}Invoking FunnelWeb}{66}
  59. \contentsline {subsection}{\numberline {3.7.2}Command Line Arguments}{67}
  60. \contentsline {subsection}{\numberline {3.7.3}Options}{68}
  61. \contentsline {section}{\numberline {3.8}File Name Inheritance}{70}
  62. \contentsline {section}{\numberline {3.9}FunnelWeb Startup}{70}
  63. \contentsline {section}{\numberline {3.10}Scanner}{71}
  64. \contentsline {subsection}{\numberline {3.10.1}Basic Input File Processing}{71}
  65. \contentsline {subsection}{\numberline {3.10.2}Special Sequences}{72}
  66. \contentsline {subsection}{\numberline {3.10.3}Setting the Special Character}{74}
  67. \contentsline {subsection}{\numberline {3.10.4}Inserting the Special Character into the Text}{74}
  68. \contentsline {subsection}{\numberline {3.10.5}Inserting Arbitrary Characters into the Text}{74}
  69. \contentsline {subsection}{\numberline {3.10.6}Comments}{75}
  70. \contentsline {subsection}{\numberline {3.10.7}Quick Names}{76}
  71. \contentsline {subsection}{\numberline {3.10.8}Inserting End of Line Markers}{76}
  72. \contentsline {subsection}{\numberline {3.10.9}Suppressing End of Line Markers}{77}
  73. \contentsline {subsection}{\numberline {3.10.10}Include Files}{77}
  74. \contentsline {subsection}{\numberline {3.10.11}Pragmas}{78}
  75. \contentsline {subsubsection}{\numberline {3.10.11.1}Indentation}{78}
  76. \contentsline {subsubsection}{\numberline {3.10.11.2}Maximum Input Line Length}{79}
  77. \contentsline {subsubsection}{\numberline {3.10.11.3}Maximum Output File Line Length}{79}
  78. \contentsline {subsubsection}{\numberline {3.10.11.4}Typesetter}{80}
  79. \contentsline {subsection}{\numberline {3.10.12}Freestanding Typesetter Directives}{81}
  80. \contentsline {subsubsection}{\numberline {3.10.12.1}New Page}{81}
  81. \contentsline {subsubsection}{\numberline {3.10.12.2}Table of Contents}{81}
  82. \contentsline {subsubsection}{\numberline {3.10.12.3}Vertical Skip}{81}
  83. \contentsline {subsubsection}{\numberline {3.10.12.4}Title}{82}
  84. \contentsline {subsection}{\numberline {3.10.13}Scanner/Parser Interface}{82}
  85. \contentsline {section}{\numberline {3.11}Parser}{82}
  86. \contentsline {subsection}{\numberline {3.11.1}High Level Structure}{82}
  87. \contentsline {subsection}{\numberline {3.11.2}Free Text}{83}
  88. \contentsline {subsection}{\numberline {3.11.3}Typesetter Directives}{83}
  89. \contentsline {subsubsection}{\numberline {3.11.3.1}Section}{83}
  90. \contentsline {subsubsection}{\numberline {3.11.3.2}Literal Directive}{84}
  91. \contentsline {subsubsection}{\numberline {3.11.3.3}Emphasis Directive}{85}
  92. \contentsline {subsection}{\numberline {3.11.4}Macros}{85}
  93. \contentsline {subsubsection}{\numberline {3.11.4.1}Names}{86}
  94. \contentsline {subsubsection}{\numberline {3.11.4.2}Formal Parameter Lists}{86}
  95. \contentsline {subsection}{\numberline {3.11.5}Expressions}{86}
  96. \contentsline {subsection}{\numberline {3.11.6}Macro Calls}{86}
  97. \contentsline {subsection}{\numberline {3.11.7}Formal Parameters}{87}
  98. \contentsline {subsection}{\numberline {3.11.8}Macros are Static}{87}
  99. \contentsline {section}{\numberline {3.12}Analyser}{88}
  100. \contentsline {section}{\numberline {3.13}Tangle}{88}
  101. \contentsline {section}{\numberline {3.14}Weave}{89}
  102. \contentsline {subsection}{\numberline {3.14.1}Target Typesetter}{89}
  103. \contentsline {subsection}{\numberline {3.14.2}Cross Reference Numbering}{89}
  104. \contentsline {section}{\numberline {3.15}FunnelWeb Shell}{90}
  105. \contentsline {subsection}{\numberline {3.15.1}Introduction}{90}
  106. \contentsline {subsection}{\numberline {3.15.2}Return Statuses}{90}
  107. \contentsline {subsection}{\numberline {3.15.3}Command Line Length}{91}
  108. \contentsline {subsection}{\numberline {3.15.4}String Substitution}{91}
  109. \contentsline {subsection}{\numberline {3.15.5}How a Command Line is Processed}{92}
  110. \contentsline {subsection}{\numberline {3.15.6}Options}{92}
  111. \contentsline {subsection}{\numberline {3.15.7}Shell Commands}{93}
  112. \contentsline {subsubsection}{\numberline {3.15.7.1}Absent}{93}
  113. \contentsline {subsubsection}{\numberline {3.15.7.2}Codify}{93}
  114. \contentsline {subsubsection}{\numberline {3.15.7.3}Compare}{93}
  115. \contentsline {subsubsection}{\numberline {3.15.7.4}Define}{94}
  116. \contentsline {subsubsection}{\numberline {3.15.7.5}Diff}{94}
  117. \contentsline {subsubsection}{\numberline {3.15.7.6}Diffsummary}{95}
  118. \contentsline {subsubsection}{\numberline {3.15.7.7}Diffzero}{95}
  119. \contentsline {subsubsection}{\numberline {3.15.7.8}Eneo}{95}
  120. \contentsline {subsubsection}{\numberline {3.15.7.9}Execute}{96}
  121. \contentsline {subsubsection}{\numberline {3.15.7.10}Exists}{96}
  122. \contentsline {subsubsection}{\numberline {3.15.7.11}Fixeols}{96}
  123. \contentsline {subsubsection}{\numberline {3.15.7.12}Fw}{97}
  124. \contentsline {subsubsection}{\numberline {3.15.7.13}Help}{97}
  125. \contentsline {subsubsection}{\numberline {3.15.7.14}Here}{98}
  126. \contentsline {subsubsection}{\numberline {3.15.7.15}Quit}{98}
  127. \contentsline {subsubsection}{\numberline {3.15.7.16}Set}{98}
  128. \contentsline {subsubsection}{\numberline {3.15.7.17}Show}{98}
  129. \contentsline {subsubsection}{\numberline {3.15.7.18}Skipto}{98}
  130. \contentsline {subsubsection}{\numberline {3.15.7.19}Status}{99}
  131. \contentsline {subsubsection}{\numberline {3.15.7.20}Tolerate}{100}
  132. \contentsline {subsubsection}{\numberline {3.15.7.21}Trace}{100}
  133. \contentsline {subsubsection}{\numberline {3.15.7.22}Write}{100}
  134. \contentsline {subsubsection}{\numberline {3.15.7.23}Writeu}{100}
  135. \contentsline {section}{\numberline {3.16}Concluding Remarks}{100}
  136. \contentsline {chapter}{\numberline {4}FunnelWeb Installation}{101}
  137. \contentsline {section}{\numberline {4.1}Obtaining a Copy of FunnelWeb}{101}
  138. \contentsline {section}{\numberline {4.2}Establishing The Directory Tree}{102}
  139. \contentsline {subsection}{\numberline {4.2.1}Admin Directory}{102}
  140. \contentsline {subsection}{\numberline {4.2.2}Answers Directory}{102}
  141. \contentsline {subsection}{\numberline {4.2.3}Hackman Directory}{103}
  142. \contentsline {subsection}{\numberline {4.2.4}Results Directory}{103}
  143. \contentsline {subsection}{\numberline {4.2.5}Scripts Directory}{103}
  144. \contentsline {subsection}{\numberline {4.2.6}Sources Directory}{103}
  145. \contentsline {subsection}{\numberline {4.2.7}Tests Directory}{104}
  146. \contentsline {subsection}{\numberline {4.2.8}Userman Directory}{105}
  147. \contentsline {section}{\numberline {4.3}Compiling FunnelWeb}{105}
  148. \contentsline {section}{\numberline {4.4}Testing FunnelWeb}{105}
  149. \contentsline {section}{\numberline {4.5}Installing FunnelWeb}{106}
  150. \contentsline {section}{\numberline {4.6}Printing Manuals}{107}
  151. \contentsline {section}{\numberline {4.7}Installation Problems?}{107}
  152. \contentsline {chapter}{\numberline {5}FunnelWeb Administration}{109}
  153. \contentsline {section}{\numberline {5.1}Introduction}{109}
  154. \contentsline {section}{\numberline {5.2}The User's Commitment To FunnelWeb}{109}
  155. \contentsline {section}{\numberline {5.3}Documentation}{110}
  156. \contentsline {section}{\numberline {5.4}Registration}{110}
  157. \contentsline {section}{\numberline {5.5}Support}{110}
  158. \contentsline {section}{\numberline {5.6}Copyright}{112}
  159. \contentsline {section}{\numberline {5.7}Nowarranty}{112}
  160. \contentsline {section}{\numberline {5.8}Distribution}{113}
  161. \contentsline {section}{\numberline {5.9}Modification}{113}
  162. \contentsline {section}{\numberline {5.10}Versions}{114}
  163. \contentsline {section}{\numberline {5.11}FTP Archive and Author}{114}
  164. \contentsline {chapter}{\numberline {A}Glossary}{115}
  165. \contentsline {chapter}{\numberline {B}References}{117}
  166. \contentsline {chapter}{Index}{117}
  167.