OS/2 Shareware BBS: 5 Edit/05-Edit.zip/draftit.zip/draftit.HLP

OS/2 Help File | 1996-07-01 | 16KB | 380 lines

ΓòÉΓòÉΓòÉ 1. Introduction ΓòÉΓòÉΓòÉ

 DraftIT is an editor for OS/2 Warp, created with two groups of users
especially in mind. On the one hand, it provides a tool for people like myself,
who use editors for text composition and only commit their work to a word
processor for final formatting. On the other, it includes strong support for
ReXX developers, integrating the RxD debugger and allowing trial runs of ReXX
procedures straight from the editor they're created with.

 DraftIT's features include; auto-backup, e-mail support, an integrated card
database (for any data you like), copying of selected text to the WPS, macro
capability, easily accessed note files (to accompany any document you're
working on), text markers, copy windows (press a button to split the screen,
displaying a second copy of the current document underneath the first), screen
font selection, indentation, flexible printing via the shareware package
FlexText, search and replace etc..

 DraftIT makes use of external modules whenever this seems more sensible than
using integrated ones. For example, e-mail support is provided via any mail
program you're already running. You don't need to import any address books etc.
- and you manage your mail in an environment you are used to. Some of these
external modules are already part of OS/2 (such as PMSEEK), one (RxD) is free
of charge EWS software from IBM and included in this package. Two, RexxBase and
FlexText, are included in the DraftIT package, but as shareware products.
Please register them, if you wish to make use of them, even though DraftIT
itself is freeware.

 I'd very much appreciate any comments, complaints or tips from users, as I am
aiming to continue work on this product and enhance it in many ways. Please
contact me via my Compuserve address; 100045,1712.

 Enjoy, Martin Farrent


ΓòÉΓòÉΓòÉ 2. New ΓòÉΓòÉΓòÉ

 This function of the File menu opens a new text window. If you insert text in
this window, you'll be asked whether you wish to save it before DraftIT closes.


ΓòÉΓòÉΓòÉ 3. Open ΓòÉΓòÉΓòÉ

 This function calls a dialogue box from which you can open an existing file.


ΓòÉΓòÉΓòÉ 4. Save ΓòÉΓòÉΓòÉ

 This function saves a document to your disk. If the document is new, Save as
will be invoked.


ΓòÉΓòÉΓòÉ 5. Save as ΓòÉΓòÉΓòÉ

 This function allows you to specify a path/title, under which the document
will be saved.


ΓòÉΓòÉΓòÉ 6. Print ΓòÉΓòÉΓòÉ

 DraftIT does not do its own printing. Instead, it passes these jobs on to
FlexText, a shareware program included in this package. FlexText is a highly
flexible tool which you should explore thoroughly using the help files
provided. Please register it, if you wish to continue using it.

 NOTE; the executable 'flxts.exe' requires the parameter '..\print.tmp' in its
settings notebook for automatic printing of the document DraftIT is currently
processing. Also, you should not move FlexText from its current location in its
own DraftIT subdirectory. Otherwise, the program will not find the right file
to print.


ΓòÉΓòÉΓòÉ 7. AutoBackup ΓòÉΓòÉΓòÉ

 This function calls a dialogue box for you to specify whether you want
documents automatically backed up each time they are opened. The backup copies
will reside in the document's directory, with the suffix '.bak'.


ΓòÉΓòÉΓòÉ 8. Exit ΓòÉΓòÉΓòÉ

 Closes down the program. You'll be asked whether you wish to save documents
that have been modified since you last saved them.


ΓòÉΓòÉΓòÉ 9. Undo/Redo ΓòÉΓòÉΓòÉ

 This function undoes the last change you made to a document.


ΓòÉΓòÉΓòÉ 10. Cut ΓòÉΓòÉΓòÉ

 This function cuts selected text to the clipboard. NOTE; you need not use the
menu or toolbar if you are cutting text to move it within a document. Rather,
select the text, then click the right mouse button. Move the cursor to the
required place and click the right mouse button again.


ΓòÉΓòÉΓòÉ 11. Copy ΓòÉΓòÉΓòÉ

 This function copies selected text to the clipboard.


ΓòÉΓòÉΓòÉ 12. Paste ΓòÉΓòÉΓòÉ

 This function pastes text from the clipboard to your document.


ΓòÉΓòÉΓòÉ 13. Find ΓòÉΓòÉΓòÉ

 This function calls a dialogue box from which you can start a search for a
text string. You can choose between case sensitive and insensitive searches. A
search begins at the beginning of a document and ends when the specified string
has been found once.


ΓòÉΓòÉΓòÉ 14. Continue search ΓòÉΓòÉΓòÉ

 This function continues a search for a text string, taking the current cursor
position as its starting point.


ΓòÉΓòÉΓòÉ 15. Search and replace ΓòÉΓòÉΓòÉ

 This function calls a dialogue box which allows you to specify a text string
