home *** CD-ROM | disk | FTP | other *** search
/ Fujiology Archive / fujiology_archive_v1_0.iso / !MAGS / !BONUS / COVERDSK / STFORMAT / STF24.ZIP / STF24.MSA / REVENGE_DISPLAY.TXT < prev    next >
Text File  |  1991-02-17  |  19KB  |  490 lines
  1.         
  2.                         The Revenge Document Displayer
  3.         
  4.                           Written by The Hitchhiker
  5.         
  6.                        Version 2.01 - 17th February 1991
  7.         
  8.         
  9.         
  10.                 The Hitchhiker's Guide to The Document Displayer
  11.                 ------------------------------------------------
  12.                          (Apologies to Douglas Adams)
  13.         
  14.         
  15.         
  16.         Welcome to The Revenge Document Displayer.  In this document I 
  17.         will try to explain how to get the most from the program.
  18.         
  19.         The Revenge Document Displayer will load, display and print out 
  20.         any ASCII document.  When you load a document any control 
  21.         characters will be automatically stipped out so that it is more 
  22.         readable.
  23.         
  24.         To view a document with the displayer double click on 
  25.         DISPLAY.PRG.  The program will now load and ask you to select 
  26.         the file that you want to load.  Once you have selected a file 
  27.         the display will load and format the text before going into 
  28.         display mode.  If you always want to use the displayer to view 
  29.         doc files, then you can install it as an application so that it 
  30.         loads whenever you double-click on a doc file.  When the 
  31.         displayer has loaded, the files that you selected will be 
  32.         automatically loaded.  Consult the Atari ST manual on how to use
  33.         this feature of the desktop.
  34.         
  35.         
  36.         
  37.         Packed Files
  38.         ------------
  39.         
  40.         If you load a file that has been packed, the displayer will 
  41.         automatically de-pack it.  Packers supported:
  42.         
  43.                                         Pack Ice v2.20
  44.         
  45.         To pack a file using the Ice packer:
  46.         
  47.         1)  Double click on ICE_2_2.PRG
  48.         2)  Click on DATA.
  49.         3)  Click on NO.
  50.         4)  Select document name.
  51.         5)  The document will now be packed and saved.
  52.         
  53.         
  54.         
  55.         Document Formatting
  56.         -------------------
  57.         
  58.         Documents are automatically formatted when they are loaded.  
  59.         Each line is limited to a maximum of 80 characters per line.  
  60.         Any line that is longer than this will be wrapped onto the next 
  61.         line.
  62.         
  63.         When a document is printed the displayer paginates it 
  64.         automatically to fit the selected page size (11 or 12 inch).  
  65.         If you want to force a page break in to document then place the 
  66.         characters @# at the beginning of a blank line in the document.  
  67.         The displayer will interpret these characters as a page break 
  68.         and will not display or print them.
  69.         
  70.         For example the following text:
  71.         
  72.         -----------------------------------------------------------------
  73.             Welcome to Automation disk 2000
  74.         @#
  75.             The Pompey Pirates are the best by far.
  76.         -----------------------------------------------------------------
  77.         
  78.         will appear on two pages.  If you place any text after the @# 
  79.         then the page break will occur after the entire line has been 
  80.         printed, although I recommend that the @# is the only text on 
  81.         the line.
  82.         
  83.         
  84.         
  85.         
  86.         Displayer Controls
  87.         ------------------
  88.         
  89.         
  90.         Arrow keys - Scroll Up / Down a line in the Document.
  91.         
  92.         Shift Arrow Keys - Scroll Up / Down a page in the Document.
  93.         
  94.         Enter / Return - Scroll Down a line in the Document.
  95.         
  96.         Space Bar - Scroll Down a page in the Document.
  97.         
  98.         Alternate T - Goto the Top of the document.
  99.         
  100.         Alternate B - Goto the bottom of the document.
  101.         
  102.         Alternate G - Goto a line.
  103.             You are asked to enter a line number to goto.  If you want 
  104.             to go forward 10 lines then enter +10, to go back 20 lines 
  105.             enter -20.  To goto the start of a marked block (if any) 
  106.             then enter *.
  107.         
  108.         Alternate F - Search the document for a phrase.
  109.             You are asked to enter the phrase that you wish to search 
  110.             for.  You will then be asked if you want the search to be 
  111.             case sensitive.  A case sensitive search is about twice as 
  112.             fast as a non-sensitive one.  The search for the phrase is 
  113.             started from the top of the document.
  114.         
  115.         Alternate N - Find Next Occurrence of a phrase.
  116.             Searches the document for the next occurrence of the phrase 
  117.             that you originally searched for using ALT-F.
  118.         
  119.         Shift Function Key - Set Bookmark.
  120.             Allows you to remember the current position in the document.
  121.         
  122.         Function Key - Goto Bookmark.
  123.             Goes to a previously set bookmark.
  124.         
  125.         Control T - Set TAB width.
  126.             Allows you to set the size of the TAB control code.  Normal 
  127.             values are 4 or 8. (default = 4).
  128.         
  129.         Alternate S - Start Block.
  130.             Sets the start of a block at the top of the screen.
  131.         
  132.         Alternate E - End Block.
  133.             Sets the end of a block at the bottom of the screen.  After 
  134.             you have marked the start and the end of a block, and it is 
  135.             valid, the block will be shown in reverse text.
  136.         
  137.         Alternate H - Hide Block.
  138.             Kills (unmarks) any previously marked block.
  139.         
  140.         Alternate C - Set Printer Configuration.
  141.             Allows you to configure the displayer to output the correct 
  142.             data to your printer.
  143.         
  144.         Alternate P - Print whole document.
  145.             Prints the whole of the document using the current 
  146.             configuration.  Don't forget to set the config before you 
  147.             start printing.  You can stop printing by holding down both 
  148.             shift keys.
  149.         
  150.         Alternate W - Print block.
  151.             Prints a previously marked block using the current 
  152.             configuration.
  153.         
  154.         Alternate L - Load Document.
  155.             Displays the file selector and asks you to pick a file to 
  156.             load.
  157.         
  158.         Alternate X - Execute Another Program.
  159.             Displays the file selector and asks you to pick a program to 
  160.             execute.  You may run any program that exits cleanly and 
  161.             doesn't do to many nasty things (see the note on
  162.             compatability below).  You are then asked if you want to 
  163.             delete the current document.  If you delete the document 
  164.             then the space taken up by it is released to the operating 
  165.             system.  When the program finishes you will be returned to 
  166.             the displayer.
  167.         
  168.         Zero (colour) - Toggle Hz
  169.             Switches between the screen scan rates of 50 and 60 Hertz.
  170.         
  171.         Zero (mono) - Toggle Colours
  172.             Reverses the screen colours.
  173.         
  174.         Tab - Display Pop-up Menu.
  175.             Displays a pop-up menu so that you can execute various 
  176.             functions.  Select an item by highlighting it and hitting 
  177.             Return.
  178.         
  179.         Alternate Q / Undo - Exit the Doc Displayer.
  180.         
  181.         
  182.         Mouse Control
  183.         -------------
  184.         
  185.         At any time you may use the mouse instead of the keyboard.  
  186.         Moving up / down is the same as pressing the up / down arrow 
  187.         keys.  The left button can be used to select items or to call 
  188.         up the main selection menu.  The right button is used to either 
  189.         cancel a pop-up or to call-up the file selector.
  190.         
  191.         
  192.         Pop-up Menu
  193.         -----------
  194.         
  195.         To activate the pop-up menu then either hit TAB or press the 
  196.         Left mouse button.  This allows you to select various functions 
  197.         without using the keyboard combinations (ALT+key).  Use the 
  198.         Up/Down keys or the mouse to highlight the required function 
  199.         and hit Space, Return or Left mouse button to select.  Press 
  200.         Escape or the Right mouse button to cancel the menu without 
  201.         selecting.
  202.         
  203.         
  204.         Printer Configuration
  205.         ---------------------
  206.         
  207.         The printer config menu can be accessed by pressing Alternate C 
  208.         or selecting it from the pop-up.
  209.         
  210.             Page length can be set to either 12 (A4) or 11 (normal 
  211.         listing) inches.
  212.             If you specify 'page numbers' then the page number will be 
  213.         printed at the bottom of each page.
  214.             'Pause between pages' forces the displayer to pause after 
  215.         every page is printed.  This allows you to print on single 
  216.         sheets, or produce double sided output.
  217.             If you select 'Print Quality = NLQ' then the displayer will 
  218.         send codes to change the printer to NLQ mode.  Note: this will 
  219.         only work with Epson compatable printers.
  220.             If you select 'Bold Printing' then the displayer will send 
  221.         codes to change the printer to emphasized mode.  Note: this will 
  222.         only work with Epson compatable printers.
  223.             The 'Send codes to printer' option allows you to send 
  224.         various codes to the printer.  If you enter '27' then the 
  225.         ascii code 27 will be sent to the printer.  Entering 'A' will 
  226.         send the character 'A' (ascii 65).
  227.             You may also select which printer that any output will be 
  228.         sent to.  If 'serial' is selected then the current RS232 port 
  229.         settings will apply.
  230.         
  231.         
  232.         
  233.         Compatability
  234.         -------------
  235.         
  236.         The original version of the displayer had a few compatability 
  237.         problems with some versions of TOS, but with version 2 these 
  238.         have been eliminated (I hope).  The Doc displayer should work on 
  239.         any version of TOS, even the TT if it supports an ST compatable 
  240.         screen mode.
  241.             The displayer will work in all of the ST's screen modes but 
  242.         NOT on large screen displays such as Hyperscreen, at best the 
  243.         screen will become corrupt or the machine may even crash.
  244.             If your printer does not support Epson control codes, then 
  245.         don't use the NLQ or BOLD options on the printer configuration 
  246.         menu.
  247.             There is a problem if you run the displayer in low rez with 
  248.         Turbo ST (1.82) installed.  The 'bug' shows itself when you exit 
  249.         the displayer.  You will see that the screen colour planes have 
  250.         become offset.  This is a problem with TurboST because the Doc 
  251.         displayer only uses legal BIOS calls to change screen 
  252.         resolution.  This bug only happens occasionally on my machine 
  253.         (TOS 1.4).
  254.             The ability to launch another program from within the 
  255.         displayer can reveal a great many incompatabilities.  You can 
  256.         only safely launch a 100% legal program.  If you run a 
  257.         'naughty' program then the Doc displayer may crash or produce 
  258.         unpredictable results.  I have successfully used programs such 
  259.         as:
  260.         
  261.             HiSoft Basic
  262.             Lattice C5
  263.             Devpac2
  264.             KnifeST
  265.             First Word +
  266.             Script
  267.             Fastcopy
  268.             ProFlight (v1.2)
  269.             AVK
  270.             DC Utils
  271.             Michtron Hard Disk Utils
  272.             any many more...
  273.         
  274.         
  275.         
  276.         Known Bugs
  277.         ----------
  278.         
  279.         While using the displayer, if you hold down the Alternate key 
  280.         and then move the mouse, the busy-bee cursor will whizz around 
  281.         the screen.  This can cause a bit of screen corruption.  Hit 
  282.         the Escape key to refresh the screen.  This 'may' be fixed in 
  283.         future releases.
  284.         
  285.         
  286.         
  287.         
  288.         About the Doc Displayer
  289.         -----------------------
  290.         
  291.         The orignal version of the displayer was written in HiSoft 
  292.         Basic, but from version 2.00 onwards it is written in Lattice C 
  293.         (version 5).  Small pieces of assembler have also been written 
  294.         to speed things up a little bit.
  295.         
  296.         
  297.         Thanks go to:
  298.         
  299.             Teddystacker    - Beta Testing, Ego Boosting, Distribution.
  300.             Tempest         - Fast memory moving routine (v2.01).
  301.             Thor            - Title screen graphics
  302.             Gareth          - Shouting.
  303.             Axe of Delight  - Depack Routine.
  304.             Jeff Healey     - 'Hell to Pay'.
  305.             HiSoft          - HiSoft Basic / Lattice C5 / Devpac2.
  306.             Hard Disk       - Crashing..!
  307.             Dad             - Nagging about electricity bills.
  308.         
  309.         
  310.         The Revenge Document Displayer is in the public domain and may 
  311.         be distributed freely as long as this document is also 
  312.         distributed intact.  Any groups/packers/crackers etc may use 
  313.         the displayer on their menus as long as they greet me.
  314.         
  315.         The HiSoft Basic source code for version 1.93 of The Revenge 
  316.         Document Displayer has now been released.  The actual code is a 
  317.         bit of a mess as it has undergone a lot of 'bolt-on' upgrades 
  318.         and bug fixes.  I have also released the bits of machine code 
  319.         that the Basic version uses (XTRAS.BIN & DOC.BIN).  These will 
  320.         need to be added to your HBASIC.LIB file before you can compile 
  321.         the main program.  This can be achieved by using the 
  322.         BUILDLIB.TTP program that is included with HiSoft Basic (not 
  323.         Power Basic).  Consult your HiSoft manual for more information.
  324.         
  325.         
  326.         
  327.         
  328.         History of The Revenge Document Displayer
  329.         -----------------------------------------
  330.         
  331.         
  332.         Version 1.0  15th April 1990
  333.         
  334.             The very first version was very primitive, and very slow.  
  335.             All it did was load a text file, scroll it up / down, and 
  336.             then let you dump it to the printer.
  337.         
  338.         
  339.         Version 1.1  16th April 1990
  340.         
  341.             A little bit faster, although it is still slow...!
  342.         
  343.         
  344.         Version 1.2  14th May 1990
  345.         
  346.             Goto Top / Bottom keys, Help screen, Search option, 
  347.             Bookmarks.
  348.         
  349.         
  350.         Version 1.3  15th May 1990
  351.         
  352.             Printer output improved, it now handles page breaks (wow..!).
  353.         
  354.         
  355.         Version 1.4  26th June 1990
  356.         
  357.             Handle TABs correctly,  Scrolling speed increased (66%),  
  358.             Faster DOC loading time,  Funky Title Screen,  Changes to 
  359.             medium rez if you load in low rez.
  360.         
  361.         
  362.         Version 1.41  1st July 1990
  363.         
  364.             Better Help screen,  program structure(?) improved.
  365.         
  366.         
  367.         Version 1.50  10th July 1990
  368.         
  369.             Almost a complete re-write of the text handling routines.  
  370.             This resulted in a great speed improvement, and the ability 
  371.             to handle larger documents.
  372.         
  373.         
  374.         Version 1.51  11th July 1990
  375.         
  376.             Repeat Search feature,  50/60Hz feature for colour 
  377.             monitors,  Faster TAB handling.
  378.         
  379.         
  380.         Version 1.52  16th July 1990
  381.         
  382.             Doesn't now crash wen you load a document with < 20 lines.
  383.         
  384.         
  385.         Version 1.53  19th July 1990
  386.         
  387.             Keystroke compatability with the desktop text viewer.  
  388.             Faster DOC loading.
  389.         
  390.         
  391.         Version 1.60  20th July 1990
  392.         
  393.             Support for document encription.
  394.         
  395.         
  396.         Version 1.70  23rd July 1990
  397.         
  398.             File selector added,  loading another document without 
  399.             quitting feature.  The first Teddystacker version.
  400.         
  401.         
  402.         Version 1.71  10th August 1990
  403.         
  404.             Small bug in the file selector fixed.
  405.         
  406.         
  407.         Version 1.72  17th August 1990
  408.         
  409.             Very crude packing algorithm supported (this was one of my 
  410.             own..!)
  411.         
  412.         
  413.         Version 1.73  21st August 1990
  414.         
  415.             My packing routine removed.  Now supports the ICE packer 
  416.             v2.11.  I think I'll leaving packer writing to the guys who 
  417.             can.!
  418.         
  419.         
  420.         Version 1.74  22nd August 1990
  421.         
  422.             Automation packer supported.
  423.         
  424.         
  425.         Version 1.80  24th August 1990
  426.         
  427.             Now you can use pictures in your documents.
  428.         
  429.         
  430.         Version 1.81  2nd September 1990
  431.         
  432.             Picture dump routine, Printer Configuration screen.
  433.         
  434.         
  435.         Version 1.82  7th September 1990
  436.         
  437.             Faster text output even though it's still using the BIOS.
  438.         
  439.         
  440.         Version 1.90  12th October 1990
  441.         
  442.             Very fast text output routines used.  These routines out-run 
  443.             programs like Turbo ST and Quick ST2.
  444.         
  445.         
  446.         Version 1.91  19th October 1990
  447.         
  448.             Nice font added.
  449.         
  450.         
  451.         Version 1.92  26th October 1990
  452.         
  453.             Faster text formatting (507%).
  454.             Faster scrolling (9%).
  455.         
  456.         
  457.         Version 1.93  28th October 1990
  458.         
  459.             New file selector that allows you to switch drives.
  460.             Mouse scrolling added.
  461.         
  462.         
  463.         Version 2.00  3rd February 1991
  464.         
  465.             Complete re-write in C (Lattice C version 5).
  466.                 (The old version was written in HiSoft BASIC).
  467.             Better mouse support.
  468.             Pop-up menus / interactive windows.
  469.             Brilliant file selector.
  470.             Now supports only ICE Packer v2.20.
  471.             Picture ability removed (nobody used it anyway).
  472.             Scrolling speed improved (20%).
  473.             Search speed improved (350-800%).
  474.             Ability to launch another program from within.
  475.             Block marking/printing.
  476.             Number of Pages display.
  477.             Size of program reduced (about 50%).
  478.             Overall Speed of displayer increased.
  479.             Loads of new features.
  480.         
  481.         
  482.         Version 2.01  17th February 1991
  483.         
  484.             Scrolling routines speeded up by 50%.
  485.             Text output routines 11-14% faster.
  486.             Fileselector bug fixed.
  487.             Search from current position feature.
  488.         
  489.         
  490. ə