Dec 092017
 
Scriptview documentation shareware for Paradox scripts.
File SV.ZIP from The Programmer’s Corner in
Category Paradox DBMS
Scriptview documentation shareware for Paradox scripts.
File Name File Size Zip Size Zip Type
CONTENTS 1429 620 deflated
INIT.SC 271 184 deflated
MANUAL.DOC 52944 14132 deflated
ORDER.FRM 1591 551 deflated
QUESTNRE.TXT 1664 398 deflated
READ.ME 3447 1383 deflated
SAMPLE.DB 1208 143 deflated
SV.DB 21700 2286 deflated
SV.EXE 179389 85401 deflated
SV.HLP 17505 5215 deflated
SV2.DB 18628 2007 deflated

Download File SV.ZIP Here

Contents of the READ.ME file




------ Farpoint ScriptView Version 1.0 README FILE ------
Release 1.1



==============================================================================

Thank you for trying out the demonstration version of ScriptView.
This special release was created to offer you the opportunity to see how
ScriptView can immediately improve your productivity without having to make
a full purchase. Since this is a demo, please feel free to distribute
unmodified copies of this program to your friends, so they too can
"test drive" ScriptView.

==============================================================================

ScriptView
Increasing the Productivity of
Paradox Users and Developers Everywhere

Graphical Analysis

Action diagrams show the structure and logic of your code.
Procedure call diagrams flowchart your entire application.

Documentation and Reports

Variable concordance reports list the location and usage of
each variable by line number and module.
Procedure reports show calls, definitions, and relationships.

Programmers Utilities

Script formatting and case conversion of your source code.
Multi-file string searching and comment extraction/documentation.
PrepareFinal DEToolkit replacement and Writelib insertion utilities
to speed development.
Immediate online scrolling through all diagrams and reports.

More...

Paradox style menus and context sensitive help.
Fully configurable - change settings, options, colors, etc.

==============================================================================

Technical notes for release 1.1

The demonstration release of the user manual should be printed out
using 66 lines/inch.

The variable cross referencer does not cross reference variables which
share the same name as a Paradox reserved word, e.g. using LN as a variable
name. Also, tokens found between TEXT-ENDTEXT and QUERY-ENDQUERY combos
will be ignored.

Process (task) window error messages are logged to an error log. This file
is located in the same directory as sv.exe and is called sv.log. Sv.log is
created each time a new ScriptView session is begun, so please note any
errors created in each session.

ScriptView normally uses the Paradox 2.0 reserved keywords list as a default.
To convert for use with Paradox 3.0 simply rename the file "SV3.DB" as
"SV.DB". This file contains the Paradox 3.0 reserved keywords list. If you
work with both versions of Paradox, be sure to back up the original "SV.DB"
file.

==============================================================================

For more information or to keep informed of new products please write to:

Farpoint Systems Corporation
Washington and York Street
P. O. Box 13093
Jersey City, New Jersey 07303

If you would like to purchase your own copy of ScriptView, you may call
our toll free order number at (800) 336-6644 to place an order.



Contents of the MANUAL.DOC file




------ Farpoint ScriptView Version 1.0 README FILE ------
Release 1.1



==============================================================================

Thank you for trying out the demonstration version of ScriptView.
This special release was created to offer you the opportunity to see how
ScriptView can immediately improve your productivity without having to make
a full purchase. Since this is a demo, please feel free to distribute
unmodified copies of this program to your friends, so they too can
"test drive" ScriptView.

==============================================================================

ScriptView
Increasing the Productivity of
Paradox Users and Developers Everywhere

Graphical Analysis

Action diagrams show the structure and logic of your code.
Procedure call diagrams flowchart your entire application.

Documentation and Reports

Variable concordance reports list the location and usage of
each variable by line number and module.
Procedure reports show calls, definitions, and relationships.

Programmers Utilities

Script formatting and case conversion of your source code.
Multi-file string searching and comment extraction/documentation.
PrepareFinal DEToolkit replacement and Writelib insertion utilities
to speed development.
Immediate online scrolling through all diagrams and reports.

More...

Paradox style menus and context sensitive help.
Fully configurable - change settings, options, colors, etc.

==============================================================================

Technical notes for release 1.1

The demonstration release of the user manual should be printed out
using 66 lines/inch.

The variable cross referencer does not cross reference variables which
share the same name as a Paradox reserved word, e.g. using LN as a variable
name. Also, tokens found between TEXT-ENDTEXT and QUERY-ENDQUERY combos
will be ignored.

Process (task) window error messages are logged to an error log. This file
is located in the same directory as sv.exe and is called sv.log. Sv.log is
created each time a new ScriptView session is begun, so please note any
errors created in each session.

ScriptView normally uses the Paradox 2.0 reserved keywords list as a default.
To convert for use with Paradox 3.0 simply rename the file "SV3.DB" as
"SV.DB". This file contains the Paradox 3.0 reserved keywords list. If you
work with both versions of Paradox, be sure to back up the original "SV.DB"
file.

