home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / WW4SHARE / W424ARIP.ZIP / RIPSPEED.DOC < prev   
Text File  |  1995-07-06  |  40KB  |  992 lines

  1.  
  2.                RRRRRRR    IIIIII  PPPPPPP
  3.                 RR   RR     II     PP   PP
  4.                 RR  RR      II     PP   PP
  5.                 RRRR        II     PPPPPP
  6.                 RR  RR      II     PP
  7.                RRR   RRR  IIIIII  PPPP     speed
  8.  
  9.  
  10.           Remote Imaging Protocol (RIPscrip) Module
  11.                    for the WWIV BBS system
  12.  
  13.  
  14.             Copyright (C) 1994 by Zachary G. Ives
  15.                      All Rights Reserved
  16.                           Contents
  17. 1 Introduction . . . . . . . . . . . . . . . . . . . . . . 3
  18. 2 Installing and Configuring RIPspeed. . . . . . . . . . . 5
  19. 3 Installing RIPdrive. . . . . . . . . . . . . . . . . . .11
  20. 4 Running RIPdrive . . . . . . . . . . . . . . . . . . . .14
  21. 5 Editing Menus. . . . . . . . . . . . . . . . . . . . . .19
  22. 6 Adding New Menu Styles . . . . . . . . . . . . . . . . .25
  23. 7 RIP and Non-English Languages. . . . . . . . . . . . . .30
  24. 8 Random RIP Screens . . . . . . . . . . . . . . . . . . .34
  25. 9 Taking Advantage of Hypertext. . . . . . . . . . . . . .35
  26. 10 Substitution Codes. . . . . . . . . . . . . . . . . . .38
  27. 11 Special Features. . . . . . . . . . . . . . . . . . . .44
  28. 12 Compatibility . . . . . . . . . . . . . . . . . . . . .47
  29. 13 RIP File List . . . . . . . . . . . . . . . . . . . . .49
  30. 14 More of Zack Ives' Software . . . . . . . . . . . . . .55
  31. 15 Suggestions and Inquiries . . . . . . . . . . . . . . .59
  32. 16 Credits . . . . . . . . . . . . . . . . . . . . . . . .60
  33. 1                       Introduction
  34.  
  35.  
  36.      Telegrafix's RIPscrip(tm) protocol has rapidly become a
  37. nearly universal standard for BBS graphical user interfaces.
  38. WWIV has the most flexible and advanced RIP support
  39. available anywhere.  Once your system is properly
  40. configured, you can give your users an interface which
  41. rivals that of America Online, CompuServe, or the World Wide
  42. Web - without sacrificing speed or compatibility.
  43.  
  44.      WWIV's RIPspeed module includes six different GUI
  45. styles, so your callers can pick whichever interface they
  46. are most comfortable with.  The BBS can mimic the Apple
  47. Macintosh(tm), IBM's OS/2(tm), or Microsoft Windows 95(tm). 
  48. Also included are Full Screen menus, similar to the RIP
  49. menus in many other BBS programs; an icon-less Drop-down
  50. menu style, for those who hate little pictures; and a
  51. Simplified menu style which minimizes the plethora of
  52. options available to novice users.  All of these menu styles
  53. are completely modular and customizable, and you can easily
  54. add your own sets to the list.
  55.  
  56.      In addition, your BBS allows you to link together files
  57. to form RIP hypertext documents; it includes menu files
  58. which can be used for external, non-RIP editors and doors;
  59. and it even supports the RIPdrive(tm) local RIP driver
  60. program, which allows you to view the RIP graphics locally
  61. while the BBS is running.
  62. 2            Installing and Configuring RIPspeed
  63.  
  64.  
  65.      If you are installing WWIV for the first time, it will
  66. automatically place all files in the proper directories when
  67. you run INIT, so you can skip down to the next section. 
  68. However, if you are installing over an old setup, things are
  69. somewhat more complex.
  70.  
  71. 2.1  Installing over an Old Setup
  72.  
  73.      If you have installed over an old version of WWIV, you
  74. will need to manually move a number of files to the proper
  75. directories.
  76.  
  77.      The first step is to move the files which belong in
  78. your GFILES or language directory.  Move *.MSG, *.STR,
  79. *.RIP, and *.ANS to your language directory.  The
  80. MENUSLCL.MSG, MENUSSOF.MSG, and *.RIP files contain RIP menu
  81. screens which are not downloadable by your callers.
  82.  
  83.      Next, create a directory for the downloadable RIP menu
  84. files.  WWIV normally assumes that your RIP menu directory
  85. is \WWIV\RIPMENUS, but you can change this.  PKUNZIP the
  86. RIPMENUS.ZIP file into that directory.
  87.  
  88.  
  89. 2.2  Configuring RIPspeed
  90.  
  91.      Once the necessary files have been installed, you need
  92. to configure your BBS setup.  Use a text editor to open the
  93. WWIV.INI file.  Scroll down until you see a line reading
  94. "; RIP-specific constants"
  95.  
  96.      Now find the line which reads "RIP_BBS_ID = WWIV424." 
  97. Erase the "WWIV424," and change it to a 9-letter name for
  98. your BBS.  Be sure you use only capital letters, and no
  99. spaces.  (Imagine you are creating a DOS filename.)  This
  100. BBS identifier should be unique, because it will be used to
  101. store your callers' information specific to this bulletin
  102. board.
  103.  
  104.      The RIP_MENU_DATE identifier should be left alone until
  105. you begin editing or creating new RIP menus.  The procedure
  106. for doing this is described in section 5.2.
  107.  
  108.      RIP_ADJUST is a number between -5 and +5, and is used
  109. by the BBS when RIP drop-down menus are displayed.  Some
  110. modems are set in such a way that pulling down a menu
  111. misaligns the BBS prompt.  If this happens, you can try
  112. adjusting the alignment with this constant.
  113.  
  114.      Finally, it is important that you set RIP_DIR to point
  115. to your RIP menus directory.  If you did a first-time
  116. installation, your RIP menus are in RIPMENUS, and RIP_DIR
  117. already is set to this directory.  However, if you manually
  118. installed the RIP menu files in a different directory,
  119. change the RIP_DIR variable to point to this new directory.
  120.  
  121.      If you move further down the WWIV.INI file, into the
  122. System Flags, you will find two other RIP-related settings. 
  123. If you wish to disable RIP graphics support for any reason,
  124. you can set RIP_SUPPORT=N.  Also, if you wish to disable
  125. support for the local RIP driver, you can set RIPDRIVE_ON=N. 
  126. Note that you must erase the semicolon at the start of these
  127. lines to make them take effect.
  128.  
  129.  
  130. 2.3  Doors and Editors
  131.  
  132.      Most door and editor programs do not normally support
  133. RIP graphics, but WWIV can provide them with this
  134. capability.  You can assign a RIP menu to be displayed every
  135. time a specific door is loaded.
  136.  
  137.      In your language directory are four files which are
  138. designed to be attached to external programs:  WWIVEDIT.RIP,
  139. WWIVMAIL.RIP, FSED.RIP, and FEDIT.RIP.  The "attachment"
  140. process is quite simple.  Load up your BBS and determine
  141. which number the editor or door receives in the list.  For
  142. example, WWIVedit may be editor #1, and WWIVmail may be door
  143. (chain) #2.  If WWIVedit is editor 1, rename the
  144. WWIVEDIT.RIP file to EDIT1.RIP, and if WWIVmail is door #2,
  145. rename WWIVMAIL.RIP to DOOR2.RIP.
  146.  
  147.      You can repeat this process for each of your doors and
  148. editors, simply naming the file EDITx.RIP or DOORx.RIP.  It
  149. is quite easy to adapt the included RIP files to work with
  150. other programs, too.
  151.  
  152.  
  153. 2.4  You Are Ready to Go
  154.  
  155.      You should now have RIP graphics support for all
  156. incoming callers.  WWIV has been verified to work with Telix
  157. for Windows 1.01D, RIPterm 1.54, Softerm for Windows 1.0,
  158. and RIPterm 2.00.01.  Note that, in the current state, you
  159. will not be able to see the same graphics screens your users
  160. are viewing.  If you want to see the actual graphics, you
  161. need to see the next section on installing RIPdrive.
  162. 3                    Installing RIPdrive
  163.  
  164.  
  165.      If you would like to see the fancy RIP graphics screens
  166. your BBS is displaying, you need to install the RIPdrive
  167. program.  RIPdrive is not included in the basic WWIV
  168. package, but is available as in a separate file or with the
  169. WWIV Accessories.  If you cannot find the program, the
  170. latest and most complete version is guaranteed to be
  171. available on The Griffon's Lair BBS at (707) 526-2184, in
  172. the file RIPDRIVE.ZIP.
  173.  
  174.      Before you install RIPdrive, you should realize that
  175. the program is a TSR which supplies a complete graphical
  176. user interface - so it demands some sacrifice of speed and
  177. memory.  If you have a 486DX2/66 or better, the speed
  178. difference will be hardly noticeable; and if you do not have
  179. dozens of TSRs loaded, you can probably spare the RAM.
  180.  
  181.      The program requires EGA or better graphics; a 286 or
  182. higher processor (386/25 or better recommended); 60K of DOS
  183. RAM (either upper or lower memory); and 176K of EMS memory. 
  184. Be sure you have EMS emulation enabled if you are using a
  185. memory manager; you can verify this by running MEM from the
  186. DOS prompt.
  187.  
  188.      Installation is fairly simple.  PKUNZIP the
  189. RIPDRIVE.ZIP file into your main WWIV directory, and then
  190. move the *.CHR (font) files into your RIP menu directory. 
  191. Now run RIPDRIVE, load the BBS, and log on with the
  192. keyboard.  At the main BBS prompt, type /R and you should
  193. see a RIP graphics menu selection screen.  Local RIP
  194. graphics are ready to go.
  195.  
  196.      While you are logged on, try using one of your external
  197. editors by posting a message.  If you have no "out of
  198. memory" errors, you should be completely ready.  Otherwise,
  199. you can quit the BBS and make some modifications to
  200. WWIV.INI.  Under the Spawn Options heading are lines reading
  201. ";SPAWNOPT[xxx]=".  These allow you to change the operation
  202. of the BBS when it is "spawning" (running) external
  203. programs.  Find ";SPAWNOPT[FSED]" and erase the semicolon at
  204. the start of the line.  Set it equal to "COMIO, SHRINK"
  205. instead of simply "COMIO."  This will cause the BBS to
  206. shrink its memory usage before loading the editor, providing
  207. the editor with more room.  If necessary, you can make
  208. similar changes to the lines corresponding to other BBS
  209. events.
  210. 4                     Running RIPdrive
  211.  
  212.  
  213. 4.1  Basic Syntax
  214.  
  215.      When you first load RIPdrive, it checks the current
  216. directory for the WWIV.INI file, which it uses to find your
  217. RIP menu files.  Therefore, RIPdrive should be run from the
  218. main WWIV directory.  Alternatively, you can simply copy
  219. WWIV.INI to the directory from which you want to load the
  220. program; or you can specify the RIP menu path on the command
  221. line.
  222.  
  223.      The basic syntax for running RIPdrive is as follows:
  224.  
  225.      RIPDRIVE [[/U] | [/LOW] [path]]
  226.  
  227.      In other words, you can run the program with no
  228. parameters; use the /U option alone; or use /LOW and/or a
  229. path specification.
  230.  
  231.      Running RIPdrive with no parameters will load the
  232. program into memory, looking in the WWIV.INI file for the
  233. RIP menu directory.  If no directory is found, the program
  234. assumes the path of RIPMENUS.  RIPdrive will automatically
  235. attempt to load itself into high memory if you have
  236. sufficient UMBs.  (Do *not* use a memory manager LOADHIGH
  237. command; it will probably *prevent* the program from loading
  238. high.)
  239.  
  240.      The /U option is used to unload the TSR from memory.
  241.  
  242.      Use the /LOW option to tell the program not to attempt
  243. to load itself high.
  244.  
  245.      Finally, you can specifically tell RIPdrive where to
  246. look for its menu and icon files by specifying a pathname on
  247. the command line.  This will override any settings in
  248. WWIV.INI.  For example, to tell RIPdrive all RIP files are
  249. in C:\RIPFILES, you would use:
  250.  
  251.      RIPDRIVE C:\RIPFILES
  252.  
  253. regardless of the contents of WWIV.INI.
  254.  
  255.  
  256. 4.2  Automatically Loading RIPdrive with the BBS
  257.  
  258.      The simplest way to load the BBS with local RIP
  259. graphics enabled is to use batch files.  It is recommended
  260. that you load and unload RIPdrive as needed, rather than
  261. loading it once in AUTOEXEC.BAT.  Here is a sample setup for
  262. a two-instance WWIV system:
  263.  
  264. BBS1.BAT:
  265.      SET WWIV_INSTANCE=1
  266.      RIPDRIVE
  267.      BBS -i1 %1 %2 %3 %4 %5 %6 %7 %8 %9
  268.      RIPDRIVE /U
  269.      SET WWIV_INSTANCE=
  270.  
  271.  
  272. BBS2.BAT:
  273.      SET WWIV_INSTANCE=2
  274.      RIPDRIVE
  275.      BBS -i2 %1 %2 %3 %4 %5 %6 %7 %8 %9
  276.      RIPDRIVE /U
  277.      SET WWIV_INSTANCE=
  278.  
  279.  
  280.      Using this setup, the sysop would load instance one
  281. with BBS1.BAT, and the second instance with BBS2.BAT.  Note
  282. that the TSR must be loaded separately for each instance, so
  283. this system requires 176K * 2 or 384K of EMS memory.
  284. 5                       Editing Menus
  285.  
  286.  
  287. 5.1  Basic Requirements
  288.  
  289.      You may wish to customize the RIP menus for your
  290. system, and WWIV makes this quite simple.  You need a good
  291. RIP drawing program, such as DeadPaint 4.0, FlatLine, or
  292. RIPpaint.  (I do not recommend Tombstone Artist, because I
  293. have found that it will not recognize many of the RIP
  294. protocol elements.)  Icon editing requires a program like
  295. MAKEICN and a standard BMP editor.  You can get a good idea
  296. of what the menu files look like by using my RIPspy RIP file
  297. viewer, available as RSPY_102.ZIP on many BBSs.
  298.  
  299.      Each menu set has its own extension:  menu set 1 is
  300. *.MN1, with *.IC1 and *.BM1 as its icons; menu set 2 is
  301. *.MN2, and would have *.IC2 and *.BM2 if it used icons; menu
  302. set 4 is *.MN4, *.BM4, and *.IC4; etc.  The MN files are the
  303. RIP menus; IC files are RIPterm 1.54-compatible icons; and
  304. BM files are RIPterm 2.0-compatible icons.
  305.  
  306.  
  307. 5.2  Downloadable Menus
  308.  
  309.      All of the downloadable menu files, which make up the
  310. majority of the RIP interface, are in your RIP menu
  311. directory.  A list of the filenames is included in chapter
  312. 13. 
  313.  
  314.      You should be able to load any of the menu files into
  315. the RIP drawing program and make any changes you want.  Use
  316. extreme caution with the pull down menus (MENU301-304 in
  317. menu sets 3-6), however:  each of these menu styles uses the
  318. RIP "clipboard" to quickly redraw the basic menu bar, but
  319. some RIP editors remove the necessary clipboard commands
  320. when they overwrite the file.
  321.  
  322.      The last step you need to perform is one which will let
  323. the BBS decide whether it should refresh the menus which the
  324. user has downloaded.  If you have made changes to a menu,
  325. you will want the user to be working with the latest
  326. version.  WWIV bases all of its menu version decisions on
  327. the RIP_MENU_DATE line in WWIV.INI, so you need to change
  328. that line to make it equal to today's date.  Then go into
  329. your RIP menus directory and update *all* of your RIPEXT.MN?
  330. files to today's date.  You can do this by using the TOUCH
  331. command if you have Turbo C++ or Borland C++; or by opening
  332. each RIPEXT.MN? file in your text editor and saving it.
  333.  
  334.      Once that step is complete, anyone who calls will
  335. receive the latest updated menus.  Only those files which
  336. have been changed will be sent, so the process should be
  337. relatively quick and painless.
  338.  
  339.  
  340. 5.3  Icons
  341.  
  342.      The *.IC? icons can be modified with a program like
  343. MAKEICN; and the *.BM? icons can be edited with any Windows
  344. paint program.  Be sure to have a BM icon for each IC icon,
  345. and vice versa.
  346.  
  347.  
  348. 5.4  Logon, Logoff, Editor, and Door Screens
  349.  
  350.      These logon/logoff screens and external editor/door
  351. menus are .RIP files in your language directory, and all of
  352. them can be edited using the same techniques as the
  353. downloadable menus.  However, you do not need to update any
  354. of the BBS or menu date information, since these menus are
  355. not downloaded by the user.  Note that you may see strange
  356. characters and/or numbers on some of these menus.  These are
  357. substitution codes which are replaced by BBS info such as
  358. the system name.
  359.  
  360.  
  361. 5.5  Other Menu Screens
  362.  
  363.      Most of the non-downloadable menu screens are held in
  364. the MENUSLCL.MSG and MENUSSOF.MSG files.  MENUSLCL.MSG holds
  365. all of the locally-stored menus for normal RIP-compatible
  366. terminal programs; and MENUSSOF.MSG contains an entire menu
  367. set for less-compatible RIP terminal programs like Softerm.
  368.  
  369.      These .MSG files are arranged much like the
  370. MENUSANS.MSG ANSI menu file.  Multiple menus are stored
  371. together, delimited by lines like the following:
  372.  
  373. `330===================================================
  374.  
  375.      The number after the back-quote corresponds to the menu
  376. number.  To edit an individual menu in this file, open it up
  377. with your text editor, do a block copy of the text between
  378. headers, and paste this text into a new file.  For example,
  379. to edit menu 330, find the "`330===" line, and copy
  380. everything between it and the "`331===" line.  (Don't
  381. include the headers themselves.)  Now paste it into a
  382. TEMP.RIP file and edit the file.  When you are satisfied,
  383. load up the TEMP.RIP file in your text editor, copy it to
  384. the clipboard, and paste it over the old lines in
  385. MENUSLCL.MSG or MENUSSOF.MSG.
  386. 6                  Adding New Menu Styles
  387.  
  388.  
  389. 6.1  Creating the New Menu Set
  390.  
  391.      If you wish to expand beyond the basic set of six menus
  392. included with WWIV, first decide on a menu extension (any
  393. letter or number you'd like, perhaps "7").  The simplest way
  394. to begin is to copy one of the existing sets.  If you want
  395. to use the MN6 menus as a template, you can COPY *.??6
  396. *.??7.
  397.  
  398.      Now use a text editor's search-and-replace function in
  399. each of the new .MN7 menus, changing all references to
  400. ".IC6" to ".IC7".  The menus should be ready for editing
  401. with a RIP draw program.
  402.  
  403.      Once your menu set is complete, you need to let your
  404. users know it exists for them to download.  In MENUSLCL.MSG,
  405. you will find menu #350, which is the menu selection screen. 
  406. You need to edit this with either a RIP drawing program, or
  407. a standard text editor.  (Both procedures are described
  408. below.)  Finally, you need to update the BBS menu date
  409. information, as described above in section 5.2.
  410.  
  411.  
  412. 6.2  Editing Menu #350 with a RIP Drawing Program
  413.  
  414.      If you are using a RIP drawing program, you can easily
  415. create a new button for your menu style #7.  Set it to
  416. return a "7" when pressed.  You will probably want to assign
  417. a "hotkey" to the new button, so users can select the menu
  418. from the keyboard.
  419.  
  420.  
  421. 6.3  Changing Menu #350 with a Text Editor
  422.  
  423.      If you prefer to use a text editor, you will need to
  424. know something about the information in the RIPscrip file. 
  425. You will see a segment of menu #350 which looks like:
  426.  
  427. !|1U5C3E5Q3O2B00<>Simplified<>1|1U5C425Q4C1Y00<>Full<>2
  428. !|1U5C4Q5Q501W00<>Drop-Down<>3|1U5C5E5Q5O2F00<>Windows 95<>4
  429. !|1U5C625Q6C2500<>Macintosh<>5|1U9R3EA53O2700<>OS/2<>6
  430. !|1U9R63A56D2600<>None<>0
  431.  
  432.      Each of the first three lines corresponds to two
  433. labeled buttons in the dialog box.  The first button,
  434. labeled Simplified, will return a 1 when pressed; this will
  435. select menu extension .MN1.  The second button, Full-Screen,
  436. is set to .MN2.  Similarly, Drop-Down is .MN3, and so forth.
  437.  
  438.      The layout for each button is fairly simple.  RIP uses
  439. base-36 arithmetic (0-9, A-Z), and the basic format is as
  440. follows:
  441.  
  442. !|1U     5C 3E 5Q 3O 1Y  00<>  Simplified<>  1
  443.    |      |  |  |  |  |        |             |
  444.  button  x1 y1 x2 y2 hot     title          key(s)
  445.   code               key                   returned
  446.  
  447. Here are the hotkey codes, translated to base-36:
  448.  
  449. A = 1T      B = 1U      C = 1V      D = 1W      E = 1X
  450. F = 1Y      G = 1Z      H = 20      I = 21      J = 22
  451. K = 23      L = 24      M = 25      N = 26      O = 27
  452. P = 28      Q = 29      R = 2A      S = 2B      T = 2C
  453. U = 2D      V = 2E      W = 2F      X = 2G      Y = 2H
  454. Z = 2I
  455.  
  456.      If you have French menus as .MN7, your new dialog may
  457. look something like the following (if I have my French
  458. correct, at least):
  459.  
  460. !|1U5C3E5Q3O1Y00<>Francais<>7
  461. !|1U9R63A56D2900<>Quitter<>0
  462.  
  463.      Note that the hotkeys have been set to "F" and "Q".
  464. 7               RIP and Non-English Languages
  465.  
  466.  
  467.      RIPscrip is a graphical user interface standard, so it
  468. seems logical that it should fairly easily support other
  469. languages.  This is indeed the case, although the process
  470. can seem intimidating because of the sheer number of menus
  471. in each set.
  472.  
  473.      The first step is to copy all of the non-downloadable
  474. RIP files into your new language directory.  These are your
  475. WELCOME.RIP, HELLO.RIP, GOODBYE.RIP, and NEWUSER.RIP files,
  476. any DOOR*.RIP and EDITOR*.RIP files, and MENUSLCL.MSG and
  477. MENUSSOF.MSG.  Of course, it is assumed that you have
  478. already copied your language.STR and ANSI/TTY menus into the
  479. new directory.
  480.  
  481.      Next, go into your RIP menus directory and choose one
  482. of the existing menu styles to translate to a new language. 
  483. Pick a letter or number (other than the numerals 1-6, which
  484. are already used) for your new menu set.  Then copy all of
  485. the existing menu files to a new file extension.  For
  486. example, if you were starting with menu set 6, the OS/2
  487. menus, and were creating a new menu set "F" (for "French"),
  488. you would COPY *.??6 *.??F.  All of the *.IC6, *.MN6, and
  489. *.BM6 icon files will be copied to *.ICF, *.MNF, and *.BMF
  490. extensions.  Next, use your text editor to open up each of
  491. the *.MNF files and search and replace ".IC6" with ".ICF",
  492. so all icon references point to *this* menu set's icons.
  493.  
  494.      Now you can begin translating the text strings in each
  495. of your *.MNF (or whatever menu extension you chose) menu
  496. files.  You may find it simpler to open the menu files with
  497. a text editor to change the text, rather than using a RIP
  498. paint program; but either method is acceptable.  See section
  499. 5.2 for more information on editing the files.
  500.      Once your downloadable RIP menu set is complete, you
  501. can go back to your language directory and begin changing
  502. its menu files.  The *.RIP files are fairly simple to
  503. change, using the method outlined above.
  504.  
  505.      The MENUSLCL.MSG and MENUSSOF.MSG files are somewhat
  506. more complex, because each of them is a composite of many
  507. individual menus.  You can use a text editor to fairly
  508. translate all prompts; but if you wish to use a RIP draw
  509. program, you need to copy out each individual menu to a
  510. separate file, edit it in your draw program, and paste it
  511. back in.  This process is outlined in section 5.5.
  512.  
  513.      Finally, you will want to change menu #350 in
  514. MENUSLCL.MSG.  This is the menu style selection screen, and
  515. it can be different for each language.  You will probably
  516. want to remove all of the English-language options from the
  517. dialog box, replacing them with links to your new menu
  518. styles.  The full procedure for adding menus is outlined in
  519. chapter 25.
  520. 8                    Random RIP Screens
  521.  
  522.  
  523.      As with the ANSI WELCOME screens, you can have the BBS
  524. randomly choose a RIP logon or logoff screen.  The files
  525. WELCOME, GOODBYE, HELLO, and NEWUSER may all be randomized
  526. selected.
  527.  
  528.      The method of assigning filenames is nearly identical
  529. to that of assigning random ANSI screens.  Give the first
  530. RIP screen an extension of .R0; the second, .R1; and so
  531. forth, up to .R99.  You can have WELCOME.R0 - WELCOME.R99,
  532. GOODBYE.R0 - GOODBYE.R99, etc.
  533. 9               Taking Advantage of Hypertext
  534.  
  535.  
  536. 9.1  Hyperlinks
  537.  
  538.      One of the most unique features of RIPspeed is its
  539. support for hyperlinks.  You can use this feature to make
  540. World Wide Web-like documents on your own BBS.  (Since BBS
  541. network connections are not "live," you cannot create
  542. hyperlinks to other BBS systems.  However, you *can* create
  543. links to documents on the user's machine.)  Hyperlinks can
  544. only extend to files within your RIP menu directory or the
  545. user's RIPterm menus directory; so there is no compromise in
  546. security.
  547.  
  548.      Any RIP file can be a hypertext document.  The key is
  549. to add one or more buttons which can link the user to other
  550. "pages."  This is achieved by returning an ASCII 5 followed
  551. by a filename and terminating carriage return.  In order to
  552. do this in RIPscrip, assign the button the following return
  553. value to a button:
  554.  
  555.      ^E{filename}^M
  556.  
  557. where ^E corresponds to ASCII 5, {filename} is the name of
  558. your linked file, and ^M becomes a carriage return.  A link
  559. to the file HOME.RIP can be created by assigning
  560. "^Ehome.rip^M" (no quotes) to a button in your document.
  561.  
  562.  
  563. 9.2  Creating Documents
  564.  
  565.      A sample set of hypertext documents is available from
  566. The Griffon's Lair at (707) 526-2184, in the file
  567. SAMPHTXT.ZIP.  The file should be PKUNZIPped into your RIP
  568. menus directory.
  569.  
  570.      When the user clicks on the Hypertext! option from the
  571. RIP main menu, the file hypertext HOME.RIP will be
  572. displayed.  It contains links to other documents, and all
  573. other documents eventually link back to the "home page."  It
  574. is recommended that you always use HOME.RIP as your starting
  575. and return point for all hypertext documents.  This will
  576. allow your users to activate the hypertext system with the
  577. Hypertext! command, and will give them a familiar place of
  578. origin.
  579. 10                   Substitution Codes
  580.  
  581.  
  582.      Although they are not limited to the RIP subsystem in
  583. WWIV, the new substitution (a.k.a. "MCI") codes in this
  584. version give you considerable flexibility in creating menus
  585. and messages.  Your BBS can display dynamic information with
  586. these codes.
  587.  
  588.      Substitution codes are placemarkers which are inserted
  589. into menu or message files; when the BBS is displaying these
  590. files, it replaces the codes with specific information. 
  591. These codes allow you to insert the current date and time,
  592. BBS name, user information, and other important data into a
  593. file.  You can now provide status information in your logon
  594. message, or create menu files which integrate your BBS name
  595. into them.
  596.  
  597.      Several of the RIP menus take advantage of this
  598. feature.  All log-on and log-off screens, as well as the
  599. "Your Information" dialog box, use substitution codes to
  600. display the information.  Note, however, that *downloadable*
  601. menus cannot use substitution codes.  The user's terminal
  602. program is incapable of translating these codes into
  603. relevant information.
  604.  
  605.      The substitution code indicator is a sequence of two
  606. ASCII 15's, followed by a letter.  ASCII 15 corresponds to
  607. Ctrl-O, which is a key used by most WWIV editors for Online
  608. Help - this is intended as a safety feature to prevent
  609. embedded characters from ever being mis-translated as
  610. substitution codes.
  611. 10.1 Entering Codes
  612.  
  613.      In order to create a document with substitution codes,
  614. you need to use WWIV's internal line editor, DOS's EDIT.COM,
  615. or a similar text editor.
  616.  
  617.      Currently, WWIVedit and other WWIV-based full screen
  618. editors do *not* support entering of substitution codes.  If
  619. you wish to enter a substitution code in WWIV's internal
  620. editor, hit [Ctrl]-[P] (the "color code" key combination)
  621. *twice*, followed by the letter corresponding to your code. 
  622. The code should be immediately translated on-screen.
  623.  
  624.      If you use DOS EDIT, you need to hit [Ctrl]-[P] [Ctrl]-
  625. [O] [Ctrl]-[P] [Ctrl]-[O], followed by a letter.  (The
  626. [Ctrl]-[P] indicates to DOS that you will be sending it a
  627. "printer code," i.e. a keystroke it should not translate
  628. into a command.)  You will not see the results of the code.
  629.  
  630.  
  631. 10.2 Substitution Codes 
  632.  
  633. Code are ASCII 15, ASCII 15, followed by:
  634.  
  635. ~ = E-mails+fbks     / = Today's Date       % = Time left
  636. # = User number      $ = File points        * = WWIV reg num
  637. - = A** points       ! = Pause command      & = RIP/ANSI/TTY
  638. @ = Dir name         : = Sub #              ; = Dir #
  639. A = User age         a = User language      B = Birthday
  640. b = Min. in timebank C = User city          c = User Country
  641. D = Files downloaded d = User DSL           E = # E-mails
  642. e = Net E-mails sent F = Feedbacks sent     f = First call
  643. G = MessaGes read    g = Gold               I = callsIgn 
  644. i = Illegal log-ons  J = Message conf name  j = Dir conf.
  645. K = Kb uploaded      k = Kb downloaded      L = Last call
  646. l = Number of logons M = Mail waiting       m = # Messages
  647. N = User's name      n = Sysop's note       O = calls tOday
  648. o = Minutes on       P = BBS phone          p = User phone
  649. R = User's real name r = Last baud rate     S = User's SL
  650. s = User's street    T = User's sTate       t = Time
  651. U = Files uploaded   V = # messages in sub  X = User seX
  652. Y = Your BBS Name    y = User Computer tYpe Z = User Zip
  653.  
  654.  
  655. 10.3 Sample LOGON.MSG File
  656.  
  657.      This sample file will display user-specific information
  658. during logon.  Note that the "^O"s in this sample file need
  659. to be replaced by ASCII 15's using one of the methods
  660. outlined above.  If you are extracting this file to test it,
  661. use EDIT to run a search-and-replace of ^O with [Ctrl]-[P]
  662. [Ctrl]-[O].
  663. ************************************************************
  664. ^O^OY, ^O^OP
  665. ************************************************************
  666. Information for ^O^OR, a.k.a. ^O^ON ^O^O#:
  667.  
  668. Address:    ^O^Os
  669.                ^O^OC, ^O^OT ^O^OZ
  670.                ^O^Op
  671. You are ^O^OA years old, born on ^O^OB.
  672.  
  673. You have downloaded ^O^OkKB in ^O^OD files
  674.         and uploaded ^O^OKKB in ^O^OU files.
  675.  
  676. You are in ^O^O& mode.
  677. 11                    Special Features
  678.  
  679.  
  680. 11.1 Automatic Log-on of Users
  681.  
  682.      If the user is calling with a fully RIPterm-compatible
  683. terminal program, WWIV takes advantage of RIPterm's
  684. "database" to store the caller's name and phone number.  The
  685. BBS then requests this information during log-on.  Depending
  686. on whether RIPterm's "Data Security" feature is enabled or
  687. disabled, RIPterm will either automatically respond with the
  688. user's log-on information; or it will allow the user to
  689. confirm the response first.
  690.  
  691.      The user log-on information, if incorrect, can be
  692. changed through the Your Information (Y) command.
  693.  
  694.  
  695. 11.2 The AUTOEXEC.RIP File
  696.  
  697.      Similar to the AUTOEXEC.BAT file, this RIP file is
  698. processed once the user has first logged on.  RIP files can
  699. contain recorded keystroke combinations, so you can use this
  700. feature to automatically perform certain operations during
  701. logon, or to automatically start the user with a hypertext
  702. document, or to do many other things.
  703.  
  704.      There are two AUTOEXEC.RIP files which are supported: 
  705. one on the host BBS system, and one on the user's system. 
  706. The host's AUTOEXEC.RIP is first processed; then the user's
  707. copy.  This allows you to have a general setup for all
  708. users, then a specific one for individuals.
  709.  
  710.      You can create the following AUTOEXEC.RIP file for a
  711. user who wishes to go to the QWK mailer immediately upon
  712. login:
  713.  
  714. !|1&e0000//QWK^m
  715.  
  716. where &e is an embedded Escape character.  You can produce
  717. this character in DOS EDIT by hitting [Ctrl]-[P] [Esc].
  718.  
  719.      An AUTOEXEC.RIP which automatically put the user in the
  720. Hypertext home page would look like:
  721.  
  722. !|1&e0000^Ehome.rip^M
  723.  
  724.      In all cases, begin the file with !|, followed by an
  725. Escape, then four zeroes, then whichever keys should be sent
  726. to the BBS.
  727. 12                      Compatibility
  728.  
  729.  
  730.      WWIV with RIPspeed and RIPdrive has been tested in a
  731. number configurations, and has no known incompatibilities. 
  732. This chapter contains a list of some of the tested RIP
  733. terminal programs and operating systems.
  734.  
  735.      RIPspeed has been verified to work with the following
  736. RIP terminals:  RIPterm 1.54, RIPterm 2.00.01, Telix for
  737. Windows 1.01D, and Softerm 1.00.
  738.  
  739.      RIPdrive has been successfully used with the following
  740. operating environments:  MS-DOS 5.0 and/or 6.22 using
  741. EMM386, 386MAX, QEMM, BlueMax, Lynx, and Tame; OS/2 2.0,
  742. 2.1, and Warp 3.0 (in DOS mode); Windows 3.1, Windows 3.11,
  743. and Windows 95; and Linux 1.2.3 with DOSEMU 0.60.1 Alpha.
  744.  
  745.      I have been told that RIPdrive and/or WWIV have an
  746. undetermined compatibility problem with the MS-DOS SHARE
  747. utility (if SHARE is run without a multitasker).  According
  748. to the information I have received, SHARE causes abnormally
  749. slow BBS operation, and even occasional system lockups.
  750.  
  751.      If you experience a compatibility problem, please e-
  752. mail Zack Ives #3 @11729 with more information about the
  753. problem.  It is very likely that your configuration's
  754. compatibity problems can be solved.  If they cannot, a
  755. workaround can often be found until future revisions of WWIV
  756. or RIPdrive can address the incompatibility.
  757. 13                      RIP File List
  758.  
  759.  
  760. 13.1 Files in \WWIV
  761.  
  762. RIPDRIVE.EXE   (optional) RIPdrive loader program
  763. RIPDRIVE.OVL   (optional) RIPdrive overlay
  764.  
  765.  
  766. 13.2 Files in \WWIV\RIPMENUS or RIP menu directory
  767.  
  768. HOME.RIP       (optional) Hypertext home page
  769. IMAGE?.RIP     (optional) Hypertext sample images
  770. INTRO?.RIP     (optional) Hypertext sample intro to WWIV
  771. BOLD.CHR       (optional) RIPdrive font
  772. EURO.CHR       (optional) RIPdrive font
  773. GOTH.CHR       (optional) RIPdrive font
  774. LCOM.CHR       (optional) RIPdrive font
  775. LITT.CHR       (optional) RIPdrive font
  776. SANS.CHR       (optional) RIPdrive font
  777. SCRI.CHR       (optional) RIPdrive font
  778. SIMP.CHR       (optional) RIPdrive font
  779. TRIP.CHR       (optional) RIPdrive font
  780. TSCR.CHR       (optional) RIPdrive font
  781. NAME.M?        RIPterm 2.0 system name (created by BBS)
  782. NAME.MNU       RIPterm 1.54 system name (created by BBS)
  783. RIPEXT.MN?     Used to determine which menu set is selected
  784. MENU*.MN?      Menus including:
  785.        MENU0   WWIV Main Menu - Quick-redraw
  786.        MENU1   WWIV Message Base Commands
  787.        MENU2   Built-in Line Editor Command List
  788.        MENU3   Transfer Section Menu - Dialog portion
  789.        MENU4   Mail Reader Command List
  790.        MENU9   Batch Download Queue Commands
  791.       MENU12   Multi-mail Commands
  792.       MENU13   Sysop Message Base Commands
  793.       MENU14   Archive Commands
  794.       MENU17   File Tag Commands
  795.       MENU18   Extract Commands
  796.      MENU300   WWIV Main Menu, Full-Redraw
  797.      MENU301   WWIV Pull-Down Menus;
  798.         -309   MENU301-MENU304 are included with stock WWIV
  799.      MENU310   WWIV Transfer Menu, button-bar section
  800.      MENU311   Minimized WWIV Transfer Menu palette
  801.      MENU312   Door Menu
  802.      MENU313   Return from WWIV Transfer Section
  803.      MENU314   Chat Screen
  804.      MENU315   G-Files Menu
  805.      MENU316   Defaults Menu
  806.      MENU317   G-Files Sections Menu
  807.      MENU318   Transfer Defaults Menu
  808.      MENU319   Defaults/Transfer Defaults CLS Menu
  809.      MENU320   "Go Back" Screen
  810.      MENU321   Blank Button Bar
  811.      MENU322   About... Screen
  812.      MENU323   Q-Scan Configuration Screen
  813.      MENU324   Mail Waiting Screen
  814.      MENU326   Your Info Screen
  815.      MENU328   BBS Info Screen
  816.      MENU330   Yes/No Choice (default = Y)
  817.      MENU331   Yes/No/Quit Choice
  818.      MENU332   Pause/Nonstop/Continue
  819.      MENU333   Clear Pause Screen
  820.      MENU334   Size >10 bytes for full-screen menus *only*: 
  821.                  Reset window size, trigger [PAUSE]
  822.      MENU335   Clear Yes/No Choice
  823.      MENU336   No/Yes Choice (default = N)
  824.      MENU340   Help Screen
  825.      MENU360   Download Filename Dialog
  826.      MENU361   Upload Filename Dialog
  827.      MENU364   Extended Info Screen
  828.      MENU366   Time Bank
  829.      MENU368   QWKmail Menu, Normal User
  830.      MENU369   QWKmail Menu, Sysop
  831. I*.IC?         RIPterm 1.54 icons; vary by menu set
  832. I*.BM?         RIPterm 1.54 icons; vary by menu set
  833. MENUS.TXT      Message to user about menus
  834.  
  835.  
  836. 13.3 Files in WWIV\GFILES or language directory
  837.  
  838. WELCOME.RIP    Initial log-on screen
  839. NEWUSER.RIP    Log-on screen border for new users
  840. HELLO.RIP      Screen border for LOGON.MSG, last callers
  841. GOODBYE.RIP    Log-off screen border
  842. MENUSLCL.MSG   Locally stored (non-downloadable) menus
  843.      menu350   Download RIP Menus Selection Screen
  844.      menu351   Download RIP Menus Query Screen
  845.      menu355   Log-on Password Dialog
  846.      menu356   Sysop Password Dialog
  847. MENUSSOF.MSG   All menus for less-compatible RIP terminals
  848.      Includes all files under MENU*.MN?, plus MENUSLCL.MSG,
  849.      plus:
  850.      menu353   Log-on Name Dialog
  851.      menu354   Log-on Phone Dialog
  852. BBS.STR        BBS string file
  853. INI.STR        BBS string file for WWIV.INI names
  854. WWIVMAIL.RIP   WWIVmail/QWK screen (rename to DOORx.RIP)
  855. FSED.RIP       FSED screen (rename to EDITx.RIP)
  856. FEDIT.RIP      FEdit screen (rename to EDITx.RIP)
  857. WWIVEDIT.RIP   WWIVedit screen (rename to EDITx.RIP)
  858. DOOR?.RIP      (optional) Door menus         
  859. EDIT?.RIP      (optional) Editor menus
  860. 14               More of Zack Ives' Software
  861.  
  862.  
  863.      RIPspeed is currently the most widely known of my
  864. programs, but it is far from the only product I offer.  If
  865. you would like to create your own programs which, like WWIV,
  866. include support for local RIP graphics, I have two libraries
  867. specifically for that purpose.  I also have numerous
  868. utilities and other products.
  869.  
  870.  
  871. 14.1 Programs Available from Zack Ives
  872.  
  873. Night-IV 1.1:  program that takes Night Owl or other CD-ROM
  874.      with FILES.BBS files, and adds all files and
  875.      descriptions to WWIV Transfer Section.  You are free to
  876.      then put then in whatever conference you want. 
  877.      Includes script files for Night Owl 9, 10, and 11 CD-
  878.      ROMs.  Registration $5.00.
  879.  
  880. NetDel 1.02:  a MUST-HAVE for your offline-reader users. 
  881.      Allows the user to delete any posts or e-mail made
  882.      during the current session.  If you change subs around
  883.      and QWK replies end up in the wrong sub, now the user
  884.      can go in and remove them from the net.  Registration
  885.      $10.00.
  886.  
  887. RandFile 1.0:  quick, easy file randomizer.  Allows random
  888.      log-on screens, menu files, batch files, or just about
  889.      anything else.  Free program.
  890.  
  891. RIPspy 1.02:  the ultimate RIPscrip file viewer program, a
  892.      necessity for working on RIP menu screens.  Unlike most
  893.      viewers, supports virtually all of RIPscrip's commands: 
  894.      links to other files, text windows, pick lists,
  895.      clipboard, and much more.  Registration $10.
  896.  
  897. RIPdrive 1.00:  the ultimate developer's library for door
  898.      programmers!  This library/TSR package allows your
  899.      programs to support local display of RIPscrip(TM)
  900.      graphics in your doors!  Now, in addition to giving
  901.      your *callers* a graphical display, you can give one to
  902.      the sysop as well.  This package has been licensed by
  903.      Wayne Bell and WWIV Software Services for use with WWIV
  904.      4.24!  Private-use license $10; distribution license
  905.      $50.
  906.  
  907. RIPlocal 1.01:  if you would prefer *not* to have a TSR, but
  908.      would rather link in a library to your Turbo or Borland
  909.      C++ programs, this is the answer.  Code for RIPlocal is
  910.      100% source compatible with RIPdrive, giving you great
  911.      flexibility.  Private-use license $10; distribution
  912.      license $50.
  913.  
  914.  
  915. 14.2 Distributors
  916.  
  917.      All of these utilities are available through the SimTel
  918. Internet archives, accessible through 55 FTP sites including
  919. oak.oakland.edu and ftp.cdrom.com.
  920.  
  921.      BBS distributors are:
  922.  
  923.      The Griffon's Lair, (707) 526-2184
  924.      The Tool Shed, (303) 776-8776
  925.      Shadowlands, (707) 528-7987
  926.      Eagle's Dare, (301) 498-1984
  927.      Data Express, (617) 247-3387
  928.      OUTLAW BBS, (412) 378-8932
  929.  
  930.      I am always eager to add new distributors, so please e-
  931. mail if interested.
  932. 15                Suggestions and Inquiries
  933.  
  934.  
  935.      Questions and comments relating directly to the general
  936. functionality of the WWIV BBS system should be directed to
  937. Wayne Bell (Random #1 @1 WWIVnet) or to Filo (Filo #1 @4000
  938. WWIVnet).  However, any questions, comments, or suggestions
  939. regarding the RIP support, RIPdrive, or any Zack Ives
  940. product should be directed to me.  I am interested in any
  941. feedback you can give me.
  942.  
  943.      I can be reached at any of the following addresses:
  944.      Internet:  zack@pacific.pacific.net
  945.      WWIVnet:  Zack Ives #3 @11729
  946.      ICEnet:  Zack Ives #3 @7701
  947.      GrapeVine:  Zack Ives #3 @1
  948. 16                         Credits
  949.  
  950.  
  951. 16.1 Special Thanks to:
  952.  
  953. Robert Griffith, who first asked me to write a RIP mod for
  954. his WWIV 4.23 BBS, and who has been invaluable in the
  955. creation and testing of the product.
  956.  
  957. Will Crawford, for providing me with a WWW home page, and
  958. for helping me to iron out the wrinkles in RIPspeed.
  959.  
  960. All of my distributors, who have made it easy for me to
  961. continue developing programs without spending time trying to
  962. get them on the market.
  963.  
  964. The beta test team, who gave me the feedback I needed.
  965.  
  966. Bishop, who provided me with additional information
  967. regarding RIPdrive compatibility and memory managers.
  968.  
  969. Filo, who invited me to write the RIP support for WWIV.
  970.  
  971. Wayne Bell, who created the BBS program and the network we
  972. are all using.
  973.  
  974.  
  975. 16.2 Trademarks
  976.  
  977. Apple and Macintosh are trademarks of Apple Computer Corp.
  978.  
  979. Microsoft, Windows, and Windows 95 are trademarks of
  980.      Microsoft Corp.
  981.  
  982. IBM and OS/2 are trademarks of the International Business
  983.      Machines Corp.
  984.  
  985. RIPspeed, RIPspy, RIPdrive, RIPlocal, NetDel, and Night-IV
  986.      are trademarks of Zachary G. Ives.
  987.  
  988. RIPscrip, RIPterm, and RIPpaint are trademarks of Telegrafix
  989.      Communications, Inc.
  990.  
  991. Other product names are trademarks of their respective
  992.      companies.