home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / PCBOARD / TVIEW30.ZIP / TEXTVIEW.DOC < prev    next >
Text File  |  1994-02-26  |  23KB  |  500 lines

  1.  
  2.      ┌─────────────────────────────────────────────────────────────────┐
  3.      │                           TEXTVIEW 3.0                          │
  4.      │         A PCBoard Programming Language based Application        │
  5.      │       By Joseph Sheppard - The Ledge PCBoard (818) 896-4015     │
  6.      └─────────────────────────────────────────────────────────────────┘
  7.  
  8.     ───────────
  9.     DESCRIPTION
  10.     ───────────
  11.  
  12.     Textview allows the Sysop to make text based features available to
  13.     callers in an online magazine format.  It includes an option to
  14.     allow your users to download from a list of files you specify. The
  15.     sysop can also give extra time in the application to users of a
  16.     defined security level. All of the PCBoard function keys are
  17.     supported, including Sysop Chat (F10).
  18.  
  19.     TextView is written using the PCBoard Programming Language.  This
  20.     being the case, the program is compatible with any setup that is
  21.     successful at running PCBoard 15.1 or greater.
  22.  
  23.     Downloading is handled using your PCBoard setup, so all of the
  24.     protocols you have working in PCBoard, will be used automatically
  25.     by TextView including external protocols.
  26.  
  27.     Textview can shell to another program or batch file from inside
  28.     TextView if you wish. This can be any kind of routine you like as
  29.     long as you have enough free memory to support it.
  30.  
  31.     The program supports menu branching.  You can make up menu
  32.     selections, that when selected execute another Textview based
  33.     feature, and will return to the original feature when exited. This
  34.     can be done in multiple layers.
  35.  
  36.     TextView features can be launched from most files that can be
  37.     displayed via PCBoard.  For example, you can launch a TextView
  38.     feature from your Bulletin menu.
  39.  
  40.     TextView can launch other PPE programs.  Simply place an
  41.     exclamation point, followed by the path and name of the PPE, plus
  42.     any parameters needed to run the PPE in the first column of any
  43.     TextView displayed file, and the PPE program will be executed!
  44.  
  45.     If you have software that you want to distribute to users of a
  46.     certain security level only, you can make TextView available to
  47.     users with the same security level as your customers or higher.
  48.     When your customer goes into TextView, he can read new product
  49.     information and download an ZIP of the latest version of your
  50.     software. You choose the download path, so you can put the files
  51.     in a directory only accessible via TextView.  You can even give
  52.     him extra time when he is in the application, which will be
  53.     deducted when he exits, restoring the original time he had left
  54.     when he entered.
  55.  
  56.     The following user created files are supported in both ASCII and
  57.     ANSI:
  58.  
  59.     Welcome screen     (TVHELLO & TVHELLOG)
  60.     Menu screen        (TVMENU & TVMENUG)
  61.     Download Directory (TVDIR & TVDIRG)
  62.     Goodbye Screen     (TVBYE & TVBYEG)
  63.  
  64.     TextView can display as many files as you can support on your
  65.     system ASCII and ANSI versions are displayed depending on which
  66.     mode your caller is in.  The caller has the option to toggle
  67.     between ANSI and ASCII display mode.  Both file formats
  68.     (ASCII/ANSI) are supported, but not required.  If one or the other
  69.     format is unavailable, the caller will be shown what is available
  70.     for that menu selection. TextView will also convert PCBoard @x
  71.     color codes on the fly, as well as text @VARIABLES@.
  72.  
  73.     Command stacking is supported, so callers can capture several menu
  74.     selections with a command such as 1;2;3;4;NS.
  75.  
  76.     ─────
  77.     SETUP
  78.     ─────
  79.  
  80.     Here is a description of the files you will need to get started:
  81.  
  82.     1. Filename:         TV.PPE
  83.        Purpose:          Textview program
  84.        Location:         The directory specified in CMD.LST
  85.  
  86.     2. Filename:         TV.CNF
  87.        Purpose:          Defines parameters for TV.PPE
  88.        Location:         The directory specified in CMD.LST
  89.  
  90.        Sample File:
  91.  
  92.        RESERVED
  93.        D:\TV
  94.        20
  95.        0
  96.        0
  97.        M
  98.        D:\TV\DL
  99.        RESERVED
  100.        DEFAULT
  101.        TextView
  102.        N
  103.        RESERVED
  104.        NONE
  105.  
  106.  
  107.        Explanation:
  108.  
  109.        RESERVED: Reserved for Future Use.
  110.  
  111.        D:\TV: This is the path to the files you want to display.  I would
  112.        suggest putting these files in their own directory.
  113.  
  114.        20: This is the number of files available for display. It can
  115.        be any number higher than 1.
  116.  
  117.        0: Replace this with the security level you want to all more
  118.        time in the application for.  For instance if you are providing
  119.        product support for your level 50's and up, AND you want to
  120.        give them more time in the application, put a 50 here.  If you
  121.        don't want to give anyone more time put a 0 here.
  122.  
  123.        0: Replace this with the number of minutes you want to add to
  124.        the security level defined above.  If you want to give your
  125.        customers an extra 15 minutes in the application, then put a 15
  126.        here.  If you don't want to add any time, put a 0 here.
  127.  
  128.        M: This line tells TextView how you want to handle downloading.
  129.        Your choices are: Single file, Multiple files or No files
  130.        (downloading not allowed).  If you only have one file that you
  131.        want available for downloading, then put the letter S on this
  132.        line.  If you have a list of files you want the user to be able
  133.        to download then put an M on this line.  If you don't want the
  134.        user to be able to download at all, put the letter N on this
  135.        line (if N is selected the download option won't appear on the
  136.        command line at all).
  137.  
  138.        D:\TV\DL: Replace this with the path to the files you want the
  139.        user to be able to download.  Be sure that there is nothing in
  140.        this directory that you don't want downloaded because the user
  141.        will be able to take whatever is there.  Please don't call me
  142.        and yell at me because a user downloaded the USER file while in
  143.        TextView.  The only way this could happen is if you screw up
  144.        and put \PCB\MAIN on this line.  IMPORTANT: If you have
  145.        selected the Single file option (an S on line 6) then you will
  146.        need to add the filename to the path (example
  147.        D:\TV\DL\FILES.ZIP).  If you aren't going to allow downloading,
  148.        then put the word NONE on this line.
  149.  
  150.        RESERVED: Reserved for Future Use.
  151.  
  152.        DEFAULT: This line affects Registered Versions of TextView
  153.        only. Registered Sysops may place a filename on this line,
  154.        which must include the path if the file isn't in the same
  155.        directory as TV.EXE. The file named on this line must be an
  156.        ASCII file containing the names and paths of the files to be
  157.        displayed.  This feature is designed to cut maintenance time
  158.        for Sysops who display online magazines which are updated
  159.        frequently, but have the same filenames week to week.  USAToday
  160.        and NewsBytes are examples of these types of magazines.  The
  161.        files must be listed in the order that they appear on the menu.
  162.        For example, a file that had these three lines:
  163.  
  164.        D:\PCB\GEN\WELCOME
  165.        D:\PCB\GEN\NEWUSER
  166.        D:\PCB\MAIN\CALLER
  167.  
  168.        Would cause TextView to display your WELCOME screen if the
  169.        caller chose #1 off the menu.  Your NEWUSER file if he chose #2
  170.        and your CALLER log if he picked #3.  The number of files
  171.        listed in this file MUST be the same as the number you have on
  172.        line 3 of the .CNF file.
  173.  
  174.        The files NBYTES.TV and USA.TV (included in TVSAMPLE.ZIP) are
  175.        examples of how this option can be used for easy maintenance of
  176.        the Newsbytes and USAToday.  And can be activated by registered
  177.        users if they specify one of these filenames on line 9.
  178.  
  179.        TextView: You can give your TextView application a name that
  180.        will be placed in the CALLER log to let you know what features
  181.        are being used.
  182.  
  183.        N: TextView can run as a "Sub-System".  This means that you can
  184.        run one application, then follow it with TextView
  185.        automatically. The original purpose for this is to display game
  186.        door scorecards.  One put the letter Y on this line followed by
  187.        the desired prompt, and TextView will give the option to answer
  188.        (Y)es, (N)o, (G)oodbye before running.  For a score door, the
  189.        sysop might put the following on this line:
  190.  
  191.        Y;View the Scorecards?
  192.  
  193.        TextView will show:
  194.  
  195.        View the Scorecards?
  196.        (Y)es, (N)o, (G)oodbye: _
  197.  
  198.        If the caller answers Yes, then TextView is run, and he is
  199.        shown the material.  If he answers No, then he is returned to
  200.        the BBS.  If he answers Goodbye then he is properly logged off.
  201.  
  202.        This feature is valuable if you want to give a user certain
  203.        material to read before or after a particular application. For
  204.        example, you might use it to launch an TextView application
  205.        from a bulletin, giving the user an option to execute the
  206.        feature or not. Leave the letter N on this line if you don't
  207.        want TextView to act as a "Sub-System".
  208.  
  209.        RESERVED: Reserved for future use.
  210.  
  211.        NONE: Replace this with the name of a batch file or program you
  212.        would like your users to be able to run from the TextView menu.
  213.        This can be any kind of routine you like as long as you have
  214.        enough free memory to support it.  Programs that write directly
  215.        to screen will need a program like Marshall Dudley's "Doorway"
  216.        to redirect the output.  The program or batch file specified
  217.        must be in the same directory as TV.PPE. The user can run the
  218.        routine by typing the word you put on this line.  For example,
  219.        if the routine you want to run is called REGISTER, then you
  220.        would need a program called REGISTER.EXE or REGISTER.COM, or a
  221.        batch file called REGISTER.BAT in directory with TV.PPE.  Then
  222.        your caller would type the word REGISTER from the TextView
  223.        command line to run the routine.
  224.  
  225.        ──────────────────
  226.        TEXTVIEW AS A DOOR
  227.        ──────────────────
  228.  
  229.     3. Filename:           TEXTVIEW
  230.        Purpose:            Used by PCBoard to run the TextView from
  231.                            the DOOR menu
  232.        Location:           Your Door batch file directory
  233.  
  234.        Sample file:
  235.  
  236.        @ECHO OFF
  237.        ECHO !D:\TEXTVIEW\TV.PPE D:\TEXTVIEW\TV.CNF > PCBDOOR.TXT
  238.  
  239.        Explanation:
  240.  
  241.        @ECHO OFF: Stops echoing commands to the local screen
  242.  
  243.        ECHO !D:\TEXTVIEW\TV.PPE D:\TEXTVIEW\TV.CNF > PCBDOOR.TXT:
  244.        Creates a file called PCBDOOR.TXT in the default directory for
  245.        the node the caller is on.  Inside the file is the command to
  246.        run the specified TextView feature from the door menu.
  247.  
  248.     Note: In order to run TextView from the Door menu, you must enter
  249.     TEXTVIEW in your DOORS.LST file.  This is done by via
  250.     PCBSETUP.EXE.  Set it up as a SHELLED door, by putting the letter
  251.     "Y" under the column that says "SHELL".
  252.  
  253.     ───────────────────────────
  254.     TEXTVIEW FROM THE MAIN MENU
  255.     ───────────────────────────
  256.  
  257.     To execute a Textview based feature from the Main Menu Command
  258.     prompt, you must put an entry in your CMD.LST file.  To do this,
  259.     you have to run PCBSETUP.EXE.  Go from the main menu to "File
  260.     Locations", then to "Configuration Files".  Next cursor down to
  261.     your CMD.LST file and hit F2 to edit it.  You must put in an entry
  262.     for each TextView based feature.  It might look like this:
  263.  
  264.     Command         Security      PPE/MNU File -or- Keystroke Replacement
  265.     ============    ============  =======================================
  266.     1) NEWUSER      10            D:\TVIEW\TV.PPE D:\TVIEW\NEWUSER.CNF
  267.     2) SUPPORT      10            D:\TVIEW\TV.PPE D:\TVIEW\SUPPORT.CNF
  268.  
  269.  
  270.     The First column is the word the caller will type to view the
  271.     feature.  The second is the minimum security level the caller must
  272.     have to use the feature.  The third is the command required to run
  273.     the feature with the location of TV.PPE first, and the location of
  274.     the configuration file second.
  275.  
  276.     ────────────────────────────
  277.     TEXTVIEW FROM A DISPLAY FILE
  278.     ────────────────────────────
  279.  
  280.     You can automatically execute a TextView feature from most files
  281.     that PCBoard can display.  For example, I launch three different
  282.     TextView features from my Bulletin Menu.  One menu item is for
  283.     information on the U'NI-net Echomail Network.  When the caller
  284.     goes to read this item, the TextView U'NI-net Menu is instantly
  285.     produced, from there the caller can read from a menu of text
  286.     files, or even download programs.  When the caller exits that
  287.     feature, the Bulletin menu prompt is displayed!
  288.  
  289.     The way this is done is to go into BLT.LST from PCBSETUP.EXE and
  290.     assign a file name to display as a bulletin.  Then hit F2 to edit
  291.     that file.  Place a single line in the file to execute the
  292.     TextView feature you want.  The line must start in column one with
  293.     an exclamation point, then the path to TV.PPE, a space, then the
  294.     name and path of the configuration file.  It would look like this:
  295.  
  296.     !D:\TVIEW\TV.PPE D:\TVIEW\UNI.CNF
  297.  
  298.     You can launch other PPE's as well in this from an TextView based
  299.     feature.
  300.  
  301.     Several features can be stacked in this fashion.  For example, on
  302.     my BBS a caller can go to the Bulletin Menu, Select "New User
  303.     Information", the "NewUser" TextView menu is produced instantly.
  304.     From there, if the caller selects the menu item for "Information
  305.     on Internet Email", the "Internet" TextView menu is produced. When
  306.     the caller exits the Internet feature, the Newuser menu is
  307.     produced, and when that is exited the Bulletin prompt is back.
  308.  
  309.     This makes TextView amazingly flexible.  If you run another
  310.     program of mine called DDoor, you can launch any door on your
  311.     system from a TextView menu selection!  < Shameless Plug <g>
  312.  
  313.     ─────────────────
  314.     FILES YOU PROVIDE
  315.     ─────────────────
  316.  
  317.     The following files can be used to enhance your TextView features.
  318.     You don't have to create them. If you don't, then the code will
  319.     handle it by skipping to the next step, so if you don't want to
  320.     support an ANSI version of each file, simply don't include it.  If
  321.     you do use these they must be in the path defined by you in
  322.     TV.CNF. These files can be created with any ASCII or ANSI editor,
  323.     or PCBEDIT from CDC. Security Level specific and Language Specific
  324.     files are also supported, as well as RIP screens.
  325.  
  326.     TVHELLO & TVHELLOG: These are like PCBoard's WELCOME & WELCOMEG.
  327.     will be shown to your callers inside the application.
  328.  
  329.     TVDIR & TVDIRG: This is the directory of files you are offering
  330.     for download in the TextView application.  If you don't allow
  331.     downloading, then this file need exist.  You can use any of the
  332.     PCBoard directory maintenance programs to create and maintain this
  333.     file, including PCBFILER.  This file will be automatically
  334.     colorized.  To make this work correctly, reserve the first three
  335.     lines of the file for header information.  Have the first filename
  336.     and description on LINE 4.
  337.  
  338.     TVBYE & TVBYEG: This the last thing the caller sees before leaving
  339.     the feature to go back to PCBoard.
  340.  
  341.     TVx & TVxG: These are the actual files available for viewing.  x
  342.     equals the menu number of the file (So, TV1 and TV1G would be Menu
  343.     item 1). It is VERY important to remember to rename each feature
  344.     in this manner. This is written in the same manner as the PCBoard
  345.     Bulletins (BLT1, BLT1G, etc.).  Registered users may specify their
  346.     own filenames in a file defined on line 9 of the .CNF file.
  347.  
  348.     ──────────────────
  349.     NON-STANDARD PORTS
  350.     ──────────────────
  351.  
  352.     If your non-standard setup (multiport board or whatever) works
  353.     with PCBoard, it will work with TextView.  Don't give this a
  354.     second thought, this is one of the reasons I completely rewrote
  355.     the program using the PCBoard Programming Language.  Compatibility
  356.     is guaranteed!
  357.  
  358.     ────────────────────────────
  359.     TEXT VARIABLES & COLOR CODES
  360.     ────────────────────────────
  361.  
  362.     All display files will respond to the standard PCBoard text
  363.     variables and color codes. Place the variables anywhere in any
  364.     line to be displayed by TextView and they will be translated.
  365.  
  366.     ───────────────────────────
  367.     DOWNLOADING INSIDE TEXTVIEW
  368.     ───────────────────────────
  369.     Under most circumstances, Downloading with TextView is simple,
  370.     because it uses PCBoard's own downloading routines.
  371.  
  372.     However, when you want to give people who don't have downloading
  373.     access on your BBS the ability to download specific files
  374.     inside a TextView application, it can be a little tricky.
  375.  
  376.     First, you must give these callers some daily K-bytes in the PWRD
  377.     file.  TextView bypasses the fact that they don't have access to
  378.     the main board (D)ownload command, but they still have to have
  379.     some K-Bytes available in the PWRD file for it to work.
  380.  
  381.     The other consideration is that the routine from PCBoard that
  382.     TextView uses to download files, flags only the legit files they
  383.     are allowed to download, but then presents them with a prompt to
  384.     "Download Flagged Files (Y)".  I found out that if the caller
  385.     answers (N) to this question, he can then flag any file on the
  386.     system!  To get around this, you have to manipulate your FSEC file
  387.     a bit.  Here is what mine looks like:
  388.  
  389.         D:\NU\DL\,*.*,10,
  390.         ,*.*,30,
  391.  
  392.     The first line lets anybody with level 10 or greater download any
  393.     file in my D:\NU\DL directory.  This is the directory for my "New
  394.     User Door".  The next line tells the system to only allow level 30
  395.     or above (registered users) to download from any other directory.
  396.  
  397.     If you set it up this way, your unregistered callers can download
  398.     from the TextView door, but if they try to flag other files on the
  399.     system, they will get a security message.
  400.  
  401.     The FSEC file can be edited using PCBSETUP.EXE.
  402.  
  403.  
  404.     ────────────
  405.     REGISTRATION
  406.     ────────────
  407.  
  408.     TextView represents years of work.  I have been supplying updates
  409.     of this program since June of 1988.  In November of 1993 I did a
  410.     complete rewrite as a PPE without charging people who registered
  411.     the program before anything.  The fact that TextView is a PPE
  412.     guarantees future compatibility with PCBoard.  If you exploit the
  413.     full power of TextView it will become an important part of your
  414.     BBS.  For this reason, you should pay to register it.
  415.  
  416.     If you find that your are still running TextView 30 days after
  417.     setting it up, or if you'd like to unlock the registered features,
  418.     please call The Ledge PCBoard at 818-896-4015 and type REGISTER at
  419.     the main menu command prompt.  This will allow you to register by
  420.     MASTERCARD, VISA, DISCOVER or AMERICAN EXPRESS.
  421.  
  422.     If you prefer to pay by check or money order, please fill out
  423.     REGISTER.TXT and send it in with a shareware contribution of
  424.     $20.00 in US Funds.
  425.  
  426.     Registered users will receive a file called TV.KEY that when
  427.     present in the same directory as TV.PPE will bypass all
  428.     "unregistered" references, bypass the "Press Enter to Continue"
  429.     prompt before TVHELLO is displayed, and will allow you to use line
  430.     9 of the .CNF file to specify your own custom filenames for
  431.     display instead of TV1, TV2, TV3, etc.
  432.  
  433.     Valid TV.KEY files will automatically register this version of
  434.     TextView and ALL FUTURE VERSIONS!  There is no need to call my BBS
  435.     each time I release a new TV.PPE to get your registered copy.
  436.     Just download it from any source and your TV.KEY file will unlock
  437.     the new version for you just by being there no mumbo-jumbo, no
  438.     passwords...just run the program!
  439.  
  440.     I can be reached at my BBS, The Ledge PCBoard (818) 896-4015 -
  441.     HST/V.32bis, U'NI-net Echomail Network (for which I am the
  442.     International host), Internet: sysop@ledge.com, Compuserve:
  443.     76175,623 or US Mail at the address listed in REGISTER.TXT.
  444.  
  445.     If you contact me on my BBS, please ignore the mail-in validation
  446.     procedure.  Simply leave me a [C]omment with your questions and I
  447.     will validate you as a "visiting Sysop" without delay.
  448.  
  449.     LEDGE SUPPORT: Please note that on your first call to the ledge,
  450.     you can enter the Ledge Support area.  It is a TextView feature
  451.     that will allow you to view the current "TEXTVIEW.DOC" file and
  452.     download the very latest version of TextView. You DON'T have to be
  453.     a registered user on The Ledge to use this service! Please let me
  454.     know you called though so I can validate you for future calls.
  455.  
  456.     While this program performs fine on my system, I can't guarantee
  457.     that it will work at all on yours.  If you have a problem, contact
  458.     me and I will attempt to solve the problem.
  459.  
  460.     ──────
  461.     THANKS
  462.     ──────
  463.  
  464.     Thanks to Samuel Smith, the genius behind Prodoor, ProKit, HS/Link
  465.     and other programs we have all benefited from.  I learned to
  466.     program in Turbo Pascal so I could write the original TextView
  467.     door using Sam's door kit routines.  I have moved on to the
  468.     PCBoard Programming Language, but I still owe Sam a lot for making
  469.     his source code public so I could learn from it.  Sam's Tool Shop
  470.     BBS can be reached by calling (818) 891-6780.
  471.  
  472.     Thanks to Charles Shapiro, Sysop of Absolut(e)ly Temporary (702)
  473.     254-8601 for his valuable help in beta testing TextView.
  474.  
  475.     Thanks to Mark Rapp, Sysop the MicroSellar BBS (201) 239-1346 for
  476.     some great technical suggestions that were very helpful in the
  477.     creation of the original TextView door.
  478.  
  479.     ──────────
  480.     DISCLAIMER
  481.     ──────────
  482.  
  483.     I make no warranty of any kind, express or implied, including
  484.     without limitation, any warranties of merchantability and/or
  485.     fitness for a particular purpose.  I shall not be liable for any
  486.     damages, whether direct, indirect, special or consequential
  487.     arising from a failure of this program to operate in the manner
  488.     desired by the user.  I shall not be liable for any damage to data
  489.     or property which may be caused directly or indirectly by the use
  490.     of this program.
  491.  
  492.     IN NO EVENT WILL I BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY
  493.     LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL
  494.     DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM,
  495.     OR FOR ANY CLAIM BY ANY OTHER PARTY.
  496.  
  497.  
  498.  
  499.  
  500.