==============================================================================

For more information or to keep informed of new products please write to:

Farpoint Systems Corporation
Washington and York Street
P. O. Box 13093
Jersey City, New Jersey 07303

If you would like to purchase your own copy of ScriptView, you may call
our toll free order number at (800) 336-6644 to place an order.


















ScriptView(tm) Release 1.0
Demonstration Version
Users Guide
































Copyright 1988-89
All rights reserved
Farpoint Systems Corporation
Washington and York Street
P. O. Box 13093
Jersey City, New Jersey 07303













DISTRIBUTION NOTICE


This software product is furnished under a license agreement by Farpoint
Systems Corporation to you for use only on the terms set forth by the
ScriptView License Agreement. The software may be used or copied only
in accordance with the terms of the agreement. No part of this manual
may be reproduced or transmitted in any form or by any means, electronic
or mechanical, including photocopying and recording, for any purpose
without the written permission of Farpoint Systems Corporation, or as
specified below.

Copyright Farpoint Systems Corporation, 1988-89. All rights reserved.






You are hereby granted a license by Farpoint Systems to distribute
this evaluation copy of ScriptView and its documentation, subject to
the following conditions:

1. The ScriptView demonstration files may be distributed freely
without charge in this evaluation form only.

2. The ScriptView demonstration files must be presented
as a complete unit, including this documentation. This
documentation may be not amended or altered in any way.

3. No modification may be made to any of the ScriptView
demonstration files.


Any other use or distribution of this demonstration program and its
associate files is expressly forbidden without the written consent of
Farpoint Systems.







The trademark notices below apply to product names mentioned in the
manual and software.

MS-DOS is a registered trademark of Microsoft Corporation.

IBM and PC-DOS are registered trademarks of the International Business
Machines Corporation.

Paradox and PAL are registered trademarks of Borland International.













ScriptView

Table of Contents


1. What is ScriptView? . . . . . . . . . . . . . . . . . . . 1

2. About the Manual. . . . . . . . . . . . . . . . . . . . . 2
A. How the Manual is Organized . . . . . . . . . . . . . 2
B. Notational Conventions. . . . . . . . . . . . . . . . 2

3. How to Get Started. . . . . . . . . . . . . . . . . . . . 3
A. Copying the Distribution Disks. . . . . . . . . . . . 3
B. Installation. . . . . . . . . . . . . . . . . . . . . 3

4. Using ScriptView . . . . . . . . . . . . . . . . . . . 5
A. Using the Menu System . . . . . . . . . . . . . . . . 5
B. Getting Help . . . . . . . . . . . . . . . . . . . 5
C. Understanding Messages from ScriptView

5. Using ScriptView to Help You Code Better. . . . . . . . . 6
A. Program Analysis. . . . . . . . . . . . . . . . . . . 6
B. Script Menu . . . . . . . . . . . . . . . . . . . . . 6
C. Using Action Diagrams . . . . . . . . . . . . . . . . 7
D. Using Procedure Call Diagrams and Reports . . . . . . 8
E. Using Variable Cross Reference Reports. . . . . . . .10

6. How to Use the ScriptView Utilities . . . . . . . . . . .11
A. Making Your Scripts Easier to Read. . . . . . . . . .12
B. Searching for Text. . . . . . . . . . . . . . . . . .13
C. A Faster PrepareFinal . . . . . . . . . . . . . . . .14
D. From Procedures to Procedure Libraries. . . . . . . .15
E. Tab Expansion . . . . . . . . . . . . . . . . . . . .15
F. Using Comments as a Form of System Documentation. . .16
G. Viewing your Scripts and ScriptView Output. . . . . .17
H. Printing your Scripts and ScriptView Output . . . . .18

7. Customizing ScriptView. . . . . . . . . . . . . . . . . .19
A. Options Menu. . . . . . . . . . . . . . . . . . . . .19
B. Adding Your Own Keywords to ScriptView. . . . . . . .21

8. Using ScriptView to Prepare System Documentation. . . . .22

9. Error Messages. . . . . . . . . . . . . . . . . . . . . .24

10. Limitations . . . . . . . . . . . . . . . . . . . . . . .27

11. ScriptView Licensing Agreement. . . . . . . . . . . . . .28


















What is ScriptView?

ScriptView is an integrated set of development tools for Paradox users
and developers. It provides script analysis, system documentation, code
formatting, and program maintenance all in one utility.

ScriptView simplifies the development cycle by preparing structure and
procedure diagrams which graphically present the flow of your script.
ScriptView also produces variable cross references which allow you to
track a variable anywhere in your program. When you are done with your
application, you may create system documentation using the project
feature of ScriptView.

Included in ScriptView is a collection of utilities which makes
programming easier. Among the functions available are code formatting,
multi-file string searching, comment extraction, preparation of scripts
for libraries, file viewing and printing. Also included is a version of
PrepareFinal which works better and faster than the one included in the
Data Entry toolkit. Finally, ScriptView never modifies your original
scripts, but creates copies of them as output.

