Category : Miscellaneous Language Source Code
Archive   : CSD108.ZIP
Filename : MANUAL.TXT

User Guide




Introduction

This section of the manual describes how each function in
CSDedit operates. There are seven main sections:

Display: describes the CSDedit display screen.
Menus: describes characteristics of menus.
Edit CSD's: describes CSD editing operations.
File menu: describes each File menu item.
Edit menu: describes each Edit menu item.
Design menu: describes each Design menu item.
Utility menu: describes each Utility menu item.



Display


First let's look at the CSDedit display screen. There are
three regions on the screen: the Main Menu, the display
area, and the message area.

At the top of the screen is the Main Menu. Each item in the
Main Menu is discussed below.

The largest area on the screen is the display area.


At the bottom of the screen is the Message Area. All error
messages, warnings, etc. are displayed in the Message Area.

The flags in the upper right hand corner indicate the
following:

COMMENT: a comment will be added to If-Then-Else and
Case-When CSD's when they are created.

Caps: the keyboard Caps Lock is on -- all typed
characters will be upper case.

NumLck: the keyboard Num Lock is on -- all keypad
characters will be numerals.

Ins: the Insert mode is on -- all typed characters will
be inserted into the text instead of replacing
text.
CSDedit 1

Menus


All menus in CSDedit have several features in common:

- Any menu can be directly accessed with the key combination
consisting of the key and the first letter of the
desired menu. For example, the Utility menu is accessed
with the key combination.

- Once a menu has been opened, the and
keys are used to move the user through the
menus in a circular fashion. For example, when using the
key, the Utility menu follows the Edit menu,
and the File menu (on the far left) follows Utility (on the
far right).

- Individual items from within an open menu can be selected
by using the and keys to move up or
down to the desired item. The item is executed when the
user hits .

- Menu items that produce another menu are indicated by
three dots (...) in the menu item. For example, the
"Export..." command in the File menu produces several more
menus before any action is taken by CSDedit. Other menu
items are executed as soon as the menu item is selected.
The "Quit", and "Toggle Comments" commands are good examples
of this type of menu item.

- Once a menu has been opened, the individual items within
the menu may be selected by typing the first letter of the
desired selection. This is equivalent to selecting an item
with the and keys and hitting
.

- The user can back out of any level of menu commands, one
level at a time, with the key. The key is an
undo key for the last menu choice, unless the choice
executed immediately.

- The keyboard equivalent of the menu command is presented
on the far right side of the menu. These keyboard shortcuts
are not executable while the menus are open. They serve as
reference and reminder. The keyboard commands are only
executable from the display area. Some menu items do not
have keyboard equivalents.

- Some of the subsequent dialog boxes have default settings
displayed. This course of action will be taken if the user
does not specify otherwise. Defaults will be specified with
asterisks. Default filenames will appear in filename boxes.

CSDedit 2

Editing CSD's

Overview


There are several different types of operations which are
needed to edit a design. Some of these operations are
familiar word processing operations. Other operations are
needed to add, change, and delete CSD's and groups of CSD's.
Some of these operations may be a bit awkward at first.
There are also some word processing capabilities which are
not present.




Insert


The insert mode is toggled on and off with the insert key.
The insert key status is shown in the upper right corner of
the screen. While in the insert mode, will add new
blank line of text.


 If the cursor is located beyond the midpoint of the text
on the current line, then a blank line will be inserted
After the current line.
 If the cursor is located before the midpoint, then a
blank line will be inserted Before the current line.

WARNING: If the line has NO text on it, a blank line will
be inserted After the current line.


In a block structured environment you can request that a
blank line be inserted in locations which do not make any
sense. For example, it is not logical to insert a blank
line before or after the "Then" section of an If-Then-Else
CSD. How does CSDedit respond? It moves the cursor down
one line. Here are the rules:

Insert will always work on:
a line of text
a closed Refinement CSD
a closed Repetition CSD

It will also work on:
a closed If-Then-Else CSD which has a comment
a closed Case-When CSD which has a comment
CSDedit 3

