%OP%BOY
%OP%TM1
%OP%BM1
%OP%LM5
%OP%HE//%H2%OTL - Outline Utility Documentation%H2%//
%OP%FO/%H2%Z175%H2%//@P@/
%CO:A,12,70%%H2%Introduction%H2%

    OTL is an outline utility which provides some basic outline 
formatting and file manipulation capabilities to the Z88 through use 
of its PipeDream word processor/spreadsheet and CLI capabilities.

    The outline is stored as a PipeDream file, which must have the 
extension .OTL, and must be created before OTL is run. In addition 
both BASIC and Pipedream need to have their default directory set to 
whatever device and directory the files are in. The format of the 
outline file is a one column PipeDream file, with the outline levels 
indicated by spaces at the start of the line, no space for the main 
level, one for the next, and so forth. Each heading can be no more 
than one line. If there is text associated with the heading, the end 
of the heading is indicated by a semicolon, and the rest of the line 
is taken as the PipeDream file name which contains the text. All of 
the file names must have the same root (only the extensions may 
differ) and the extensions must not start with a Z or be the 
extension .l.

For example, given the outline file TEST.OTL containing:

This is a main heading
 And a sub-heading;test.t00
 And another sub-heading
And back to the main level

Would give an outline format (using legal notation):

1. This is a main heading
   1.1. And a sub-heading
   1.2. And another sub-heading
2. And back to the main level

    Where 1.1. had an associated PipeDream file.

    This is not a production program, so it is of course not as clean 
as it could be, but it fills the need I had. The best way to get to 
learn it is just to play with it, if nothing else it is an example of 
the power of the Z88 CLI structure.

%H2%Cursor Movement%H2%
    Cursor movement through the displayed outline is done using the 
up and down arrow keys, in conjunction with the shift, diamond, and 
square keys. The up arrow key moves up in the outline, and the down 
arrow key moves down in the outline (of course). In keeping with the 
Pipedream convention, the diamond key and a direction key take you to 
the start or the end of the file, while the shift and a direction key 
take you up or down one screen (8 lines). The only change with the 
outliner is the use of the square key and a direction key, which 
takes you to the next heading at the same level as the current 
heading.
%P0%
%H2%Commands%H2%
    Commands are selected by hitting a single letter (indicated in 
parenthesis) and if they apply to only part of the file the current 
position is taken as the reference.

%H1%Note (N)%H1%


%H1%Level (L)%H1%




%H1%All (A)%H1%


%H1%Spell (S)%H1%





%H1%Options (O)%H1%















%H1%Print (P)%H1%














%P0%









%H2%Comments%H2%
    As was stated earlier, this is not a complete package by any 
means, and it is certainly not what you call a full featured 
outliner, but it does provide for an easy way to manipulate large 
text files using Pipedream, and has the advantage that the included 
files can be spreadsheets or other Pipedream files, each with its own 
formats.

    If a file is specified in the index (.OTL) file, and does not 
exist, one will be created, with the first line being the heading 
from the outline file. This is just there to indicate what the file 
should be, and should be deleted once you have something there, (or 
else it will show up twice when printed).

    The program uses the variable Z%PC% to figure out what is going on 
after editing the index file, this should be 0 when the program is 
first run. (It will be zero unless some program has changed it in 
this instantation of BASIC)

    Needless to say, if there are a number of instantations of 
PipeDream and or BASIC this program gets confused.
%CO:B,16,58%

























































If there is an attached file, go into PipeDream and load 
it, to return the OTL hit the square key and B.

Creates a list file for PipeDream of all the attached 
files at this and lower levels, until the next heading at 
this level or the end of the file. Return to BASIC to 
return to OTL.

Creates a list file for PipeDream of all the attached 
files in the file. Return to BASIC to return to OTL.

Spell checks the attached file at the current heading. 
Note that this option requires the SPELLMASTER ROM, and 
that QuickEdit must be set to the correct device and 
directory. To spell check the outline file, type 
Control-S (the diamond key and S).

Sets options as listed below. Note that formatting 
options only apply to the headings which are written out, 
all formatting for the attached files is taken from the 
attached files.

%H1%Left Margin%H1%



%H1%Outline type%H1%
%H1%Indent level%H1%

%H1%Outline formats%H1%



This is the most useful option, and creates a finished 
document file by creating a large file list, consisting 
of a series of temporary files (those with extensions 
starting with .Z) and the attached note files. It then 
calls Pipedream to edit the files. Once in Pipedream the 
files can be printed or whatever. Once the printing is 
done, the filer is called to delete all of the temporary 
files (those with the .Z?? extension).

The resulting series of files when printed give text in 
prose form (not indented), with the headers prefixed and 
suffixed with one blank line. The left margin and 
formatting for the headers are given by the current 
option settings.


To generate a printout of the outline in outline form, 
type Control-P (the diamond key and P). This will 
generate a single file pipedream file consisting of all 
of the headers, with numbers, and indented as specified 
by the indent level. If you wish to save this document, 
file it under some extension other than .Z??, as all 
temporary files are deleted by the program when you 
return to BASIC.
%CO:C,44,42%















































































Sets the left margin. This applies to all 
files generated by the program. Any note 
files incorporated or otherwise created 
using Pipedream use their own left 
margin. Sets for normal or legal 
numbering schemes. Sets the number of 
spaces each level is indented. Sets 
formats for the outline headers when they 
are printed out (such as bold, 
underlined, etc.