<html>
<HEAD>
<TITLE>Weaver Main Help</TITLE>
</HEAD>
<BODY BGCOLOR=#FFFF88 TEXT=#000000 LINK=#3333AA VLINK=#6666FF> 

<center>
<H1> 
<FONT COLOR=#770000>W</FONT>eaver  <FONT COLOR=#770000>H</FONT>elp
</H1>
</center>

<B><A HREF="#Windows">Windows</A></B>
<BR>
&nbsp;&nbsp;<A HREF="#Control">'Weaver&nbsp;Main'&nbsp;Control&nbsp;Window</A>
&nbsp;&nbsp;<A HREF="#Diagram">'Diagram'&nbsp;Windows</A>
&nbsp;&nbsp;<A HREF="#Panel">Element&nbsp;'Panels'</A>
&nbsp;&nbsp;<A HREF="#Info">'Weaver&nbsp;Info'</A>
<BR>
<B><A HREF="#Icons">Common Icons</A>
<BR>
<A HREF="#Loading">Loading Diagrams</A>
&nbsp;&nbsp;<A HREF="#Constructing">Constructing Diagrams</A>
<BR>
<A HREF="#Elements">Elements</A></B>
<BR>
&nbsp;&nbsp;<A HREF="#Source">Sources</A>
&nbsp;&nbsp;<A HREF="#Filter">Filters</A>
&nbsp;&nbsp;<A HREF="#Multiconnector">Multiconnector Elements</A>
&nbsp;&nbsp;<A HREF="#Composite">Composite Elements</A>
&nbsp;&nbsp;<A HREF="#Bridges">Bridge Elements</A>
<BR>
<B><A HREF="#Links">Links</A></B>
<BR>
&nbsp;&nbsp;<A HREF="#Branches">Branched Links</A>
&nbsp;&nbsp;<A HREF="#RoutePath">Routing Link Paths</A>
&nbsp;&nbsp;<A HREF="#NamePath">Naming Paths</A>
<P>
Also see the main 
<FONT size=+1><B><A HREF="../Documentation/Weaver.html">Weaver Documentation</A>
<BR>
<A HREF="./">Help Topics</A>
&nbsp;&nbsp;<A HREF="../Documentation/">All Documentation</A>
</B></FONT>
<BR>
<HR size="3" width="40%" align ="center">

<BR>
<H2>
<A NAME="Windows">Windows</A>
</H2>
These windows are associated with the Weaver application:
<BR>
<h5><A NAME="Control">'Weaver Main' Control Window</A></h5>
This is the small window, normally in the
upper right corner of the screen, from which you probably brought up
this Help information. It remains open (though may be hidden) as long
as the Weaver is running.  It just has a menu ('Global') that is used
mainly to open new blank diagram windows, and to close the application.
<P>
<h5><A NAME="Diagram">'Diagram' Windows</A></h5>
An arbitrary number of these may be open at any
time during operation.  A diagram is where the configuration that performs
a desired function is constructed.  A complete configuration must be
contained within a single top-level diagram, but
<A HREF="#Composite">'composite elements'</A>
placed in it may represent sub-diagrams -- each with their own parts
of the whole thing in their own windows.  A diagram has a menu, but
this is not visible until the right mouse-button is pressed over an
empty area of the window.  Each element placed in the diagram
also has its own menu, revealed by pressing the right button over the
centre of the element; links between elements have menus too -- press
the button anywhere over the path of the link.
<P>
<h5><A NAME="Panel">Element 'Panels'</A></h5>
Most elements in the diagram will have their
own control panels.  These are the concern of the element itself
rather than the Weaver, but they are normally opened from the menu
of that element in the diagram.  Selecting 'Panel' from the element's
menu will open the panel if it is closed, or bring it to the front
if it is behind others or minimized.
<P>
<h5><A NAME="Info">'Weaver Info' Window</A></h5>
This window is not seen unless an error or informational message
needs to be displayed.  If so, it pops up at the top of the screen.
Once it appears it remains open until dismissed by its close-gadget,
so you can read the message comfortably.  (Note that later messages
overwrite earlier ones, so if for some reason there is a string of
errors you will probably only see the last one.)
<P>

<BR>
<H2>
<A NAME="Icons">Common Icons</A>
</H2>
The following icons represent different types of object known to
the Weaver (and found in the top level folder). [Their links take
you to respective help documents.  For much briefer overviews
of some, see below in <i>this</i> document.]
<BR>
<BR>
<B><IMG SRC=../Documentation/Images/wvricon.jpg HSPACE="20">
Weaver</B>
&nbsp;&nbsp;-- The Weaver main application itself (see help below)
<BR>
<BR>
<B><A HREF="#Loading"><IMG SRC=../Documentation/Images/configuration.jpg HSPACE="20">
Diagram Configuration File</A></B>
&nbsp;&nbsp;-- saved from a previously constructed diagram
<BR>
<BR>
<B><A HREF="Composite"><IMG SRC=../Documentation/Images/composite.jpg HSPACE="20">
Composite Element File</A></B>
&nbsp;&nbsp;-- representing a placeable sub-diagram
<BR>
<BR>
<B><A HREF="JoinPaths"><IMG SRC=../Documentation/Images/Join.jpg HSPACE="20">
JoinPaths</A></B>
&nbsp;&nbsp;-- merge data flows
<BR>
<BR>
<B><A HREF="Switcher"><IMG SRC=../Documentation/Images/Switcher.jpg HSPACE="20">
Switcher</A></B>
&nbsp;&nbsp;-- select path for data flow
<BR>
<BR>
<B><A HREF="BridgeIn"><IMG SRC=../Documentation/Images/BridgeIn.jpg HSPACE="20">
BridgeIn</A></B>
&nbsp;&nbsp;-- bring a data flow into composite element
<BR>
<BR>
<B><A HREF="BridgeOut"><IMG SRC=../Documentation/Images/BridgeOut.jpg HSPACE="20">
BridgeOut</A></B>
&nbsp;&nbsp;-- export a data flow from composite element
<BR>
<BR>
<B><IMG SRC=../Documentation/Images/composite.jpg HSPACE="20">
'Comp0'</B>
&nbsp;&nbsp;-- blank composite element supplied as a starting point
<BR>
<BR>