This version of ScriptView has been tailored to make life easier for the
PAL programmer. Most ScriptView options are user configurable and are
saved automatically when exiting. Also enclosed with the distribution
disk is a short script which may be used to allow "hot-keying" right
into ScriptView from the Paradox environment. Happy coding!































- 1 -








About this Manual

This manual was designed for the PAL programmer in mind, therefore a
minimum level of PC proficiency is expected. Users who have used
Paradox and are familiar with its menu structure may quickly browse
through the first 2 chapters and begin using ScriptView. Other users
should read all sections thoroughly.

How this Manual is Organized

This manual is organized to get you started using ScriptView as quickly
as possible. Installation instructions are presented in the third
chapter. The fourth chapter describes the ScriptView environment and
menuing system. The fifth and sixth chapters provide a reference which
describes each of ScriptView's functions and options; these sections are
arranged by menu selection. The seventh chapter describes how to
customize each of ScriptView's option settings, and the eighth chapter
describes how to create system documentation. A list of error messages
and ScriptView's limitations are found in the last two sections.

Notational Conventions

The following notational conventions are used in this manual:

Example Meaning
---------- ----------------------------------------------------

The names of keys are enclosed in brackets. You
should press the corresponding key.

Key combinations are represented by two keynames
enclosed by brackets. You should press the second
key while holding down the first key when you see
this notation.

[toggle] This appears next to menu choices to indicate items
which can be toggled by choosing between two
choices.

[choice] This appears next to menu choices to indicate items
which are choice selections. Pressing on
this selection allows you to choose among 3 or more
choices.














- 2 -









How to Get Started


Minimum System Requirements

ScriptView requires the following minimum configuration:

- An IBM Personal Computer or strict "compatible" with at least
one floppy disk drive. For maximum performance, a hard disk is
recommended.

- MS-DOS or PC-DOS version 2.1 or later.

- 384K RAM or more is recommended.


Before Starting

Before starting, please read through the licensing agreement included at
the end of this manual. Also, remember to complete the questionnaire
included in this archive file and send it in to us as soon as possible.
Your response allows us to keep you informed of ScriptView upgrades and
new product announcements.

Be sure to look at the read.me file included on the distribution
archive file. This file contains any last minute changes and
additions to the user manual.



Installation

Installing ScriptView requires the following steps:

- Copying the ScriptView program files

- Modifying the PATH environment

- Loading INIT.SC (optional)


Loading the ScriptView Program Files

To load ScriptView onto your disk, first create a new subdirectory with
the DOS MD command. We suggest naming this subdirectory C:\SV; however
it can be anything you'd like. Next, copy all the files from the
distribution archive file by issuing the DOS command "copy a:*.* dir";
where dir consists of the name of the subdirectory you created.


Modifying the PATH Environment

After you have finished copying the ScriptView program files onto your
system, you must tell the DOS environment where to find it. Do this by



- 3 -








modifying the PATH statement in your autoexec.bat file to include your
ScriptView subdirectory. If you do not have a PATH statement in your
autoexec.bat file, add the following line with your favorite editor:
PATH = dir where dir is your ScriptView directory.


Loading INIT.SC

Included with the distribution diskette is an INIT script which allows
you to "hot-key" into ScriptView from Paradox. If you copy the script
into your default Paradox subdirectory, it will load automatically when
you run Paradox. You can then use to pop into ScriptView from
Paradox. If you already have an INIT script, just copy ours into your
version using your favorite editor. Be sure to modify the script if you
have copied the ScriptView programs into a subdirectory other than
C:\SV!









































- 4 -








Using ScriptView

Run ScriptView by typing "sv" and pressing at the DOS prompt.
After ScriptView is finished loading, you will see the logo screen.
Press any key to continue to the ScriptView main menu. The first time
you run ScriptView, you will be prompted for your name and company
before seeing the main menu. After this initial setup, you will only
see the main menu.

Using the Menu System

ScriptView interacts with you via the familiar Paradox-style menus and
popup windows. The ScriptView main menu is located on the top two lines
of the screen. The main menu is organized by ten selections each having
their own submenus. The ten selections are Script, Action, Calls, Xref,
Tools, Print, Info, Options, Help, and Exit.

You may use the and keys to navigate around the main menu
and to select your choice. You may also select a choice by
pressing the first letter of the item. If you wish, pressing will
bring you up to the main menu. Many of the choices in the submenus are
option settings. You press to toggle them on and off. Any
processing that occurs in the menu will now reflect your choice. To see
a window containing the most important ScriptView settings, you can
press <=> or <-> from most screens.

Getting Help

ScriptView provides a basic help system to guide you if you need
assistance. You may press F1 from almost any screen to pop up a help
window. This window will display some reference information to help you
on your way. When you are done reading, press any key to continue.

Understanding Messages from ScriptView

ScriptView communicates messages to you via two areas of the screen.
These areas are the process window, and message window.