and replace it with another. All occurrences of the string will be replaced.
Such operations are always case sensitive.


ΓòÉΓòÉΓòÉ 16. Tile ΓòÉΓòÉΓòÉ

 If you are working with more than one document, this function tiles your text
windows.


ΓòÉΓòÉΓòÉ 17. Cascade ΓòÉΓòÉΓòÉ

 Cascades text windows, if more than one is open.


ΓòÉΓòÉΓòÉ 18. Next ΓòÉΓòÉΓòÉ

 Gives focus to the next window.


ΓòÉΓòÉΓòÉ 19. Open copy window ΓòÉΓòÉΓòÉ

 This function is intended for people who need to view more than one copy of a
document when editing it - for example, to reference a different portion of
that document. It opens a (blue) window containing a copy of the document and
places it beneath the original. If you have more than one window open already,
it will tile your windows. NOTE; the copy window depicts the document as last
saved - it is not automatically updated while you work on the text.


ΓòÉΓòÉΓòÉ 20. Insert Marker ΓòÉΓòÉΓòÉ

 Inserts a marker (>>>) at the current cursor position. This is intended for
tagging a point at which you wish to continue work later. You can comment the
marker out, if your text is a programming script, i.e. '/*>>>*/ ' for ReXX. Use
Go to next marker to search for markers, starting at the current cursor
position.


ΓòÉΓòÉΓòÉ 21. Go to next marker ΓòÉΓòÉΓòÉ

 Searches for the next marker, starting at the current cursor position.


ΓòÉΓòÉΓòÉ 22. Notes ΓòÉΓòÉΓòÉ

 Any document can have an associated notes file. This is named after the
document itself, with the suffix '.nts', and resides in the document's
directory. The first time you use this function for a document, a notes file
will be created. Afterwards, an existing notes file will be displayed in a
special window. Such files can be used to record memos etc. associated with a
document.


ΓòÉΓòÉΓòÉ 23. Get line count ΓòÉΓòÉΓòÉ

 Gets the number of lines in a text window. If you are using word wrap, this
number depends on the size of the window.


ΓòÉΓòÉΓòÉ 24. Copy selection to WPS ΓòÉΓòÉΓòÉ

 Selected text will be copied to your desktop, as a separate file named after
the first 21 characters in the text selection. If the selection is smaller than
22 characters, it will be deemed too short to copy.

 You can also perform this operation the other way round by dragging a .txt
file from the WPS (or a folder) to a DraftIT text window. Its contents will be
copied at the current cursor position.


ΓòÉΓòÉΓòÉ 25. Font ΓòÉΓòÉΓòÉ

 Calls a dialogue box from which you can select a screen font.


ΓòÉΓòÉΓòÉ 26. Indentation ΓòÉΓòÉΓòÉ

 Allows you to specify how many spaces are inserted when the Enter key is
pressed.


ΓòÉΓòÉΓòÉ 27. Word wrap on/off ΓòÉΓòÉΓòÉ

 Switch word wrapping on or off for the current text window. The default is on.


ΓòÉΓòÉΓòÉ 28. CardBase ΓòÉΓòÉΓòÉ

 Runs a card style database utility. This is intended for any information you
like to keep 'at your finger tips' - such as code fragments or snippets of
general knowledge.


ΓòÉΓòÉΓòÉ 29. PMSeek ΓòÉΓòÉΓòÉ

 Runs the OS/2 search tool PMSeek, which allows you to search for files by name
or by text strings they contain. Such files then need to be opened 'manually',
via DraftIT's files menu or toolbar. I'm planning to include an integrated
search tool in the next version of the program which would automatically open
text windows for files retrieved by such searches.


ΓòÉΓòÉΓòÉ 30. EMail ΓòÉΓòÉΓòÉ

 DraftIT supports e-mail by copying the entire contents of a text window to the
clipboard and then starting any mail program you wish to use. The first time
you use this function, you'll have to specify the path to the mail program.
Once it has been evoked, you can retrieve the text from the clipboard.


ΓòÉΓòÉΓòÉ 31. RexxTrial ΓòÉΓòÉΓòÉ

 DraftIT allows you to trial run a ReXX procedure in the current text window.
It does so by creating a file called 'trial.cmd' and running it in the PMREXX
environment, which provides a PM window for your procedure's input and output.

 Since ReXX allows OS/2 commands, you can also use this feature as a kind of
'shell' for command line functions. Simply write a normal command as if it were
a short ReXX procedure, such as this;

 /* */

 'dir'

 The advantage is that the output goes to a PMREXX window, where it can be
scrolled, edited etc.. For example, you might wish to copy it to the clipboard
and use it in a document.


ΓòÉΓòÉΓòÉ 32. RexxDebug ΓòÉΓòÉΓòÉ

 DraftIT supports debugging of ReXX procedures using the IBM EWS (Employee
Written Software) program RxD. This fully documented utility is included in the
DraftIT package and installed during installation of the editor itself. All you
need to do is run it from the ReXX menu.

 One word of warning; do not attempt to debug DraftIT macros with this feature.
