home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / t / tw31.zip / TWTUT2.CHP < prev    next >
Text File  |  1993-02-23  |  11KB  |  376 lines

  1. #OF
  2. %
  3. #EF
  4. #TGETTING  STARTED
  5. #C2,R4
  6. The very first step in writing a tutorial with ~H~bTutorialWriter~N is to create
  7. a ~HCONFIGURATION~N file.  Before I describe how to do that, let's look at why
  8. it is necessary.
  9.  
  10. A ~HTUTORIAL~N refers to a collection of files which constitute a complete
  11. instructional package.  At the simplest level it is a ~HSINGLE CHAPTER~N
  12. ~M~Itutorial~N and consists of the file which you write, called a ~HCHAPTER~N, the
  13. ~G~ITWTEACH.EXE~N Display program and a ~HCONFIGURATION~N file. The ~HConfiguration~N file
  14. is essential, because it tells ~G~ITWTEACH~N the name of your ~HChapter~N and what
  15. colors to use to display it.
  16.  
  17. The next level is a ~HSINGLE CHAPTER~M~I tutorial~N which has a ~HHELP~N System, or
  18. ~HHYPERTEXT~N or includes ~HTEXTSCREENS~N. Each of these has its own file, and again
  19. it is the ~HConfiguration~N file which tells ~G~ITWTEACH~N what they are called.
  20.  
  21. And the most advance level ~M~Itutorial~N has all the previously described files,
  22. but the ~HSINGLE CHAPTER~N becomes a ~HMENU CHAPTER~N, and gives access to up to
  23. nine ~HSUB-CHAPTERS~N. The ~HMenu Chapter~N is specified in the ~HConfiguration~N file.
  24.  
  25. Here's how it looks graphically.
  26. #W
  27. %
  28. #GT,structure
  29. #T
  30. #C4,R13
  31. |CFG|
  32. #C14,R11
  33. |SCREENS|
  34. #C16,R8
  35. |HELP|
  36. #C15,R5
  37. |HYPER|
  38. #C28,R15
  39. |MENU|
  40. #C49,R6
  41. |CHAPTER|
  42. #C49,R9
  43. |CHAPTER|
  44. #C49,R12
  45. |CHAPTER|
  46. #C49,R15
  47. |CHAPTER|
  48. #C39,R20
  49. |SINGLE CHAPTER|
  50. #C2,R23
  51. ~HUse the SPACE BAR or MOUSE to move around.  ENTER or MOUSE Button to Select.~N
  52. #WP
  53. %
  54. #EF
  55. #T
  56. #C2,R5
  57. ~H~bTutorialWriter~N uses the extension ~H.HLP~N for a ~G~IHELP~N file, ~H.HYP~N for ~G~IHYPERTEXT~N,
  58. ~H.SCR~N for ~G~ITEXTSCREEN~N, ~H.CNF~N for ~G~ICONFIGURATION~N and ~H.CHP~N for the text files you
  59. write.  In view of this, I suggest that you adopt a ~HPROJECT NAME~N convention,
  60. which makes all the files in a ~HTUTORIAL~N easily recognisable. For example,
  61. in this ~C~ITutorial~N the Project Name is ~C~ITWTUT~N.  This means that all files are
  62. called ~C~ITWTUT~N and the text files add a number to the basic name, with
  63. ~C~ITWTUT0~N being the ~HMENU Chapter~N and therefore the first file to read :
  64.  
  65. ~H      TWTUT.CNF
  66.       TWTUT.HLP
  67.       TWTUT.SCR
  68.       TWTUT.HYP
  69.       TWTUT0.CHP
  70.       TWTUT1.CHP
  71.       TWTUT2.CHP~N  etc.
  72.  
  73. This makes it easy to copy ~HALL~N the relevant ~HTUTORIAL~N files to disk for
  74. distribution to your audience. In this case, typing ~HCOPY TWTUT*.* A:~N will
  75. transfer all the files to the disk in drive A.
  76. #WP
  77. #EF
  78. #GT,main menu
  79. #BO,3,4,45,8,7,1,0,3,1,3
  80. One of the options on the Main Menu is
  81. Configure Tutorial.  That's the option
  82. to create the CONFIGURATION FILE.
  83.  
  84. #BO,3,4,48,10,7,1,0,5,1,3
  85. When you choose Configure Tutorial, you
  86. will be asked for the name of the file.
  87. Just type in the name of your project
  88. e.g. TWTUT.  TWRITER will give it the
  89. extension .CNF
  90.  
  91. #BO,3,4,48,8,7,1,0,3,1,3
  92. As an example of a CONFIGURATION FILE
  93. let's take a look at the one for this
  94. Tutorial (TWTUT.CNF).
  95.  
  96. #GT,configure
  97. #D5
  98. #BO,3,4,44,10,7,1,0,5,1,3
  99. Notice that except for the first file
  100. to read, I've called  all the others
  101. the same name. Remember that each one
  102. will be given its own extension by
  103. Tutorialwriter - .HLP, .HYP, .SCR
  104. #D5
  105. #BO,3,14,44,20,7,1,0,5,1,3
  106. And don't worry about seeing these
  107. numbers in place of colors.  Every
  108. function in TutorialWriter has very
  109. full Help Screens. Just press F1.
  110. Here's what you get for color codes.
  111. #EF
  112. #GT,colors
  113. #EL,25
  114. #D5
  115. #BO,37,4,79,8,7,1,0,3,1,3
  116. I chose 14 for normal Text - Yellow
  117. and 15 for highlight - White
  118. Then 0 for background - Black
  119.  
  120. #GT,configure
  121. #D2
  122. #BO,37,4,79,8,7,1,0,3,1,3
  123. And when you've made the entries
  124. for your tutorial, just press F10
  125. to create the file.
  126. #EL,25
  127. #WP
  128. %
  129. #EF
  130. #TGETTING  STARTED
  131. #C2,R5
  132. OK, that's the first step done. You know that you must create a ~HCONFIGURATION
  133. FILE~N, why it is necessary, and how to do it.
  134.  
  135.  
  136. The next step is to start writing your ~HChapter~N (or ~HChapters~N).
  137.  
  138.  
  139. So we will start with the five most common ~HCommands~N in ~H~bTutorialWriter~N. These
  140. five are enough to write a complete ~M~Itutorial~N (although it would not be very
  141. impressive).
  142.  
  143.  
  144. You've already used three of them, so we are well on our way. They are
  145.  
  146. ~H#EF~N - which clears the full screen.
  147. ~H#T~N  - which puts the title in a box at the top of the screen
  148. ~H#W~N  - which puts CONTINUE and QUIT buttons at the bottom of the screen
  149.        and waits for a keystroke or Mouse button
  150. #WP
  151. %
  152. #EF
  153. #TGETTING  STARTED
  154. #C2,R5
  155. The two new ~HCommands~N are
  156.  
  157. ~H#X~N - which ends the Chapter
  158. ~H#Cx1,Ry1~N - which positions the cursor at Column x1 and Row y1.
  159.  
  160. Here's how they go together :
  161.  
  162. ~H#EF~W                          - Clear the screen
  163. ~H#T~R~IMy First Tutorial~W          - Put on your Title
  164. ~H#C2,R5~W                       - Start at Column 2 on Row 5
  165. ~R~INow you write your first
  166. screenful of information
  167. It can be from Row 5 to
  168. Row 24.~N
  169. ~H#W~W                           - Wait for a keystroke
  170. ~H#X~W                           - Exit from the tutorial~N
  171.  
  172. And that's it! You will have a screenful of information in color with a
  173. Title, waiting for the Reader to press a key or a Mouse button.
  174. #WP
  175. %
  176. #EF
  177. #T
  178. #C2,R5
  179. And you can go on repeating this pattern to your heart's content!!
  180.  
  181. ~H#EF~W                          - Clear the screen
  182. ~H#T~R~IMy First Tutorial~W          - Put on your Title
  183. ~H#C2,R5~W                       - Start at Column 2 on Row 5
  184. ~R~INow you write your first
  185. screenful of information
  186. It can be from Row 5 to
  187. Row 24.~N
  188. ~H#W~W                           - Wait for a keystroke
  189. ~H#EF~W                          - Clear the screen
  190. ~H#T~R~IMy First Tutorial~W          - Put on your Title
  191. ~H#C2,R5~W                       - Start at Column 2 on Row 5
  192. ~R~INow you write your ~C~I~Fsecond
  193. ~R~Iscreenful of information
  194. It can be from Row 5 to
  195. Row 24.~N
  196. ~H#W~W                           - Wait for a keystroke
  197. ~H#X~W                           - Exit from the tutorial~N
  198. #WP
  199. %
  200. #EF
  201. #T
  202. #C2,R5
  203. There's a couple of points that need to be stressed.
  204.  
  205. The ~HCommands~N must start with the ~C~I#~N in the first column of a row, or they will
  206. not be recognised as ~HCommands~N:
  207.  
  208. ~H#EF~N is a ~HCommand~N to clear the screen.
  209. ~H   #EF~N is not a ~HCommand~N. It will be printed to the screen like any other
  210. word.
  211.  
  212.  
  213.  
  214. And ~C~I#X~H MUST~N be included in a ~HChapter~N. If it is not, ~G~ITWTEACH~N will not know
  215. where to stop reading, and your computer will probably lock up.
  216.  
  217. Bear in mind that only one ~C~I#X~N is needed in a ~HChapter~N. When ~G~ITWTEACH~N finds
  218. it, it stops reading and returns to DOS (in a ~HSINGLE CHAPTER~M~I tutorial~N) or
  219. to the ~HMenu~N (in a ~HMULTIPLE CHAPTER~M~I tutorial~N). Anything after the first ~C~I#X~N
  220. is ignored.
  221. #WP
  222. %
  223. #EF
  224. #T
  225. #C2,R5
  226. If you like bland, you have now learned all the ~HCommands~N you need to produce
  227. ~M~Itutorials~N which are far superior to the standard white on black text file
  228. viewers that are the norm.
  229.  
  230.  
  231. But you still need to know a couple of things. The first is how to use the
  232. ~HEditor~N to write your ~M~Itutorials~N and the second is how to create a ~HMenu~N for
  233. ~HMultiple Chapters~N.
  234.  
  235.  
  236. So we will cover that next.
  237.  
  238.  
  239. But if you prefer outstanding, colorful, whizz-bang presentations, the next
  240. six ~HChapters~N in this ~M~ITutorial~N will show you at set of wonderful tools which
  241. will have your audience engrossed in your ~M~Itutorial~N.
  242.  
  243.  
  244. Now on to the ~HEditor~N and ~HMenu Utility~N.
  245. #WP
  246. %
  247. #EF
  248. #T
  249. #C2,R5
  250. Now it's time to start developing your instructional material.   The
  251.  
  252. ~C~ICreate/Edit Chapter~N option at the ~C~IMain Menu~N brings up ~H~bTutorialWriter~N's ~C~IText
  253.  
  254. Editor~N. This operates just like a ~HWord Processor~N, except that it doesn't word-
  255.  
  256. wrap at the end of a line.  And it stores its text in ~HASCII~N format, which
  257.  
  258. is the only format ~G~ITWTEACH~N can read. The ~C~IEditor~N can handle individual files
  259.  
  260. of up to ~H60K~N.  If any text file in your ~M~ITutorial~N gets bigger than this, you
  261.  
  262. will need to use another more powerful ~HWord Processor~N.  If you do, be sure
  263.  
  264. that you ~Hsave the file in ASCII format~N, and ~Hdon't use features like Bold or
  265.  
  266. Underline~N.  ~G~ITWTEACH~N cannot read these special features.
  267.  
  268. Let's look at one of the text screens that make up this ~C~ITutorial~N.
  269.  
  270. #WP
  271. #GT,text screen
  272. #D5
  273. #BO,10,16,72,22,7,1,0,5,1,3
  274. This is the opening screen of this CHAPTER. My method of
  275. developing material is to write an outline on paper with
  276. the points I want to cover. Then I use the Editor and
  277. develop the screens, one at a time. When the screen looks
  278. the way I want it, I then add the Codes for colors etc.
  279.  
  280. #GT,text screen 2
  281. #D5
  282. #BO,15,15,67,22,7,1,0,6,1,3
  283. Don't worry about all the funny looking codes
  284. that you see scattered through the text. The
  285. Editor has a complete HELP system which explains
  286. every Command Code in TutorialWriter. Just press
  287. F1 to bring up the HELP system and choose the
  288. Code you want to examine.
  289.  
  290. #GT,help system
  291. #D4
  292. #GT,help cursor
  293. #EL,25
  294. #WP
  295. %
  296. #EF
  297. #T
  298. #C2,R5
  299. As you are creating your file, you can exit from the ~C~IEditor~N and use the
  300.  
  301. ~C~IView Tutorial~N option to see how it looks. You will be asked to supply
  302.  
  303. the name of the ~G~ICONFIGURATION~N file, then you will be shown your ~HCHAPTER~N
  304.  
  305. exactly as your Readers will see it when they use ~G~ITWTEACH~N.  However,
  306.  
  307. when you use ~G~ITWRITER~N's ~C~IView Tutorial~N, the whole ~G~ITWRITER~N program is still in
  308.  
  309. memory, using up about ~H200K~N. So some codes, such as running an external
  310.  
  311. graphics program or screen saves, may not work because there is not enough
  312.  
  313. memory left for them. If this happens, exit from ~G~ITWRITER~N and use the ~G~ITWTEACH
  314.  
  315. ~HModule~N. It only needs ~H100K~N of memory.  Just type ~G~ITWTEACH~R~I configfilename~N at the
  316.  
  317. ~HDOS~N prompt.
  318. #WP
  319. #EF
  320. #GT,main menu
  321.  
  322. #BO,3,4,50,9,7,1,0,4,1,3
  323. Since the TWTUT Tutorial will have MULTIPLE
  324. CHAPTERS, we need to create a MENU which
  325. will be presented at the end of TWTUT0.CHP,
  326. the MENU CHAPTER. Choose Utility Programs.
  327.  
  328. #GT,utilities
  329. #BO,3,4,30,6,7,1,0,1,1,3
  330. Now choose Create Menu.
  331.  
  332. #GT,make menu
  333. #D10
  334. #BO,3,18,48,24,7,1,0,5,1,3
  335. This may look like a lot of things to fill
  336. in, but remember to use the HELP system.
  337. Just press F1 and you will get HELP for
  338. whatever field your cursor is in. Here's
  339. the HELP for 'Title for Menu Screen'.
  340. #GT,menu help
  341. #EL,25
  342. #WP
  343. %
  344. #EF
  345. #T
  346. #AP,1,6
  347. TO INCLUDE THE MENU IN YOUR TUTORIAL,
  348. THE MENU CHAPTER MUST FINISH WITH THE
  349. COMMAND #Mmenufilename FOLLOWED BY #X
  350. ON THE NEXT LINE. THIS FINISHES THE
  351. CHAPTER AND NOTHING WRITTEN AFTER THESE
  352. COMMANDS WILL BE READ IN THAT CHAPTER.
  353. #WP
  354.  
  355. #EF
  356. %
  357. #GT,menu file
  358. #BO,41,19,78,22,7,1,0,2,1,3
  359. Here's the Menu Chapter for this
  360. Tutorial. Note the #M Command.
  361.  
  362. #EL,25
  363. #WP
  364. %
  365. #EF
  366. #T
  367. #C2,R10
  368. A final point for this Chapter is that the ~C~I#M~H Menu Command~N can only be used
  369.  
  370. once in a ~M~Itutorial~N. After the ~G~IMenu~N has been created in the ~HMenu Chapter~N, any
  371.  
  372. subsequent attempts to create one will be ignored by ~G~ITWTEACH~N.
  373.  
  374. #WP
  375. #X
  376.