Process Window

The process window indicates the status of the present operation. This
window appears when processing is occurring (an example would be if you
are currently creating an action diagram). It shows the source file,
output file, current operation, and current line. Any warnings are also
indicated. This window disappears when your current operation is
completed.

Message Windows

The message window is an area located in the bottom right area of the
screen. ScriptView uses this area to display various messages,
including errors. When you are done reading such a message, you may
press any key to continue.




- 5 -








Using ScriptView to Help You Code Better


Program Analysis

ScriptView helps you code better by giving you a better picture of your
program than you would normally have. ScriptView offers you different
"views" which are helpful in both design and debugging. Action
diagrams, popularized by James Martin, show the structure and logic of
your code. Procedure call diagrams show the flow of your application
from one procedure to another. Variable cross reference reports show
which procedures are using your variables and where. Each of these
reports can be used in its own way to give you control over your
application when you are programming.


SCRIPT MENU

It is important that you familiarize yourself with this menu before you
begin. This is because any primary reporting activity starts here.
From here you will specify the name of a script to document single
scripts, or a project table to document multiple scripts. The possible
menu selections are:


Script

Specifies the script used in the Action, Call, and Xref menus.
You must enter the script name here if you are performing any of
the above operations.

Project

Opens the project menu for system documentation.

List Directory

Lists all files in a directory. Wildcards may be used.



















- 6 -








Using Action Diagrams


Action diagrams show the overall structure of your program. You can use
action diagrams to provide an overview and structured control view of
your code, and to locate hard to find bugs. Hard to see nested
structures are graphically diagrammed. Hidden breaks out of loops can
be revealed. Examples of action diagrams are included in the
accompanying ARC file (SVOUTPUT.ARC). For more detailed information on
action diagrams and diagramming techniques, see Recommended Diagramming
Standards for Programmers and Analysts by James Martin.

ACTION MENU

The possible selections in this menu are:

LineNumbers [toggle]

Specifies whether to include line numbers in the output file.

Graphics [toggle]

Specifies whether to use IBM graphics characters for line drawings.
Otherwise, uses ASCII text characters. If your printer does not
support the full IBM character set, toggle this off.

OutlineView [toggle]

Specifies whether to create the diagram in OutlineView. A diagram
created in OutlineView only includes those lines of the script
which form the structure of the diagram. Also, included are lines
beginning with comments. This option is helpful for condensing
large programs for viewing.

Show [toggle]

Specifies whether to immediately view the output upon completion of
processing. Instructions for using the file browser are in the
Utilities section of this manual. If you would like to speed up
diagramming or find that you need more memory to complete an
operation, try toggling this selection off. This tip also applies
to the Calls and Xref menus.

Do_it!

Begin diagramming of the script. An output file with a default
extension of ".ACT" is created in the output directory. Note:
remember to enter the name of the script in the Script menu before
beginning.








- 7 -








Using Procedure Call Diagrams and Reports


What Are They?

Procedure call diagrams graphically show the flow of your procedures.
If one procedure calls another, a line is drawn from the first to the
other showing the relationship. A complete call diagram is a tree
representing these relationships, beginning with the main calling
script. Procedure reports show where procedures are defined and who is
calling them. Both the diagrams and reports can be used together to
provide you with a view of how your program is running. You may obtain
procedure diagrams and reports via the calls menu.


CALLS MENU

Choosing the calls menu brings up two submenus:

- Procedure Calls Tree

- Procedure Calls Report


PROCEDURE CALLS TREE MENU


Type 1 (calls) [choice]

Includes only procedure calls (on the main call tree) in the
diagram. Recursive calls are noted.

Type 2 (definitions) [choice]

Includes only procedure definitions (on the main call tree) in the
diagram. Multiple definitions of the same procedure cause
unexpected results.

Type 3 (both) [choice]

Includes all procedure calls and definitions in the diagram. See
notes above on calls and definitions.

IgnorePdox [toggle]

Specifies whether to include Paradox functions in the call report.
The default is to skip Paradox functions.

Graphics [toggle]

Specifies whether to use IBM graphics characters for line drawings.
Otherwise, uses ASCII text characters. If your printer does not
support the full IBM character set, toggle this off.




- 8 -








Compact [toggle]

Normally, the diagram is double-spaced, i.e. an empty line
separates each actual line. Toggling this option on creates a
single-spaced diagram.

Show [toggle]

Specifies whether to immediately view the output upon completion of
diagramming.

Do_it!

Begins diagramming of your script. An output file with a default
extension of ".CLL" is created in the output directory.


PROCEDURE CALLS REPORT MENU

Definitions [toggle]

Includes a definition summary in the output file. The definition
summary shows where procedures are being defined.

Calls [toggle]

Includes a procedure call report in the output file. The call
report shows all procedures called by a procedure.

Callers [toggle]

Includes a caller report in the output file. The caller report
shows all procedures which may call a procedure.

IgnorePdox [toggle]

