Update documentation.

git-svn-id: http://svn.drobilla.net/lad/trunk/machina@4967 a436a847-0d15-0410-975c-d299462d15a1

1 files changed, 38 insertions, 14 deletions

diff --git a/src/gui/machina.ui b/src/gui/machina.ui
index cc66256..be4a3e1 100644
--- a/src/gui/machina.ui
+++ b/src/gui/machina.ui
@@ -126,24 +126,48 @@ along with Machina; if not, write to the Free Software Foundation, Inc.,
             <property name="can_focus">False</property>
             <property name="xalign">0</property>
             <property name="yalign">0</property>
-            <property name="label" translatable="yes">Nodes represent notes, which have a pitch and duration.  When a node is
-highlighted green, it is playing.  After a node is finished playing, play
-travels along the outgoing arcs, depending on their probability.
+            <property name="label" translatable="yes">&lt;big&gt;&lt;b&gt;Nodes&lt;/b&gt;&lt;/big&gt;
+Nodes represent notes, which have a pitch and duration.
+When a node is highlighted green, it is playing.
 
-Nodes with dashed borders are selectors.  Only one successor is played after a
-selector, i.e. only one outgoing arc is traversed.
+Play begins at the initial node α.  Whenever all nodes become
+inactive or stop is pressed, play returns to the initial node.
 
-A machine can be constructed with the mouse or by recording MIDI input.  To
-record, press the record button and play some MIDI notes.  To finish recording,
+Nodes with dashed borders are selectors.  Only one successor is
+played after a selector, i.e. only one outgoing arc is traversed.
+
+ • Right click the canvas to create a new node
+ • Middle click a node to learn a MIDI note
+ • Double click a node to edit its properties
+ • Ctrl+Left click a node to make it a selector
+
+&lt;big&gt;&lt;b&gt;Arcs&lt;/b&gt;&lt;/big&gt;
+When a node is finished playing, play travels along outgoing
+arcs, depending on their probability.  The colour of an arc
+indicates its probability, where green is high and red is low.
+
+ • Ctrl+Left click an arc to decrease its probability
+ • Ctrl+Right click an arc to increase its probability
+
+&lt;big&gt;&lt;b&gt;Recording&lt;/b&gt;&lt;/big&gt;
+A machine can be build by recording MIDI input.  To record, press
+the record button and play some MIDI notes.  To finish recording,
 press stop or play and the new nodes will be added to the machine.
 
-• Right click the canvas to create a new node
-• Middle click a node to learn a MIDI note
-• Click two nodes in succession to connect them
-• Double click a node to show its properties dialog
-• Ctrl+Left click a node to make it a selector
-• Ctrl+Left click an edge to decrease its probability
-• Ctrl+Right click an edge to increase its probability</property>
+Normal recording inserts delay nodes to reproduce the timing of
+the input.  To avoid this, use step recording which directly connects
+nodes to their successors with no delays in-between.
+
+&lt;big&gt;&lt;b&gt;Connecting&lt;/b&gt;&lt;/big&gt;
+Connecting nodes is based on the selection.  If there is a selection,
+clicking a node will connect the selection to that node.
+
+There are two modes: chain and fan.  In chain mode, the selection is
+moved to the clicked node for quickly connecting long chains of nodes.
+In fan mode, the selection is unchanged for quickly connecting the
+selection to many nodes.</property>
+            <property name="use_markup">True</property>
+            <property name="justify">fill</property>
           </object>
           <packing>
             <property name="expand">True</property>