It will never work on:
an "If" section of an If-Then-Else CSD
a "Then" section of an If-Then-Else CSD
an "Else" section of an If-Then-Else CSD
a "Case" section of a Case-When CSD
a "When" section of a Case-When CSD
a "Else" section of a Case-When CSD



Delete


Lines of text and CSD's can be deleted by placing the cursor
anywhere on the line and pressing the key.
Lines of text are deleted from the code and design with a
single keystroke. If you ask to delete the "Else" section
of an If-Then-Else CSD, the entire If-Then-Else CSD will be
deleted. When you attempt to delete an entire CSD CSDedit
requests permission to delete the entire CSD.


DANGER: Opening and closing CSD's allows you to reduce
many lines of design to one line. When you delete a CSD,
you also delete everything "inside" it. Thimk before you
permit CSDedit to remove an entire CSD.



Edit a Line of Text


Editing text within a line is like any typical word
processor:

move the cursor to the first character of the
current line.
move the cursor to the last character of the
current line.
move the cursor up one line.
move the cursor down one line.
move the cursor to the character
immediately to the left.
move the cursor to the character
immediately to the right.
deletes the current character.
The Insert mode is toggled on and off. When
CSDedit is in the insert mode new keystrokes are
added in front of the current cursor position.
Otherwise, the new keystrokes overwrite the
current characters on the line. The insert mode
flag is displayed in the upper right-hand corner
of the display area.
CSDedit 4

File Menu


Overview



Load -- an Existing file


The Load command produces a dialog box prompting the user to
provide the name of an existing CSDedit file. The user must
specify the entire name, including the extension and the
path. If the file is in the current directory, you may omit
the drive and path.


WARNING: At least one version of DOS does not handle
"relative" paths correctly. Always provide the full path
name (including the drive) for any file not in the current
directory.




New -- create a New file


The New command is very similar to the Load command. The
same dialog box is produced. The user is asked to specify
the filename and extension to be created. Include the path
if the file is not to be placed in the current directory.

WARNING: At least one version of DOS does not handle
"relative" paths correctly. Always provide the full path
name (including the drive) for any file not in the current
directory.


Export ... -- Export design


Overview


As soon as "Design ..." or "Code ..." is selected, another
menu and a window which contains the current export
parameters will appear.
CSDedit 5

Design...


This selection produces another menu and the "Export Design
Parameters" window. Use the menu to change any of the
export parameters.

Destination - The default is the printer (filename
PRN), but the user may specify any legal DOS
filename or device

View CSD's - There are two selections. They are
mutually exclusive:

Don't Force (default): the CSD's are Exported as
they are displayed on the screen. If CSD's
are closed, they will be closed when they are
exported.

Force Open: each CSD is expanded completely before
it is Exported. (The display is not
changed).

Export Now! - After the export parameters are set, use
this menu item to export the design.



Quit -- Exit from CSDedit


The Quit command exits and returns the user to DOS. The
CSDedit file is automatically saved.


CSDedit 6

Edit Menu


Overview



Select -- Select block(s) to cut or copy to Scrap


Press to begin selecting multiple CSD's. The current
CSD or line of text will be highlighted.
Expand and Contract the current selection with the
or keys. All lines, and CSD's
between the original cursor position and the final cursor
position will be selected. The possible selection is
limited to the "level" which you are on. An error message
will appear in the message area when you reach either end of
the possible selection. If you need CSD's at a higher
level, hit to exit from the selection mode. Then use
the and keys to move to a higher
level. Re-enter the selection mode and continue.


Select: Copy the selection


Use to copy the highlighted selection to the
scrap. The display will be updated and the selection
process canceled after the copy operation. The selection
remains in the scrap until it is overwritten by another cut
or copy operation.



Select: Cut the selection


Use to cut the highlighted selection from its
current location and place it into the scrap. The display
will be updated and the selection process canceled after the
cut operation. The selection remains in the scrap until it
is overwritten by another cut or copy operation.


CSDedit 7

Paste


The scrap contents are pasted before or after the currently
selected line with the key.


 If the cursor is positioned past the midpoint of the
text on the current line, the Scrap will be inserted after
the current line.
 If it is before the midpoint, the Scrap will be inserted
before the current line.