Specifies whether to include Paradox functions in the call report.
The default is to skip Paradox functions.

Show [toggle]

Specifies whether to immediately view the output upon completion of
processing.

Do_it!

Begins report generation. The output file has a default extension
of ".REP". Note: remember to select (toggle on) at least one of
the report types listed above before choosing Do_it!








- 9 -








Using Variable Cross Reference Reports


ScriptView supplies three different types of variable cross reference
reports. The reports show variables and the line numbers they appear
in. Each report also shows where a variable may be changed due to any
assignment statement. This is indicated by an "=" next to the line
number. Only tokens meeting the Paradox criteria for a variable are
processed. Field names are also considered variables for ScriptView's
reporting. Included at the end of each report are basic statistics.

XREF MENU

Type (1) [choice]

Generates a report listing for each variable in alphabetical order.

Type (2) [choice]

Generates a report listing showing each variable and which
procedures it appears in.

Type (3) [choice]

Generates a report listing showing each procedure and which
variables appear in it.

Show [toggle]

Specifies whether to immediately view the output upon completion of
processing.

Do_it!

Begins processing of the report. The output file has a default
extension of ".XRF".





















- 10 -








How to Use the ScriptView Utilities


ScriptView provides several utilities to streamline the development
cycle. These utilities are categorized under their menu names as
follows:



- Format Script

- Search

- PrepareFinal

- InsWriteLibs

- TabExpand

- Comments

- View

- Print

































- 11 -








Making Your Scripts Easier to Read


ScriptView may be used to format your code for better readability using
the Format command. This will perform script indentation to ensure a
proper and uniform indentation of your code, and also customize the
appearance of Paradox reserved words and user variables. As a bonus,
you may include your own list of reserved words for ScriptView to use.
This latter feature may also be used to add keywords for new releases of
Paradox. To learn how to do this, please read the section detailing how
to customize ScriptView. The following sections describe the various
tools you can use to expedite your development.

FORMAT MENU

Script

Selects the script for this operation.

Reserved [choice]

Specifies the case of the reserved words to appear in the output
file. Case can be: UPPERCASE, lowercase, or Proper.

User [choice]

Specifies the case of the user defined keywords as they should
appear in the final output. Case can be: UPPERCASE, lowercase, or
As-is. The latter option represents the case of the keyword as
found in SV.DB, the reserved keyword table; e.g. if the keyword
"newproc" appears as "NewProc" in this table, it will appear as
"NewProc" if As-is is chosen. Note: you can add your own keywords
to SV.DB as long as they are shorter than 132 characters in length
and do not match any existing keywords in the table.

Other [choice]

Specifies the case of any other variables which are not in the
reserved or user keywords list. Case can be: UPPERCASE,
lowercase, or As-is.

Do_it!

Begins the operation. The output file has a default extension of
".SC2".












- 12 -








Searching for Text

During the development cycle, you may want to reuse an old procedure you
have buried in some script. Unfortunately, you have dozens of scripts
in your directory. Instead of using your text editor to check each
script individually, you can use ScriptView. ScriptView's string search
feature gives you the capability to search one or more files for a text
string. Each occurrence is counted and saved to an output file. If you
choose to search only one file, an output file with a default extension
of "SCH" is created on your disk. By choosing Group, all output will be
directed into a file called "svsearch.sc."

SEARCH MENU

FileSpec/Script

Specifies the script to begin searching in. Wildcards *? may be
used if Group is chosen.

Group [toggle]

Determines whether to search a single script or multiple scripts.
Toggle this on to search all files matching a filespec. String
Specifies the string to search for. The text string may consist of
up to 60 characters long.

Words[toggle]

Specifies whether to match delimited words only.

Case [toggle]

Specifies if the search is to be case sensitive.

Do_it!

Begins the text search. Matches are made regardless of whether
they are in comments or quotes, etc. The default name of the
output file when Group is toggled on is "SVSEARCH.SC".


















- 13 -








A Faster PrepareFinal

The Data Entry Toolkit supplied with Paradox includes a feature which
substitutes TK variables with their correct values and removes all
references of TKDebug(). Unfortunately for Toolkit programmers, this
feature is slow and doesn't work all the time (in Paradox 2.0).
ScriptView supplies an alternative which works better and faster. It
also checks for quote and comment characters, and TEXT-ENDTEXT,
QUERY-ENDQUERY combinations.

PREPAREFINAL MENU

Script

Specifies the script for this operation.

TKeycodes [toggle]

Specifies whether to substitute all occurrences of TK variables
with their corresponding keyboard values.

DebugProcs [toggle]

Specifies whether to remove all occurrences of TKDebug debugging
procedures from the script.

Do_it!

Begins this operation. PrepareFinal is smart enough to avoid any
TK variables or TKDebugs found enclosed in comments, quotes,
TEXT-ENDTEXT or QUERY-ENDQUERY. The output file has a default
extension of ".PF".

























- 14 -








From Procedures to Procedure Libraries

The Usual Routine