Unlike simple ReXX scripts, macros are not run as procedures in their own
right, but within the main program. The system only understands the editor's
specific macro commands when they are evoked this way - that is, from the macro
menu. If you run them from the ReXX menu, they're bound to crash.


ΓòÉΓòÉΓòÉ 33. Macros (General) ΓòÉΓòÉΓòÉ

 DraftIT uses ReXX as its macro language, so that a macro script starts with a
typical ReXX header (/* */) and can make use of any feature in the ReXX
language, including external ones in libraries. DraftIT extends basic ReXX by a
number of specific commands which all start with 'DT_' and cover all the
fundamental editing functions, plus several others. See Macros (Commands)  for
more.

 A new macro should be saved in DraftIT's root directory with the suffix
'.mac'. The macro menu lets you run, edit, test and save macros. Do not attempt
to debug macros from the ReXX menu. They'll crash!

 Unfortunately, there's no neat way of debugging DraftIT macros at all (I'm
working on it). I'm afraid the program is not very helpful when an error
occurs. If the error is simply a wrong number of parameters in a DT command,
you'll be told so. After this, the script fails and a ReXX error will be
reported. If the error is one of syntax or an incorrect call to a normal ReXX
routine, you'll be told that a ReXX error has occurred - but not which one. The
only solution at the present time is to write macros in small portions and test
frequently while extending them.

 One useful function of the program is that you can start it with a macro as a
parameter, using the switch '/m macroname.mac' (substituting macroname with the
full path and name of the macro you wish to start). The intention is to enable
system automisation. For example, you could write a DraftIT macro for a certain
task, then start DraftIT (plus the macro) from within a broader ReXX script.
This might make further use of text DraftIT has copied to the clipboard, or use
DraftIT to present data retrieved from a BBS, etc..


ΓòÉΓòÉΓòÉ 34. Macros (Commands) ΓòÉΓòÉΓòÉ

 CALL DT_NEW - opens a new text window.

 CALL DT_OPEN 'Filename' - opens a document

 CALL DT_SAVE - saves the document in the current text window. NOTE; if you try
to save a new (unnamed) document, the 'Save as' dialogue will be called up,
halting the flow of your macro. The solution is to create a new file using
SysCreate Object, before opening it with DT_OPEN and further processing it.

 CALL DT_CUT - cuts selected text to the clipboard

 CALL DT_COPY - copies selected text to the clipboard

 CALL DT_PASTE - pastes text from the clipboard to a text window

 CALL DT_INSERT 'Text' - inserts text string (limit: 255 chars) at current
cursor position

 CALL DT_DELETE 'x' - deletes x characters of text, starting at current cursor
position

 CALL DT_MARK 'x' - marks x characters of text, starting at current cursor
position

 RC = DT_GETCURSOR() - gets current cursor position and places it in RC

 CALL DT_SETCURSOR 'x' - places cursor at character position x (the first
position in a text window is 0. If x is larger than the number of chars in a
text window, the cursor will got to the end of the text)

 RC = DT_GETLENGTH() - retrieves number of characters in a text and places the
result in RC

 CALL DT_SEARCH 'Searchstring' - searches for text, starting at current cursor
position, then selects (marks) such a string if found. The search is always
case insensitive!

 CALL DT_SAY 'message' - calls a message box containing 'message'

 RC = DT_YESNO('Query') - puts a query (message box) to the user, then returns
'YES' or 'NO' in RC, depending on which button has been pressed

 RC = DT_PULL('Query') - calls a dialogue box, putting a query to the user and
allowing him or her to type an answer in an entry field, then returns that
answer in RC, or 'NOANSWER' if OK button was not pressed


ΓòÉΓòÉΓòÉ 35. 'Hidden' functions ΓòÉΓòÉΓòÉ

 Moving text without evoking the Edit menu is described in Cut

 Using the editor as a 'shell' for OS/2 commands is described in RexxTrial

 Starting DraftIT and a macro similtaneously is described in Macros (General)

 DraftIT accepts a file name as a parameter. You can also start the program and
open a file similtaneously via drag and drop on the editor's program object
(icon). If you start DraftIT first, you can drag and drop multiple text files
on the main window's gray background, provided no text window is covering it.
Each file will be opened in a separate text window.

 Single .txt files may be dragged to an open text window. Their contents will
be copied at the current cursor position.


ΓòÉΓòÉΓòÉ 36. Future enhancements ΓòÉΓòÉΓòÉ

 Besides providing better debugging capabilities for macros, I intend to
include an integrated file search tool in the next version of the program.
Apart from that I'm open to ideas and suggestions, which you can send to:

 Martin Farrent, Eifelstrasse 4, 53119 Bonn, Germany

 Or mail me at:

 [e-mail]