home *** CD-ROM | disk | FTP | other *** search
/ Media Depot 5 / mediadepotvolume51993.iso / FILES / 21 / OH211A.ZIP / README.TXT < prev    next >
Text File  |  1996-07-17  |  24KB  |  514 lines
  1.                       Copyright 1996, Hyperion Softword
  2.  
  3.                     *************************************
  4.                     *      Orpheus 2, version 2.11      *
  5.                     *************************************
  6.  
  7.                 Comments and queries to:  Hyperion Softword,
  8.               535 Irene-Couture, Sherbrooke, QC J1L 1Y8, Canada
  9.                     tel/fax - 819-566-6296 (Rod Willmot)
  10.                        email - willmot@interlinx.qc.ca
  11.  
  12.  
  13.  
  14. Last revised: June 12, 1996
  15.  
  16.  
  17.     TABLE OF CONTENTS
  18. ==============================================================================
  19.  
  20.     Notice
  21.     Shareware
  22.     Acknowledgments
  23.  
  24.     Part I - Setup
  25.         1. Introduction
  26.         2. Installing Orpheus 2
  27.         3. Notes for Beta Testers
  28.  
  29.     Part II - A Look Around
  30.         4. What's New
  31.         5. What's Missing
  32.  
  33.     Appendix - How to Order
  34.  
  35.  
  36.  
  37.  
  38.                                  = Notice =
  39. :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  40.  
  41.   * For introductory tutorials please read MANUAL.TXT; unlike this file, it
  42.     is formatted to be easily printable.
  43.  
  44.   * 99% of the documentation for Orpheus 2 is in online Help.  (Press <F1> 
  45.     in OH.EXE for context-sensitive help from any menu, dialog, or other 
  46.     situation; you can also run OHHELP.EXE from the DOS prompt.)  
  47.  
  48.   * If you have projects developed with Orpheus 1.nn, you can use the
  49.     included utility OH1TO2.EXE to convert them to the new file formats
  50.     used by Orpheus 2.  See OH1TO2.TXT for more information.  Do not mix
  51.     up Orpheus 2 files with your old files!
  52.  
  53.  
  54.  
  55.  
  56.                                 = Shareware =
  57. :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  58.  
  59.   * Orpheus is currently distributed as shareware.  As an unregistered user
  60.     you are welcome to evaluate this copy for up to 30 days.  You may not
  61.     distribute anything you might create with Orpheus 2, in any way, without
  62.     purchasing a registered copy.  Documents created with an unregistered copy
  63.     invoke a warning message when performed by the Reader.
  64.  
  65.   * The price of Orpheus is $79 US, plus shipping.  Yes, you can register
  66.     with your credit card!  For full details please see "How to Order" at
  67.     the end of this file, or use the order form provided in REGISTER.TXT.
  68.     A small number of advanced features require purchase of Orpheus
  69.     Professional at $149 US; these are fully discussed in online Help.
  70.  
  71.   * If you purchased an earlier version of Orpheus you are entitled to an
  72.     upgrade.  Users who registered at the full current price of $79 US will
  73.     receive a free upgrade directly from me, as soon as Orpheus 2 is deemed
  74.     complete.  If you are unsure of your status and wish to know what an
  75.     upgrade will cost (if anything), give me a call.
  76.  
  77.  
  78.  
  79.  
  80.                              = Acknowledgments =
  81. :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  82.  
  83.   * Warm thanks to the beta testers who have contributed to the story
  84.     so far:  Ray Ballard, Andy Roberts, Wim Berden and the guys at ILS,
  85.     Joost van der Gaag.
  86.  
  87.   * Thanks in many tongues to all those who have worked on translations
  88.     of the Orpheus Reader:  Daniel Marois, Marc Coulombe, Jan Moens,
  89.     Jurgen Nijhuis, Paul de Kamp, Thorsten Glattki, Giovanni Calesini,
  90.     Jesus de Paula Assis, Ernesto Eduardo Casin, Alexander E. Gubin.
  91.  
  92.   * Special thanks to Daniel Coulombe at Synapse.
  93.  
  94.   * Orpheus uses the SPAWNO routines by Ralf Brown to minimize memory
  95.     use while shelling to DOS and running other programs.
  96.  
  97.  
  98.  
  99.                              = Part I - Setup =
  100. :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  101.  
  102. -----------------------
  103.     1. Introduction
  104. =======================
  105.     What is Orpheus?
  106.     System requirements
  107.     What can it do?
  108.     Windows version
  109.     Shareware...
  110.  
  111.     What is Orpheus?  Orpheus is a hypertext authoring system.  It is
  112. designed for the creation of compiled hypertext documents that can be read
  113. with the Orpheus Reader.  Registered users may distribute such documents
  114. (together with the Reader) any way they please:  on disk, over BBS systems and
  115. the Internet, or installed on a LAN.
  116.  
  117.     System requirements:  Orpheus runs on any IBM-compatible PC from
  118. the XT on up to the Pentium.  Orpheus is currently a DOS-based system,
  119. requiring DOS 3.1 or higher; it runs very happily under Windows and OS/2.
  120. The authoring program requires a hard disk and at least 512K of RAM; for
  121. best performance XMS is desirable.  The Reader can run on diskette, and
  122. survives on much less RAM.
  123.  
  124.     What can it do?  Orpheus 2 has a capacity of over 2 million linked
  125. nodes in a single document.  Text cards can be of any length.  Graphics
  126. support now includes SVGA modes, and you can display PCX, GIF, and FLI/FLC
  127. files.  Through script commands you can create a work that interacts
  128. exquisitely with the user.  You can modify the appearance and behavior of the
  129. Orpheus Reader so that it looks like it was custom-programmed for you.
  130.  
  131.     Windows version:  The code in Orpheus 2 was designed for easy portability
  132. to Windows-based programming.  As soon as Orpheus 2 is complete, I will begin
  133. work on a Windows version of the Reader.
  134.  
  135.     Shareware...  Yes, Orpheus 2 is shareware, as was Orpheus 1.  If you are
  136. not a registered user of Orpheus 2, you are welcome to evaluate it for up to
  137. 30 days; you are NOT permitted to distribute (in any way) works that you may
  138. have created with Orpheus 2.  The price of Orpheus 2 is $79 US, plus shipping.
  139. If I haven't provided ordering information in this release, please contact me
  140. by one of the methods given at the top of this file.  NOTE:  registered users
  141. of Orpheus 1.nn can receive an upgrade; please contact me.
  142.  
  143.  
  144.  
  145. -------------------------------
  146.     2. Installing Orpheus 2
  147. ===============================
  148.     Orpheus 1 users
  149.     Orpheus 2 "Interim Version"
  150.     Typical installation
  151.  
  152.     (For detailed installation instructions, please see MANUAL.TXT.)
  153.  
  154.     Orpheus 1 users:  If you have used Orpheus 1 in the past, be sure to
  155. install Orpheus 2 in a completely different directory.  The only "contact"
  156. between the versions should be via the Converter, OH1TO2.EXE, if you intend
  157. to convert your old projects to the new system.
  158.  
  159.     Orpheus 2 "Interim Version" users:  do as above.  The file formats of
  160. the "real" Orpheus 2 (this one) bear no similarity to the Interim Version.
  161. User the Converter to change your Interim projects to the new system (see
  162. OH1TO2.TXT).
  163.  
  164.     Typical installation:  Place your Orpheus 2 files into a directory of
  165. their own on your hard drive, such as:
  166.  
  167.             C:\OH2
  168.  
  169. From now on you can use that location as your "working directory" for all
  170. of your projects.  For example, in DOS you would switch to that directory
  171. and start up OH.EXE with the command "OH"; your projects would be based in
  172. that directory, with their files all stored in subdirectories created for
  173. you by Orpheus.  See below in this file for discussion of starting a new
  174. project and loading an existing project.
  175.  
  176.  
  177.  
  178. ---------------------------------
  179.     3. Notes for Beta Testers
  180. =================================
  181.     Memcheck
  182.  
  183. Check out UPDATE.TXT for a list of changes, fixes, and new features.
  184.  
  185. Memcheck
  186. ============
  187. Beta versions of Orpheus now incorporate the Memcheck debugging tool
  188. from StratosWare Corporation.  Besides helping you discover bugs, Memcheck
  189. will protect your work and your system from unexpected behavior.  To activate
  190. Memcheck your DOS environment must include the MEMCHECK variable, which is
  191. done by giving the following command at the DOS prompt, =before= running
  192. OH.EXE:
  193.  
  194.     SET MEMCHECK=1
  195.  
  196. This command can be placed in your autoexec.bat file, or in a batch file
  197. used only for running the beta.  The following batch file could be named
  198. OH2.BAT or BETA.BAT, and would optionally pass a project-name parameter to
  199. Orpheus:
  200.  
  201.     SET MEMCHECK=1
  202.     OH %1
  203.     SET MEMCHECK=
  204.  
  205. The last command removes the MEMCHECK variable from your DOS environment,
  206. and can also be given manually.  Whenever Memcheck encounters a serious
  207. memory-related error while you are running OH.EXE, a message box will
  208. pop up reporting the problem.  Please note what the message says, along
  209. with some indication of what you had been doing before the error occurred.
  210. When you press a key to clear the message, Orpheus will safely exit.
  211.  
  212. I find that debugging is especially convenient under Windows, i.e. in a
  213. DOS box.  If the program appears to freeze -- no disk activity, no
  214. response to the keyboard -- you can safely terminate it using the Windows
  215. trick of pressing Alt-Space, selecting "Settings", then "Terminate".
  216.  
  217. NOTE:  Memcheck code is also present in the Simulator and the Reader, but
  218. not in Help.  Does this have any bearing on whether you can distribute a
  219. beta version of the Reader to your users?  None at all.  Unless they
  220. themselves set the MEMCHECK variable on their systems, the Memcheck code
  221. does not run.
  222.  
  223.  
  224.  
  225.  
  226.                          = Part II - A Look Around =
  227. :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  228.  
  229. ---------------------
  230.     4. What's New
  231. =====================
  232.     Ascii file format
  233.     Scrollable text
  234.     Better linking
  235.     System capacity
  236.     Better compiling
  237.     Improved compression
  238.     Simpler Reader
  239.     Customize Reader interface
  240.     Disable Reader elements
  241.     Selector keys in Reader
  242.     Extended graphics support
  243.     Hotspots improved
  244.     Menu() command
  245.     Ask() command
  246.     Run() & Runbat() improved
  247.     Data Fields
  248.     Color schemes
  249.     The Simulator
  250.  
  251.  
  252.     * Ascii file format:  Uncompiled cards are now plain text files.  This
  253. means that you can create them with any text editor, though more commonly
  254. you'll switch into ascii mode (within OH.EXE) for plain-text editing.  In
  255. ascii mode you can see the link codes and edit them manually (it's easy).  The
  256. great advantage of the new file format:  if something goes wrong, you can fix
  257. it.  In Orpheus 1 the files were semi-binary, and trouble meant trouble.
  258.  
  259.     * Scrollable text:  Text cards can be scrollable if you wish, with no
  260. restriction on length.  Many users of Orpheus 1 liked the screen-sized cards,
  261. and you can still use them if you don't like scrolling, or limit scrolling
  262. to particular cards.
  263.  
  264.     * Better linking:  First, link numbers now correspond in a perfectly
  265. obvious way to the filenames of the cards they point to.  Second, linking
  266. itself is more flexible, and as mentioned above, easy to do manually in the
  267. rare cases when you need to.  Crosslinks (as a link type) are toast; now you
  268. can link anywhere as often as you want, using the standard link types.  There
  269. are several new link types, including Exit links (actions to perform when a
  270. user leaves a card), Private links (they don't go into the finished product),
  271. Report links (to print instead of the card shown onscreen), and more.  Orpheus
  272. two extends the use of link codes to handle embedded labels and hilites; both
  273. dress up the text with color, and labels can also be used as link targets.
  274.  
  275.     * System capacity:  The new system is built to handle over 2 million
  276. unique nodes, i.e. individual linked cards, of which Text cards can be of
  277. any length.  Finished products are designed for extremely fast performance
  278. in the Reader, no matter how large the work.
  279.  
  280.     * Incremental compiling:  The old system combined all phases of finished-
  281. product-making into one process, which you had to repeat from the beginning
  282. if an error was encountered.  Orpheus 2 separates "building" into three
  283. stages:  compiling cards into their individual finished, compressed form,
  284. in which they are stored in CMP files; verifying the links to all possible
  285. cards in the work, starting from the Homecard; assembling all compiled cards
  286. (and other elements) into a finished product.  The first stage, compilation,
  287. can now be performed incrementally; once a given card has been compiled you
  288. no longer have to recompile it, no matter how often you compile new cards
  289. or assemble versions of the finished product.  This is a huge time-saver.
  290.  
  291.     * Improved compression:  Finished products are now significantly smaller
  292. than under Orpheus 1, particularly if you take advantage of the ability to
  293. use scrollable text (as opposed to stringing together many screen-sized
  294. cards using "More" links).  Along with this there is better security:  whereas
  295. an HTX compiled with Orpheus 1 could be deciphered without difficulty, and
  296. certain parts could be left in plain text, under Orpheus 2 an HTX file looks
  297. like 100% binary garbage.  Any part too small to compress efficiently is
  298. encrypted.
  299.  
  300.     *Improved distribution:  In terms of finished output, the old system
  301. produced a small HTX file with at least one numbered subfile; subfiles were
  302. limited to 64K.  Orpheus 2 lets you set the maximum filesize up to 1 megabyte,
  303. which includes the HTX file.  This means you can now assemble most projects
  304. into *one* file, the HTX, for simpler distribution.  (With Orpheus
  305. Professional you can assemble into a self-reading EXE with *no* other files.)
  306.  
  307.     * Simpler Reader:  The old Reader had a number of automatic features that,
  308. while intended to be friendly, could be troublesome.  For example, the user
  309. could always open the menu system and shell to DOS, which could be dangerous
  310. if the Reader was being used on a BBS.  Currently the Reader for Orpheus 2
  311. is still "missing" the odd feature that made the old one stand out, but it's
  312. clear that =authors= will be happy that the Reader no longer forces it on
  313. them.  In keeping with this, whenever I add an interface-related feature to
  314. the Reader I will make it possible for authors to hide or disable it.  See
  315. online Help:  Contents->Orpheus Utilities->The Reader->Feature Set.
  316.  
  317.     * Customize Reader interface:  You can customize the Reader interface
  318. (primarily as evidenced in text mode) in a number of ways.  Open the Project
  319. Menu, select Project Options, then dig into the Screen Layout dialog.  Read
  320. online Help about this and about making command buttons.  You can make an
  321. interface all your own; an example is Help itself, which is NOT hard-coded
  322. into the Help engine, rather it was set up as the Help project's layout, and
  323. you can do the same with your own projects.
  324.  
  325.     * Disable Reader elements:  All of the built-in Reader elements (such as
  326. the menu system) can be disabled through the Project Options dialog.  You can
  327. also disable the hotkeys (like the one to exit the Reader) and force the user
  328. to do things through your own popup menus and/or command buttons.
  329.  
  330.     * Extended graphics support:  Orpheus 2 now supports SVGA graphics up
  331. to mode 29.  You can display GIF graphics as well as PCX, and I've added
  332. support for animation using FLI/FLC files.
  333.  
  334.     * Hotspots improved:  Hotspots now are drawn as convex polygons rather
  335. than blocky shapes; the new method gives you the same resolution as the
  336. image onscreen, making for real precision.  In addition, hotspots can be
  337. "linked" to a sequence of script lines immediately following a hotspot
  338. command; you are no longer limited to linking hotspots to other cards.
  339.  
  340.     * Menu() command:  the new script command menu() lets you display a
  341. popup menu; you can respond to the user's menu selection to call various
  342. internal Reader functions, to perform other script commands, or to initiate
  343. a hypertext jump.
  344.  
  345.     * Ask() command:  the new script command ask() lets you display a popup
  346. dialog, similar to a standard Orpheus dialog.  You can respond to the user's
  347. selection with the same flexibility as described above for the menu() command.
  348.  
  349.     * Run() & Runbat() improved:  control whether the Reader swaps itself out
  350. before performing the command (e.g. if you're launching a very large external
  351. program you'd want the Reader to swap out).  You can also control whether the
  352. Reader clears the screen; this lets you use these commands for special effects
  353. while displaying graphics.
  354.  
  355.     * Color schemes:  Colors are now stored for three video standards -- mono,
  356. grey-scale, and color -- and if you have all three available while working you
  357. can select your own schemes for each and keep them in a single CFG file.
  358. The colors active on your system when you assemble a finished product are
  359. built into the HTX.  If you selected "Your colors" in Project Options, the
  360. user sees your work first in your colors; otherwise the default colors appear.
  361. However, if the user has a Reader CFG file present, he sees with his own
  362. colors, but can still call yours through the Color Dialog -- if you give him
  363. access to it.
  364.  
  365.     * The Simulator:  As a complement to incremental compilation, Orpheus 2
  366. gives you a way to experience your work as if you were seeing it in the
  367. Reader, but without having to produce a finished copy of it.  The Simulator
  368. works with CMP files (described above) -- the stored compiled forms of your
  369. individual cards.  The Simulator lets you test scripts realistically, and is
  370. the environment you'll use for drawing hotspots.
  371.  
  372.  
  373. -------------------------
  374.     5. What's Missing
  375. =========================
  376.  
  377. A number of useful features that were in Orpheus 1.65 haven't been plugged
  378. in yet; a few are now obsolete and won't be.
  379.  
  380. Currently the graphic file formats supported are SPR, PCX and GIF, with
  381. FLI/FLC for animation.  I should be able to add the new PNG format as
  382. soon as I can get the code.  Many Orpheus 1 users took advantage of the
  383. ability to store graphics etc in library files; Orpheus 2 will replace
  384. this by optionally including them in the actual finished document.  It
  385. will be a whole lot easier, simplifying script commands and eliminating the
  386. need to figure out a library-management program.  It's all designed, just
  387. not coded yet!  Look for INCLUDE on the Project Menu, in future releases.
  388.  
  389. Missing from the Reader currently are some of the gadgets that were in
  390. Orpheus 1.65:  a Bookmark dialog, a Tour capability, the ability to shell
  391. to DOS (universally disliked by authors).  The Reader now includes Print
  392. and Color dialogs, a Notepad (superior to the old one), and a simpler menu
  393. system.  A new and extremely powerful feature is full-text search, as
  394. illustrated in online Help; this one requires use of the Indexer and an
  395. Orpheus Professional licence.
  396.  
  397.  
  398.  
  399.  
  400.                          = Appendix - How to Order =
  401. :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  402.  
  403. The following order form is also provided separately in REGISTER.TXT.
  404.  
  405.  
  406.                                    ORDER FORM
  407.  
  408.     Please send me a registered copy of the latest version of Orpheus.
  409.     I understand that I will receive a Licence granting me the right to
  410.     sell, give away, or otherwise distribute any compiled electronic works
  411.     that I create with Orpheus, along with the Orpheus Reader.  In accepting
  412.     this Licence I agree not to compile and distribute works created by
  413.     others using shareware copies of Orpheus.
  414.  
  415.  +=====+======================================================+=======+=======+
  416.  | Qty |                 Product Description                  | Price | Total |
  417.  +=====+======================================================+=======+=======+
  418.  |     |                                                      |       |       |
  419.  |     |            Orpheus 2 (Standard Version)              |  $79  | _____ |
  420.  +-----+------------------------------------------------------+-------+-------+
  421.  |     |                                                      |       |       |
  422.  |     |          Orpheus 2 (Professional Version)            | $149  | _____ |
  423.  +-----+------------------------------------------------------+-------+-------+
  424.  |     |          Upgrade to Orpheus Professional             |       |       |
  425.  |     |          My registration #:_____________________     |  $70  | _____ |
  426.  +-----+------------------------------------------------------+-------+-------+
  427.  |      Need a site licence or custom Reader?  Call 1-819-566-6296.   |   -   |
  428.  +--------------------------------------------------------------------+-------+
  429.  |                                                     Canada.....$2  |       |
  430.  |                Shipping (1st Class air)      United States.....$3  |       |
  431.  |                                                  All other.....$6  | _____ |
  432.  +====================================================================+=======+
  433.                   *** Prices are in US dollars ***             Total  | _____ |
  434.                                                                       +=======+
  435.  
  436.     Name:    ________________________________________________
  437.     Address: ________________________________________________
  438.              ________________________________________________
  439.              ________________________________________________
  440.     Phone:   (work)_________________  (home)_________________
  441.     Fax:     ______________________
  442.     Email:   ________________________________________________
  443.  
  444.     Preferred disk format:  [ ] 3.5-inch (1.44M)    [ ] 5.25-inch (1.2M)
  445.                             [ ] 3.5-inch (720K)
  446.  
  447.     Method of payment:  [ ] check or money order enclosed
  448.                         [ ] purchase order # ____________________
  449.                         [ ] credit card (see below)
  450.  
  451.       *Canadian and overseas orders MUST be in US dollars, OR the equivalent
  452.        value in Canadian dollars according to the exchange rate when ordering.
  453.        Example for April 1996 (73%): $109 Cdn = $79 US; $205 Cdn = $149 US.
  454.  
  455.     I have Version ____ of Orpheus, obtained from: ___________________________
  456.  
  457.     Comments: ________________________________________________________________
  458.               ________________________________________________________________
  459.  
  460.  
  461.                                Hyperion Softword
  462.                                535 Irene-Couture
  463.                                Sherbrooke, QC J1L 1Y8
  464.                                CANADA
  465.  
  466.      *** U.S. customers:  Please use extra postage on mail to Canada. ***
  467.  
  468.  ============================================================================
  469.                            * Credit Card Orders *
  470.  ============================================================================
  471.  
  472. The following information tells you how to purchase Orpheus by credit card.
  473. Credit card orders are processed by a company named Public Software Library,
  474. located in Houston, Texas (USA).  As soon as it receives your order, PSL sends
  475. me a fax with your name and address, and I mail you your registered copy of
  476. the latest version of Orpheus.  From then on you are my customer, and will
  477. deal with me directly for information, technical support, and upgrades.
  478.  
  479. If you need INFORMATION about Orpheus, call Hyperion Softword, not PSL!
  480. PSL cannot tell you anything about Orpheus, but I certainly can.  You can
  481. reach Hyperion Softword at 819-566-6296 (email: willmot@interlinx.qc.ca).
  482.  
  483.  
  484. ===============================================================================
  485. Credit card order of Orpheus (PSL #11142) from Public Software Library:
  486.  
  487. Fax:   713-524-6398
  488. Voice:   713-524-6394
  489. CIS:  71355,470
  490. Post:  Public Software Library, P.O. Box 35705, Houston, TX 77235-5705, USA.
  491.  
  492.       * Please enter your name as it appears on your card *
  493.  
  494. Name:
  495. Address:
  496.  
  497.  
  498. Telephone:
  499.  
  500. I wish to order:  [ ] Orpheus 2, standard version: $79
  501.                   [ ] Orpheus 2, professional version: $149
  502.                   [ ] Upgrade to Orpheus Professional: $70
  503.                       My registration #:____________________
  504.  
  505. Credit card:  [ ] Visa    [ ] Mastercard    [ ] American Express
  506.               [ ] Discover
  507.  
  508. Card number: _________________________________ Expiry: ________________
  509.  
  510. Signature: ____________________________________
  511.  
  512. ===============================================================================
  513.  
  514.