To many PAL programmers, the development cycle means prototyping an
application by using procedures and "playing" them when running a
script. This allows the programmer to skip the tedium of managing
procedure libraries. Only when it becomes necessary, do they go in with
their editor and insert writelib and release procs statements after each
of their procedure definitions. ScriptView provides a speedy way to
automate this step. It scans your script for procedures and inserts the
writelib/release procs combination for you. Of course, this is only a
quick fix. For those who have multiple procedure libraries, both
shareware and commercial library managers are available.

INSWRITELIBS MENU

Script

Specifies the script for this operation.

Library

Specifies the name of the library to be created. This library will
appear in each createlib and writelib statement. Be sure to
include double "\"s in the path, e.g. "C:\\PARADOX2\\ORDER".

RemoveExisting[toggle]

Specifies whether to remove any existing writelib statements to
avoid redundant procedure creation.

Do_it!

Begins the operation. The default extension of the output file is
".WLB".


Tab Expansion

ScriptView provides features to handle tab expansion in your scripts.
Tab expansion is necessary because some older printers cannot handle the
tabs inserted by your editor. To manage this possibility, ScriptView
performs tab expansion by replacing tabs with enough space characters to
bring a line to the next tab stop. This process occurs when you print
output files in ScriptView. Please note that this occurs only to the
output and not to your original file. If you print your output through
some other form and are having problems printing tabs, you can use
ScriptView's tab expansion function to permanently remove any tabs in
your script. The tab length specified in the options menu is used for
this operation. The output file has a default extension of ".TAB".

There is no menu for this function.




- 15 -








Using Comments as a Form of System Documentation

The Technique (documenting as you go)

Commenting your code has always been useful for leaving remarks or
reminders. As an extension, you may also use comments as a form of
system documentation. By selectively placing them around important
sections of your code, you can "document as you code." When you are
finished, you can use ScriptView to scan your script and copy each
commented line to an output file. For example, you can place commentary
around an obscure but important procedure in your script. Later on, you
can extract those lines as part of your system document! For those who
believe that comments clutter up their code. ScriptView supplies a
function to remove all those once useful reminders.

REMOVE COMMENTS MENU

Script

Specifies the script for this operation.

Remove [toggle]

Specifies whether to create a copy of the script with all comments
removed. The output file has a default extension of ".CM1".

Copy [toggle]

Specifies whether to create an output file containing all commented
lines. The output file has a default extension of ".CM2".

Do_it!

Begins this operation.























- 16 -








Viewing Your Scripts and ScriptView Output

ScriptView includes a standard file browser. This file browser may be
used to view scripts and documents. Built into the browser is a string
search function which zooms you to the occurrence of a text string.

View Commands

Movement

Move cursor [Up],[Down]

Jump to beginning/end of file [Home],[End]

Move to next/previous page [PgDn],[PgUp]

Move left/right 40 columns [Ctrl]-[Left],[Ctrl]-[Right]

Goto line # [G]

Move # lines forward/backward [+],[-]

Other

Search for text string [Ctrl][Z]
Case sensitive C
Words only W
Search backwards B
Search from beginning of file G

Find next occurrence [Alt][Z]

Toggle expansion of tabs [T]
























- 17 -








Printing Your Scripts and ScriptView Output

ScriptView supplies a standard printer utility. You may use this
utility to output your scripts and documents to the standard printer
device (PRN). If you would like, you may change any of the default
printer settings in the Options menu.

PRINT MENU

File

Specifies the script or file to print.

FormFeed

Sends a form feed character (^L) to the printer.

LineNumbers [toggle]

Inserts line numbers in the output.

Do_it!

Begins printing. You will be prompted whether to send the output
to disk or printer.
































- 18 -








Customizing ScriptView


When you first loaded ScriptView, you were using it in its default
environment. These options and settings were chosen to help get you
started as soon as possible. As you began using ScriptView you learned
that you could customize the settings very easily. In this section, you
will find out how to customize the rest of ScriptViews options. You
will also find out how to add user defined keywords to the ScriptView
reserved words list. With this powerful capability, you can be sure
that your version of ScriptView can be compatible with future releases
of Paradox!

Using AutoSave!

When you alter a setting or option, ScriptView stores the environment in
a file called SV.INI and keeps it in your ScriptView subdirectory. That
way, it can "remember" your settings for your next session. There is no
need to select a "save options" command. All that you have to do is
exit!

OPTIONS MENU

The following options may be changed via the options menu:

Header

Specifies the system header information added to each report.

Include Header [toggle]

Each time you create a report or diagram, you can choose to include
a header in the output. This header contains the script name,
programmer name, copyright holder and date, and file modification
statistics. The Include Header option tells ScriptView whether to
add this header each time. The Header option tells ScriptView what
the header contains.

MultiSrch

ScriptView stores the output of the String Search function in an
output file. This output file defaults to "SVSEARCH.SC" when you
are performing multi-file (Group) searches. You may change the
name of this file with this option.

Directory

