home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 2 / MacMania 2.toast / Demo's / Tools&Utilities / Help 1.1 / HelpText < prev    next >
Encoding:
Text File  |  1993-10-19  |  3.1 KB  |  106 lines  |  [TEXT/ALFA]
  1. %
  2. %  Help Facility, version 1.1
  3. %
  4. %  Copyright 1993, Ronald T. Kneusel.    Last Modification: Oct. 19, 1993.
  5. %
  6. %
  7. %  This is the data file which the Help program reads when searching for
  8. %  topics and text.  Lines that start with a % are comments and are ignored
  9. %  by the program.
  10. %
  11. %  MONITOR= 12 indicates the monitor size in inches.  The only allowed
  12. %  values are 9 and 12 inches.  Other values default to 12 inches.  This line
  13. %  should appear before the &&BEGIN.  MONITOR= must be uppercase and
  14. %  start in the first column.  (As must all other codes)
  15. %
  16. %  TITLE= <Window Title>  defines the title for the Help window.  If not
  17. %  found it defaults to "Help".  Same restrictions as for MONITOR=.
  18. %
  19. %  FONT= <0 | 1>  defines the font to use when displaying text.  If FONT is
  20. %  0 text is displayed in 9 point Monaco.  If FONT is 1 text is displayed in 
  21. %  12 point Courier.  Monaco is default.  
  22. %
  23. %  Other codes interpreted by the Help program:
  24. %
  25. %
  26. %  ##<title>        -   marks the beginning of a section. 
  27. %                       e.g.  ##Getting Started
  28. %  &&BEGIN          -   marks beginning of subject headings.
  29. %  &&END            -   marks end of subject headings.
  30. %  ##END            -   marks end of text for a section.
  31. %  ##.              -   marks end of the file. Put nothing after this mark.
  32. %
  33. %
  34. %  Use the following commands when writing the text for a subject:
  35. %
  36. %  .P               -   end of page marker.
  37. %  .S<#>            -   print <#> spaces, e.g.  .S30 prints 30 spaces.
  38. %  .I               -   set text to inverse (white on black).
  39. %  .N               -   set text to normal (black on white).
  40. %
  41. %  The commands must start at the beginning of a line and must be the
  42. %  only text on that line.  All lines should end with a return.
  43. %
  44. %  New topics can be added at the end of the file.  The file MUST be named
  45. %  HelpText and reside in the same folder as the Help application.
  46. %
  47. %  Subject headings must be identical to the section headings.  There can be no
  48. %  blank lines between the &&BEGIN and &&END.  All text between the beginning 
  49. %  of a section and the ##END marker are displayed.  Blank lines are allowed
  50. %  and lines should be kept under 80 characters.  If using a word processor
  51. %  to modify this file, make certain that it is stored as a TEXT file.
  52. %  TeachText might be a better choice for editing.  A programming editor such
  53. %  as Alpha or Edit is even better.
  54. %
  55. %  Window sizes for various monitors and fonts:
  56. %
  57. %  9 inch monitor:
  58. %
  59. %          FONT= 0   gives 24 rows of 83 columns
  60. %          FONT= 1   gives 21 rows of 72 columns
  61. %
  62. % 12 inch monitor:
  63. %
  64. %          FONT= 0   gives 28 rows of 83 columns
  65. %          FONT= 1   gives 24 rows of 72 columns
  66. %
  67. %
  68. TITLE= Help
  69. MONITOR= 12
  70. FONT= 0
  71. %
  72. %       Place subject headings here
  73. %
  74. &&BEGIN
  75. Sample Topic 1
  76. Sample Topic 2
  77. &&END
  78. %
  79. %       Start of help text
  80. %
  81. ##Sample Topic 1
  82. .I
  83. This is a sample topic
  84. .N
  85.  
  86. Look in the file 'HelpText' to see how to set up your own topics.
  87.  
  88. ##END
  89. %
  90. %       The second sample topic
  91. %
  92. ##Sample Topic 2
  93. .S30
  94. This is in the middle
  95.  
  96.  
  97. Blank lines are printed
  98.  
  99. % but comments are not....
  100.  
  101. .P
  102.  
  103. This is on the next page.
  104. ##END
  105. ##.
  106.