home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_UTIL / HNR122.ZIP / HNR.DOC next >
Text File  |  1994-03-03  |  24KB  |  497 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                            
  8.                                            
  9.                                            
  10.                                            
  11.                                            
  12.                                            
  13.                                            
  14.                                            
  15.                             Headline NewsRoom Version 1.22
  16.  
  17.                                 News File Generator for
  18.                                  BBS  System Operators
  19.      
  20.                                            
  21.                                      User Manual
  22.                                            
  23.                                            
  24.                                            
  25.                                            
  26.                                            
  27.                          Copyrighted (C) Oakwood Software 1994
  28.                                      by Scott Null
  29.                                            
  30.                                            
  31.                  Find this and other Oakwood Software products first on 
  32.                          Radio Daze AM & FM BBS (219) 256-2255
  33.  
  34.  
  35.             HNR Documentation                                                   Page 2
  36.  
  37.  
  38.  
  39.  
  40.  
  41.                                    TABLE of CONTENTS
  42.                                   -------------------
  43.  
  44.                     General Information............................. 3
  45.  
  46.                     Getting Started................................. 4
  47.  
  48.                     The Main Menu................................... 5
  49.  
  50.                     The News Menu................................... 5
  51.  
  52.                     The Config Menu................................. 7
  53.  
  54.                     The Message Editor.............................. 10
  55.  
  56.                     Registering Headline NewsRoom................... 11
  57.  
  58.  
  59.  
  60. HNR Documentation                                                   Page 3
  61.  
  62.  
  63.           _________________________________________________________________
  64.           _________________________________________________________________
  65.  
  66.                     
  67.           General Information
  68.           _________________________________________________________________
  69.            
  70.           HNR (Headline NewsRoom) was created to fill a gap and allow BBS
  71.           Sysops the ability to easily create professional looking news
  72.           screens to be displayed to users at logon.  I will make the 
  73.           assumption that you the Sysop are familiar with the purpose of 
  74.           the news file in the following documentation.  I hope that this
  75.           program will allow you to easily generate and maintain an
  76.           impressive news display to keep your users informed and take up
  77.           less of your time.  Several programs of this type have come and
  78.           gone and I have tried to take the best features of the myriad
  79.           along with direct input from hard working Sysops to create what
  80.           I hope proves to be a valuable tool.  
  81.     
  82.           Some of HNR's features include;
  83.          
  84.           *  A full screen news message editor with keystrokes/control
  85.              found in popular word processors (line wrap, cursor control,
  86.              etc ..)
  87.  
  88.           *  Allows usage of BBS hostware control codes
  89.  
  90.           *  Up to 64K bytes per message for the Sysop with alot to say
  91.  
  92.           *  Up to 100 active messages 
  93.  
  94.           *  Pull down 'Smart' menus
  95.  
  96.           *  Multiple output styles ; PrinterPaper, NewsPaper, Marquis,
  97.              Banner, DriveIn, ThreeDee, JukeBox, Horizon and Simple
  98.           
  99.           *  ANSI and ASCII output files with full color control
  100.  
  101.           *  Now creates both WildCat and PCBoard format @Code output files
  102.  
  103.           *  Ability to import text files from disk to be used in the news
  104.              message
  105.  
  106.           *  Headlines and automatic Time/Date stamping to news messages
  107.  
  108.           *  Multi-tasking and DesqView aware
  109.  
  110.           I hope that you enjoy HNR as I know that it will save you
  111.           countless hours when communicating with your callers.
  112.  
  113. HNR Documentation                                                   Page 4
  114.  
  115.  
  116.           _________________________________________________________________
  117.           _________________________________________________________________
  118.  
  119.  
  120.           Getting Started
  121.           _________________________________________________________________
  122.  
  123.        
  124.           To set up HNR you must simply copy HNR.EXE to the directory you 
  125.           want to run it from.  The first time you run HNR it will
  126.           automatically create the support files that it needs to run.
  127.           These files will include HNR.CFG which contains the setup 
  128.           configuration and HNR.DAT which stores the message text used to 
  129.           create the output news screens.  Once you run HNR for the first
  130.           time, you can then call it up from anywhere as long as it resides
  131.           somewhere in your PATH and HNR will find it's support files 
  132.           automatically.
  133.  
  134.           It is recommended that you have ANSI.SYS installed from your 
  135.           CONFIG.SYS file at boot time (the reason for this will be 
  136.           explained later -- see 'View ANSI')
  137.           
  138.           This is all there is to it!  I am from the school of thought that
  139.           believes and operates as follows ...
  140.  
  141.            * UNZIP the thing
  142.            * Find the '.EXE' file 
  143.            * Run it!
  144.            * When all else fails, read the '.DOC's (a really good program
  145.              shouldn't force you to do this step just to run!)
  146.  
  147.           If you are like me then you won't even read this documentation
  148.           unless you run into problems or have got the thing running and 
  149.           wonder if it does anything else that you haven't already discovered.
  150.           
  151.           
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158. HNR Documentation                                                   Page 5
  159.  
  160.  
  161.           _________________________________________________________________
  162.           _________________________________________________________________
  163.  
  164.           The Main Menu
  165.           ═════════════
  166.           1. News
  167.           2. Config
  168.           3. Exit
  169.           _________________________________________________________________
  170.            
  171.           You can use the cursor keys or type the first letter of the item
  172.           to get where you want.  'News' contains the message editor and the
  173.           rebuild and view output files options.  The 'Config' contains user
  174.           customizable setups and configurations.  
  175.           _________________________________________________________________
  176.           _________________________________________________________________
  177.  
  178.  
  179.           The News Menu
  180.           ═════════════
  181.           1. Add New Message  
  182.           2. Edit             
  183.           3. Delete           
  184.           4. Import Text      
  185.           5. Rebuild Output   
  186.           6. View ANSI        
  187.           7. View ASCII       
  188.  
  189.           _________________________________________________________________
  190.           Add New Message:
  191.  
  192.           This option allows you to enter new news messages into your news
  193.           file.  HNR creates a file called HNR.DAT which contains the text
  194.           for each individual news message.  When you select 'Add New Mess-
  195.           age', you will then be prompted to enter a Headline.  You can
  196.           then enter up to a 40 character title to be used for the new
  197.           message.  After entering the Headline you will pop into HNR's
  198.           message editor (see Message Editor) and can enter your message
  199.           text.  
  200.           _________________________________________________________________
  201.           Edit:
  202.  
  203.           This option allows you to edit/change news messages that already
  204.           exist in the HNR NewsRoom file called HNR.DAT.  After selecting
  205.           'Edit' a list of all of the Headlines for all messages currently
  206.           in HNR.DAT will pop up.  You select the message you want to edit
  207.           by cursoring down to the Headline for that message and pressing
  208.           enter when the Headline you want is highlighted.  You can then
  209.           edit the Headline and the message. (see Message Editor)
  210.  
  211. HNR Documentation                                                   Page 6
  212.  
  213.  
  214.           _________________________________________________________________
  215.           Delete:
  216.  
  217.           This option allows you to delete messages from the NewsRoom file.
  218.           Selecting 'Delete' will cause a list of all of the Headlines
  219.           currently in the NewsRoom to pop up.  You can cursor down to the
  220.           Headline that represents the news message you wish to delete.
  221.           After highlighting the Headline, press enter and type 'Y' to
  222.           confirm the delete.  The NewsRoom file will then be updated with
  223.           the unwanted message removed.
  224.           _________________________________________________________________
  225.           Import Text:
  226.  
  227.           This option allows you to read any text file from disk into a 
  228.           NewsRoom message.  After selecting 'Import Text' a box will pop
  229.           up showing all files in the current directory.  The box will also
  230.           contain directories.  You can either highlight and select a file
  231.           or highlight and select a directory to change directories.
  232.  
  233.           This option is especially useful for quoting from a user's
  234.           message, bringing in a document, importing a bulletin, or anything
  235.           that would be a hassle to re-type by hand that already exists
  236.           in a file somewhere on your harddrive.  The HNR NewsRoom has a 
  237.           limit as to the length each line of text can be so in some cases
  238.           where you import a file with long text lines the re-format 
  239.           command in the message editor should be used to clean up the line
  240.           lengths. (see Message Editor)  The file that you import must also
  241.           be less than 64k bytes in size.
  242.           _________________________________________________________________
  243.           Rebuild Output:
  244.  
  245.           This option is the heart of HNR.  It allows you to generate the
  246.           ANSI and ASCII news screens using contents of the current NewsRoom
  247.           message file.  After selecting 'Rebuild Output' choose 'Center'
  248.           or  'Left justify' to determine how text will be formatted in your
  249.           output file.  Your ANSI and ASCII news screens will be re-created 
  250.           in the directory you have selected for output with the current 
  251.           style and colors you have chosen. (see Output Path in Setup)
  252.           _________________________________________________________________
  253.           View ANSI:
  254.  
  255.           This option allows you to view the current ANSI color news screen.
  256.           In order for this option to function correctly you need to be 
  257.           sure you have installed ANSI.SYS in your CONFIG.SYS file. (see 
  258.           your DOS manual)  HNR will look for the filename you have chosen
  259.           for your ANSI screen in the drive/path you have chosen for output.
  260.           You can abort the viewing by pressing the <Esc> key at any time.
  261.           _________________________________________________________________
  262.           View ASCII:
  263.  
  264.           This option allows you to view the current ASCII news screen.
  265.           The ASCII screen contains no colors and is the 'monochrome' 
  266.           news screen.  HNR will look for the filename you have chosen
  267.           for your ASCII screen in the drive/path you have chosen for output.
  268.           You can abort the viewing by pressing the <Esc> key at any time.
  269. HNR Documentation                                                   Page 7
  270.  
  271.  
  272.           _________________________________________________________________
  273.           _________________________________________________________________
  274.  
  275.  
  276.           The Config Menu
  277.           ═══════════════
  278.           1. Output Style
  279.           2. Setup
  280.           3. ANSI Colors
  281.           4. Register <see Registering Headline NewsRoom on page 10>
  282.  
  283.           The 'Config Menu' allows you to customize HNR.  The configuration
  284.           information is stored in a file called HNR.CNF.
  285.           _________________________________________________________________
  286.           Output Style:
  287.  
  288.           This option allows you to select the style used when rebuilding
  289.           the output news files.  Ten different output styles are 
  290.           available to the user.
  291.            
  292.           * JukeBox
  293.           * Hollywood
  294.           * Horizon
  295.           * PrinterPaper
  296.           * Marquis  
  297.           * NewsPaper
  298.           * Banner   
  299.           * DriveIn  
  300.           * ThreeDee 
  301.           * Simple   
  302. HNR Documentation                                                   Page 8
  303.  
  304.           _________________________________________________________________
  305.           Setup:
  306.  
  307.           Selecting 'Setup' will display the following data entry box;
  308.           
  309.           ╒═════════════════ SetUp - <Esc> when done ═════════════════╕           
  310.           │                                                           │           
  311.           │        BBS Name: Radio Daze AM & FM BBS                   │           
  312.           │      Sysop Name: Michael Shannon                          │           
  313.           │     Output Path: C:\PROJ\PAS\                             │           
  314.           │  ANSI File Name: HNR.ANS                                  │           
  315.           │ ASCII File Name: HNR.ASC                                  │           
  316.           │ @Code File Name: HNR.BBS                                  │           
  317.           │    Initial Code: 111                                      │           
  318.           │  Control Code 1: 222                                      │           
  319.           │  Control Code 2: 333                                      │           
  320.           │  Control Code 3: 444                                      │           
  321.           │ Refer to your BBS hostware manual for the definition of   │           
  322.           │ the control codes that will work with your software.      │           
  323.           │                            Current Style = THREEDEE       │           
  324.           ╘═══════════════════════════════════════════════════════════╛           
  325.  
  326.           * BBS Name: Enter the name of your BBS
  327.           * Sysop Name: Enter your name
  328.           * Output Path: Enter the full drive:\path where your BBS 
  329.             software expects to find the necessary news display files.
  330.           * ANSI File Name: Enter the filename that your BBS software 
  331.             uses for the color news file.
  332.           * ASCII File Name: Enter the filename that your BBS software
  333.             uses for the mono news file.
  334.           * @Code File Name: If you wish to create an @Code output then
  335.             enter the name with and extension of ".BBS" for WildCat format
  336.             or ".PCB" for PCBoard format, leave blank for no @code output
  337.           * Initial Code: You may enter a control code to be inserted at
  338.             the very beginning of your news display files.  See your 
  339.             BBS software manual for a list of the codes that you can use.
  340.           * Control Codes 1-3: You may enter up to 3 control codes to be
  341.             inserted in between each news message in the display files.
  342.  
  343.           The current output style is also displayed for your information.
  344.           Once you have entered all of the information you can press
  345.           the escape key to leave 'Setup'.  When you leave 'Setup', the
  346.           configuration file HNR.CNF is automatically updated with the
  347.           new setup information.
  348.  
  349.           The ability to insert control codes is a new feature.  A Wildcat
  350.           Sysop, for example, could add @PAUSE@ and @CLS@ to pause, then
  351.           clear the screen after each news message.
  352. HNR Documentation                                                   Page 9
  353.  
  354.  
  355.           _________________________________________________________________
  356.           ANSI Colors:
  357.  
  358.           This option allows you to customize the colors used in the ANSI
  359.           news file.  You may select the colors used for ...
  360.  
  361.           * The Border Color   
  362.           * The Sysop/BBS Lines
  363.           * The Date/Time Line 
  364.           * The Headline       
  365.           * The first alternating message line color
  366.           * The second alternating message line color
  367.  
  368.           Once you have selected which color you wish to change, a box
  369.           will pop up allowing you to select from the color palette
  370.           with the cursor and enter keys.  Say you have selected 'Border
  371.           Color', you would see ...
  372.  
  373.          ╔═════════════════════ Select Border Color ══════════════════════╗
  374.          ║■■■■■■■■■■■■■■■■                                                ║
  375.          ║■■■■■■■■■■■■■■■■    *****************************************   ║
  376.          ║■■■■■■■■■■■■■■■■    *****************************************   ║
  377.          ║■■■■ The ■■■■■■■    ***        BBS/Sysop Name Here        ***   ║
  378.          ║■■■■ Color ■■■■■    ***     10/12/1991 at 12:01:01 am     ***   ║
  379.          ║■■■■ Palette ■■■    ***   ╔════════════════════════════╗  ***   ║
  380.          ║■■■■■■■■■■■■■■■■    ***   ║  Headline News Extra !!!   ║  ***   ║
  381.          ║■■■■■■■■■■■■■■■■    ***   ╚════════════════════════════╝  ***   ║
  382.          ║■■■■■■■■■■■■■■■■    ***    This is the first text line    ***   ║
  383.          ║■■■■■■■■■■■■■■■■    ***      This is the second line      ***   ║
  384.          ║■■■■■■■■■■■■■■■■    *****************************************   ║
  385.          ║■■■■■■■■■■■■■■■■    *****************************************   ║
  386.          ║■■■■■■■■■■■■■■■■                                                ║
  387.          ║■■■■■■■■■■■■■■■■  <═══                                          ║
  388.          ║■■■■■■■■■■■■■■■■    Use the cursor keys to move to the          ║
  389.          ║■■■■■■■■■■■■■■■■    color you want, Press <Enter> to select     ║
  390.          ╚════════════════════════════════════════════════════════════════╝
  391.  
  392.           At this point you can use the cursor keys to move around the 
  393.           palette and watch the example output screen update as you move.
  394.           When you have found the color you wish to use press enter to 
  395.           select it.  If you press escape with out pressing enter, the 
  396.           color will not change from what it was previously.
  397.  
  398.  
  399. HNR Documentation                                                   Page 10
  400.  
  401.  
  402.           _________________________________________________________________
  403.           _________________________________________________________________
  404.  
  405.                     
  406.           The Message Editor 
  407.           _________________________________________________________________
  408.  
  409.           The message editor uses many keystrokes found in popular word
  410.           processors.  The following commands are available ...
  411.  
  412.           <The Ctrl-Key is shown using "^">
  413.  
  414.           ^-Key or Key Combination  =  Effect                 
  415.           ═════    ═══════════════     ══════                 
  416.           ^A       ^Left              Cursor word left       
  417.           ^C       PgDn               Page down              
  418.           ^D       Right              Cursor right           
  419.           ^E       Up                 Cursor up              
  420.           ^F       ^Right             Cursor word right      
  421.           ^G       Del                Delete character       
  422.           ^I       Tab                Tab right              
  423.           ^M       Enter              New line               
  424.           ^S       Left               Cursor left            
  425.           ^X       Down               Cursor down one line   
  426.           ^R       PgUp               Page up                
  427.           ^M       Enter              Start new line         
  428.           ^QD      End                Cursor to end of line     
  429.           ^QS      Home               Cursor to start of line   
  430.           ^QE      ^Home              Cursor to top of window   
  431.           ^QX      ^End               Cursor to bottom of window
  432.           ^QR      ^PgUp              Cursor to start of message
  433.           ^QC      ^PgDn              Cursor to end of message  
  434.                                                                 
  435.           Keys = Effect                    Keys = Effect        
  436.           ═════  ══════                    ═════  ══════        
  437.           ^B     Reformat paragraph        ^OI    Toggle auto-indent    
  438.           ^W     Scroll up one line        ^P[^?] Insert Ctrl char [^?] 
  439.           ^Z     Scroll down one line      Alt-R  Reformat entire message
  440.           ^Y     Delete current line       ^T     Delete word right     
  441.           <F2>   Save message              ^QL    Undo                  
  442.           ^QY    Delete to end of line     ^OW    Toggle word wrap      
  443.           Esc    Quit editor                                            
  444.         
  445.  
  446.  
  447. HNR Documentation                                                   Page 11
  448.  
  449.  
  450.           _________________________________________________________________
  451.           _________________________________________________________________
  452.  
  453.  
  454.           Registering Headline NewsRoom
  455.           ═════════════════════════════
  456.  
  457.           If you find yourself using Headline NewsRoom on a regular basis,
  458.           you must register your copy.  Headline NewsRoom can be registered
  459.           by filling out the registration form included in HNRREG.DOC and
  460.           sending it along with $15.00 US to ...
  461.  
  462.           Scott Null
  463.           Oakwood International Inc.
  464.           3935 Lincoln Way East, Suite A
  465.           Mishawaka, IN  46544
  466.  
  467.           [Make checks payable to Scott Null]
  468.  
  469.           Or register by sending only $5.00 US and proof of membership to
  470.           Radio Daze AM & FM BBS. (Home of Headline NewsRoom)
  471.           In order to qualify for the reduced rate you must be a PAID
  472.           subscriber to Radio Daze AM & FM BBS.
  473.  
  474.           Registered users will receive a personal registration number.
  475.           This number can then be entered into the 'Register' option
  476.           under the 'Config' menu.  This number will eliminate the 
  477.           appearance of "**UNREGISTERED**" in the output news files.
  478.           Registered users will also be automatically registered for
  479.           future versions of Headline NewsRoom.  Registered users will
  480.           receive free/unlimited on-line techical support via Radio Daze 
  481.           AM & FM BBS (Oakwood Software conference).
  482.  
  483.           Registered users will also receive that good feeling associated 
  484.           with supporting shareware development. 
  485.           <Remember - Shareware keeps BBSs in business too!>
  486.  
  487.           Also remember to call Radio Daze AM & FM BBS at (219) 256-2255
  488.            * Multi-Node 12/24/96/19.2
  489.            * 4.5 Gig -- thousands and thousands of files!
  490.            * World wide Echos and Conferences
  491.            * Forums / SIGs / Doors / ONLINE store and more!
  492.            * HNR Online Technical support for registered users
  493.           
  494.           _________________________________________________________________
  495.  
  496.  
  497.