The source directory tells ScriptView where it should look for your
scripts and project tables. The output directory tells ScriptView
where to store the output of its processing. You may change the
names of these directories, otherwise ScriptView will use the
default values or the current directory if those no longer exist.





- 19 -








Tab

You may change the default tab length used by ScriptView here.
This tab length is used in action diagramming, script indentation,
and tab expansion.

Printer

You may customize each of ScriptView's printer options here.
Please note that indicating "wild" values, such as margins which
are larger than the page length, will cause unexpected results.

Extensions

When you use ScriptView to process your script, it stores the
output in a file on your disk. This file shares the same name as
the input file except for a special extension reserved for the
function you were performing. These file extensions may be changed
to suit your tastes by selecting this menu.

Colors

Each of ScriptViews screen colors may be customized to suit your
individual tastes. You may experiment with each until you find the
combination you like.

Splash

This option turns off/on the display of the splash screen when you
start ScriptView. Turn this off if you intend to call ScriptView
from within Paradox.


























- 20 -








Adding Your Own Keywords to ScriptView's Dictionary


ScriptView keeps an internal dictionary of all the keywords it uses in
processing your scripts. This dictionary contains all the reserved
keywords for the current DOS release of Paradox. The dictionary is used
in creating procedure call reports/diagrams and variable cross reference
reports, and in Format Script.

You may add to this dictionary to make your copy of ScriptView
compatible with other releases of Paradox, or to add your own keywords
for processing in Format Script. To do this you have to modify the
table "SV.DB" included on your distribution diskette. The process to do
this is relatively simple. Just run Paradox, and edit the table as
follows:

1. Insert a new record into the table where your new keyword would
appear if in alphabetical order, e.g. if the new keyword is "PgUp,"
the record should go after the record for "PgDn."

2. The first field, [Keyword], should contain your keyword as you
would like it to appear when "As-is" is selected in the Format
Script menu. An example would be "NewProc."

3. The second field, [Type], should contain the type of the keyword,
i.e. "P" for Paradox reserved word, or "U" for user defined
keyword. As a rule, if you are adding this keyword because you are
upgrading to another release of Paradox, choose "P", otherwise
choose "U."

4. Press Do_it! and you're finished.


























- 21 -








Using ScriptView to Prepare System Documentation

ScriptView provides a project capability which allows you to prepare
system documentation when you are finished developing an application.
You can select any or all of the main ScriptView reports to include in
this output. You simply indicate to ScriptView the name of the scripts
which are part of your project. You can do this by creating a project
table. ScriptView does the rest!

Project Tables

ScriptView uses the concept of a project table to automate system
documentation. A project table contains all the scripts used in a
project. When ScriptView opens a project table, it reads in the names
of all the scripts and begins documenting them. For each report, it
uses the default settings as specified in the Action, Calls, and Xref
submenus. To see these settings, press <=> or <-> from most
screens.

You can create your own project table inside Paradox. Simply create a
non-indexed table which contains as its first field an alphanumeric
field (eg. A50). You can give this table any legal name. We suggest
that you use the name of the main calling script of your project;
however anything will do.

After you have created the table, you can start entering script names
into it using the Paradox edit command. You must use the full path name
of each script, e.g. "C:\Paradox2\Customer.Sc." The main calling script
(if any) should be in the first record. This requirement is needed if
you wish to create a single call tree for your tree diagrams. Note: a
sample project table is contained on the distribution archive file as an
example.

Once you have created a project table, you can let ScriptView begin
documentation by entering its name under the Project menu. This can be
found under the Script menu selection in the main menu. Once ScriptView
has accepted the name of your project table, it checks it for valid
script names. If any are found, an image of the table is displayed on
the workspace for confirmation. When ready to continue, you can then
press to see the Use Project menu. You may use this menu to
toggle which reports you would like created. To start documentation,
press .















- 22 -








Listed below is the Use Project menu and its choices.

USE PROJECT MENU

This menu allows you to specify the types of reports you would like in
your documentation. The default settings for each report are used. Use
to mark the desired selections, then Do_it! to begin.

Include Source Listings [toggle]

Creates an indented source listing of each script in your output.

Action Diagram [toggle]

Creates an action diagram for each script.

Procedure Call Tree [toggle]

Creates a separate procedure call tree for each script if no "main"
script is specified. Otherwise, creates one procedure call tree
containing all the scripts in the project, beginning with the
"main" script as the root. You will be asked whether the first
script in your project file is a "main" script if you select this
report option.

Procedure Calls Report [toggle]

Creates a procedure call report for each script.

Variable Cross Reference [toggle]

Creates a variable cross reference report for each script.

Overwrite Existing Files [toggle]

Normally, ScriptView will ask you if an existing output file should
be overwritten. This option disables that warning.

Print Documentation [toggle]

Prints each report in one continuous document if printing to a
file; otherwise sends output to the printer device. If printing is
not enabled, only the reports and diagrams will be created on your
disk.

Do_it!