The display will be updated. You may paste the scrap into
the design any number of times. The paste operation does
not empty the scrap.
Some paste operations are nonsensical. For example, select
an If-Then-Else CSD and cut or copy it to the scrap. Next
move the cursor to the "Then" section of any If-Then-Else
CSD. Finally try the paste command. This is not permitted.
Open the "Then" section, move the cursor down one line, and
try the paste command. This will work.



Find ... -- Search for a pattern


The Find command is used to find a pattern anywhere in the
design and/or code.



Setup -- Setup find parameters


When the Setup command is selected, another menu and the
"Find Parameters" window are displayed. Use the menu to
change any of the parameters displayed in the window.

Pattern - Enter the pattern you want to find.

Insensitive - the user can request that CSDedit not
consider the case of the pattern during the
search. By default, the pattern match is
insensitive to case.

CSDedit 8

Forward -- search forward for pattern


Search for the pattern in the forward direction. The search
begins at the current cursor location. It will stop when it
finds the pattern or the end of the design. Continue
searching for the next match by reissuing the Forward
command.



Backward -- search backward for pattern


Search for the pattern in the backward direction. The
search begins at the current cursor location. It will stop
when it finds the pattern or the beginning of the design.
Continue searching for the next match by reissuing the
Backward command.



Delete -- Delete a CSD or line of text


The delete command will remove the current line or CSD.
Note that it removes the entire CSD. If the deletion of a
CSD is attempted, the user will be asked whether the entire
block should be removed.


DANGER: Opening and closing CSD's allows you to reduce
many lines of design to one line. When you delete a CSD,
you also delete everything "inside" it. Thimk before you
permit CSDedit to remove an entire CSD!


Delete 'When' -- Delete "When" section of a Case-When CSD


This command removes extra "When" section of a Case-When
CSD. You may not remove all of the "When" sections


Open CSD -- Expand the current CSD


Expand the CSD at the present cursor location. Only the
current level is expanded.


CSDedit 9

Close CSD


Close the current CSD or close the Code CSD at the current
location.

Design Menu


Overview




Refinement -- Create a Refinement CSD


Convert the current line into a Refinement CSD. The
Refinement CSD will be closed.


If-Then Else -- Create an If-Then-Else CSD


Convert the current line into an If-Then-Else CSD. The
result of this operation can create two results:

If the COMMENT flag is off, the existing text disappears
(it's becomes the comment on the If-Then-Else CSD -- but
doesn't show!). If the COMMENT flag is on, the existing
text becomes a comment for the If-Then-Else CSD. Note that
the CSD is initially closed. See "Add/Remove Comment" menu
item below. (See the "Toggle Comment" item on the Utility
menu).



Repetition -- Create a Repetition CSD


Convert the current line of text into a Repetition CSD. The
Repetition CSD is generic. It can represent any type of
loop or repetition found in any modern programming language.
The Repetition CSD will be closed.


Case -- Create a Case-When CSD


Convert the current line into a Case-When CSD. The result
of this operation can create two results:

CSDedit 10

If the COMMENT flag is off, the existing text disappears
(it's becomes the comment on the Case-When CSD -- but
doesn't show!). If the COMMENT flag is on, the existing
text becomes a comment for the Case-When CSD. Note that the
CSD is initially closed. See "Add/Remove Comment" menu item
below. (See the "Toggle Comment" item on the Utility Menu).


When -- Add another "When" section to a Case-When CSD


A Case-When CSD is created with two "When" sections. Use
this command to add another "When" section.


Add/Remove Comment


This operation only applies to the If-Then-Else and Case-
When CSD's. Refinement and Repetition CSD's always have a
comment. Use the Design menu or press .


NOTE: Adding a comment to the If-Then-Else and Case-When
CSD's allows them to become a single line when they are
closed. Refinement and Repetition CSD's always have a
comment.



Utility Menu


Overview



Set/Clear COMMENT -- Control COMMENT

This controls the COMMENT flag. The
COMMENT flag controls whether comments are added to If-Then-
Else and Case-When CSD's when they are created. If these
CSD's have a comment, they become one line when they are
closed.
CSDedit 11