The icons of the various suite modules are too numerous to mention
individually.
<P>

<BR>
<H2>
<A NAME="Loading">Loading Diagrams</A>
</H2>
To load an exisisting Weaver configuration ("Diagram") file
into a fresh window (starting
up the Weaver if necessary) simply double-click on its icon.  You can
also drag the icon into an open DIagram window (if sufficient empty
space exists in it), and the configuration will be added to that
diagram at that point.
<P>

<BR>
<H2>
<A NAME="Constructing">Constructing Diagrams</A>
</H2>
Use the 'New Diagram' item in the 'Global' menu (of the 'Weaver Main'
window) to create a new empty diagram at any time.  Add elements to
the diagram by dragging their icons from the appropriate drawer in
the Weaver hierarchy.  Link them together by dragging from an 'output
pip' on one to any input side of another.
<P>

<BR>
<H2>
<A NAME="Elements">Elements</A>
</H2>
Place an element in a diagram by dragging its icon from the folder
in which the module resides.
<P>
Move it at any time by grabbing its centre-point with the left
mouse-button and dragging.
<P>
Press the right mouse-button over its centre-point to pop up
a panel giving the name and type of the element, and
a menu of actions (only applicable ones will appear in the menu):
<UL type="NONE">
<LI>'Panel' -- displays the control panel for the element
<LI>'Name' -- opens a text entry window for labelling the element
<LI>'Help' -- displays help for the element
<LI>'Rotate' -- allows orienting an unlinked element
<LI>'Elide' -- removes element from its data path, leaving path intact
<LI>'Remove' -- deletes element and all links to it
</UL>
If connections are compatible, you can replace one item with another
by dragging the replacement directly on top of the original.
<BR>

<H4>
<A NAME="Source">Sources</A>
</H4>
A Source element generates data, but accepts no inputs.
It appears in the diagram as a small square frame with one
output 'pip' (on the right, unless it has been rotated).
<H4>
<A NAME="Filter">Filters</A>
</H4>
A Filter accepts a data stream, processes it (perhaps modifying it,
perhaps not), and passes it on.
It has the same appearance as a Source, but accepts imput connections
on any or all of the three non-output sides.
Inputs to more than one of the sides are merged before being
passed to the Filter's processing.
<BR>

<H4>
<A NAME="Multiconnector">Multiconnector Elements</A>
</H4>
Multiconnectors  have
a rectangular, rather than square outline, giving more room for
connections.  They also usually have more than one output pip.
<P>
Each connection made to a multiconnector will have its own distinct
function.  No two may be the same,
so the merged paths of a simple Filter are not posssible.
<P>
To select the function for a particular link connection, press the
right mouse-button directly over that connector-point.  A popup
menu lists the available functions, with the current selection checked.
(Selecting a different function that is already 'owned' by another
connection will cause a swap.)
<BR>

<H4>
<A NAME="Composite">Composite Elements</A>
</H4>
Composite elements represent sub-diagrams that can be placed in an
enclosing diagram like any other element.  The sub-diagram window is
opened with the 'Panel' menu item in the element's popup menu.
<P>
Connector points on the
element are made available by adding BridgeIn and BridgeOut elements
to the sub-diagram.  (Geometry prevents more than six of each being
connected at a time.)
<P>
Double-clicking on a composite element's file icon opens it stand-alone
like any other configuration. If saved again, it remains composite.
<BR>

<H4>
<A NAME="Bridges">Bridge Elements</A>
</H4>
BridgeIn and BridgeOut elements are only useful placed in a
composite element sub-diagram.  They allow import and export of
data streams.  Each BridgeIn placed makes available an input
connection on the composite element; each BridgeOut similarly
provides an output link there.  The name attached to a link
on the composite is that of the associated Bridge element.
<P>
<BR>

<H2>
<A NAME="Links">Links</A>
</H2>
Make a data flow link from one placed element to another by dragging
(with the left mouse-button) from the appropriate output 'pip' on
the one to a free side of the other. (Not to a corner.)  If either
element is multiconnector, you should pop up the menu on that
connector to ensure that you have attached to the desired function.
<P>
To delete a link, press the right mouse-button over any part of the
link's path, and select 'Cut' from the menu.  (You cannot move either
end of a link once placed.  To make a change you must cut and relink.)
<BR>
<H4>
<A NAME="Branches">Branched Links</A>
</H4>
To split a path into two, so as to feed another element in parallel,
drag from somewhere on the link's path (except from either connector)
to the desired destination element.
<BR>
<H4>
<A NAME="RoutePath">Routing Link Paths</A>
</H4>
To specify a non-default path for a link (after completing it),
select 'Route' from its popup menu.  Click with the left button
on the points you wish the path to go through, then click 'Done'.
<BR>
<H4>
<A NAME="NamePath">Naming Paths</A>
</H4>
Give a path a label by selecting 'Name' from the popup menu.
This has no system significance, but it appears in the popup info
for the path, and will be saved in the configuration file.
<P>