Begins system documentation









- 23 -








Error Messages

This section describes each of ScriptView's error messages and lists any
action that should be taken. Messages are listed in alphabetical order.

Cannot load Sv.hlp

ScriptView could not load its internal help file. Please make sure
the file sv.hlp exists in the same directory as sv.exe, and that it
is not corrupted.

Disk is write protected

ScriptView is attempting to write to a disk which is write
protected. Please remove the write protect tab to continue.

Drive not ready

The drive door containing the output disk is open. Please close
the drive door to continue.

*** Error! Not Expecting KEYWORD ***
*** Error! Expecting KEYWORD ***

ScriptView has detected an improper structure or loop in your
script when it was indenting or action diagramming. Please examine
your script for errors. Note: this message does not appear on the
screen; it is inserted into the output file where the error occurs.

Error reading project table

ScriptView encountered an error reading your project file. Please
ensure that the file is not corrupted.

Error opening file

An error occurred while ScriptView was attempting to read a file.
Check your file for errors.

Error reading keywords

ScriptView encountered an error reading your user keyword file.
Please check your file for errors.

Error writing to file

An error occurred while ScriptView was creating a file. Check your disk
for errors or sufficient storage.

Insufficient memory to run ScriptView

You do not have enough memory to begin a ScriptView session. The
minimum suggested RAM requirement is 384K.




- 24 -








KEYWORD already defined

ScriptView has detected multiple definitions of the same procedure
in your script. Please investigate.

Maximum lines reached

This message can occur when ScriptView is documenting a script and
Show Output is toggled on, or when you are attempting to View a
text file. This message occurs because ScriptView's viewer can
only handle output with 10000 lines or less. If you are
documenting and this occurs, retry with Show Output toggled off.

Max nested lvl exceeded

ScriptView cannot complete the action diagram or indentation
because your script contains more than 256 nested levels.

No report settings specified

This message appears when you choose to include procedure call
reports in the USE PROJECT menu, but have not specified any report
types in the CALL REPORTS menu. Toggle this option off or enter
the CALL REPORTS menu to choose report types.

No valid scripts in table

The project table you specified either does not contain any scripts
or contains scripts with illegal path names. Check your project
table to see if the path names exist on the disk.

Not enough memory.

The present operation does not have enough memory to complete.
Please increase the amount of memory available to ScriptView or
reduce the size of your script. Be sure to remove any memory
resident programs.

Printer off-line.

Your printer is off-line. Please fix it and press any key to
continue.

Printer out of paper

The printer is out of paper. Please insert more paper to continue.

Script is encrypted

The input script is either encrypted or not a readable script file.
Please unencrypt your script.






- 25 -








ScriptView requires DOS 2.1 or later

To run ScriptView, you must have DOS version 2.1 or later on your
system.

Too many nested loops

There were too many nested loops and/or structures for ScriptView
to produce an action diagram or indent your script. Increase your
available memory or reduce the depth of your loops.

Unmatched ENDPROC

ScriptView has detected too many ENDPROC statements in your script.











































- 26 -








Limitations

ScriptView has the following requirements when analyzing and documenting
scripts:

Maximum script line length of 512 characters

Maximum lines in script that View or Show Output can process is
10000. You can avoid this limit by toggling Show Output to off
when documenting.

ScriptView cannot understand EXECUTE statements when processing
scripts. For example, if you change the contents of a variable via
the EXECUTE statement, ScriptView has no way of detecting that.

Variables and procedure names with more than 132 characters are
ignored.

When diagramming procedure calls, multiple definitions of the same
procedure are ignored.

Unexpected results may occur if a Paradox reserved word is used for
a procedure name.

Every attempt has been made to anticipate the different coding
styles. Because of this, ScriptView is able to process almost any
script submitted. ScriptView, however, cannot process scripts
which are encrypted, which are syntactically incorrect, or which
contain unusual coding patterns. Unusual coding may be when a
script contains all commands on one line(!) or have one word on
each line.


























- 27 -








ScriptView License Agreement

This is a legal agreement between you, the end user, and Farpoint
Systems Corporation.

Farpoint Software License

The software is owned by Farpoint Systems Corporation and is protected
by United States copyright laws and international treaty provisions.
Therefore, you must treat the software like any other copyrighted
material, such as a book, with the following exception. Farpoint
Systems Corporation authorizes you to use and distribute copies of
the ScriptView demonstration programs as a whole unit. You may not
modify or reverse-engineer the software. You may NOT rent or lease the
software.

This program (software) and users guide are provided "as is," without
any warranty as to their performance, merchantability, or fitness for
any particular purpose. The entire risk as to the results and
performance of this program is assumed by you.

Your sole and exclusive remedy for breach of this warranty shall not
encompass any damages, including but not limited to loss of profit, and
special, indirect, consequential or other such claims.

Farpoint Systems Corporation specifically disclaims all other
warranties, expressed or implied.



























- 28 -


 December 9, 2017  Add comments

Leave a Reply