manual/xml/user_interface_conventions.xml

   1 <?xml version="1.0" standalone="no"?>
   2
   3 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   4
   5 ]>
   6
   7 <section id="sn-user-interface-conventions">
   8   <title>Interface Basics</title>
   9   <para>
  10     Although Ardour has a fairly conventional graphical user interface,
  11     there are a few elements that are unique to it and are probably new to
  12     you. This chapter provides a guide to using these aspects of the
  13     interface.
  14   </para>
  15
  16   <section id="interface-mouse-clicks">
  17     <title>Mouse Clicks</title>
  18     <section id="interface-click">
  19       <title>Click</title>
  20       <para>
  21         When we say "click on" without specifying a mouse button, we mean
  22         use <mousebutton>Button1</mousebutton> to click on a user interface
  23         element (button, fader, menu, etc).
  24       </para>
  25     </section>
  26
  27     <section id="interface-context-click">
  28       <title>Context Click</title>
  29       <para>
  30         As in most graphical user interfaces today, a "context click"
  31         (<mousebutton>Button3</mousebutton>) in many parts of the user
  32         interface will popup a context-specific menu, allowing you to set
  33         parameters or carry out operations. There are a lot of examples of
  34         this, but trying it on an audio region, a mixer mute button and a
  35         mixer strip name will show the general idea.
  36       </para>
  37     </section>
  38
  39     <section id="interface-delete-edit-click">
  40       <title>Delete &amp; Edit Click</title>
  41       <para>
  42         There are two additional mouse/key combinations that you should be
  43         familiar and comfortable with. They are called "delete click" and
  44         "edit click", and by default they consist
  45         <keycombo><keycap>Shift</keycap><mousebutton>Button3</mousebutton></keycombo>
  46         click and
  47         <keycombo><keycap>Ctrl</keycap><mousebutton>Button3</mousebutton></keycombo>
  48         click respectively. A delete click on most objects within Ardour's
  49         editor will delete that object. This includes regions, markers,
  50         curve control points and so on. An edit click on the any of the same
  51         kind of objects will pop up an editor dialog for that object.
  52       </para>
  53     </section>
  54   </section>
  55
  56   <section id="interface-clocks">
  57     <title>Clocks</title>
  58     <para>
  59       There are several clocks in Ardour's user interface, some of them
  60       visible all the time, others in windows that are only shown by
  61       request. All these clocks are identical to each other in their
  62       functionality, although some can be edited by the user and some are
  63       for display only.
  64     </para>
  65
  66     <para>
  67       Context clicking on a clock brings up a menu that allows you to modify
  68       the display mode of that clock. The choices are:
  69     </para>
  70
  71     <itemizedlist>
  72       <listitem>
  73         <para>
  74           Audio Frames
  75         </para>
  76       </listitem>
  77
  78       <listitem>
  79         <para>
  80           BBT (Bars,Beats,Ticks - musical tempo &amp; meter based time)
  81         </para>
  82       </listitem>
  83
  84       <listitem>
  85         <para>
  86           SMPTE
  87         </para>
  88       </listitem>
  89
  90       <listitem>
  91         <para>
  92           Min:Sec
  93         </para>
  94       </listitem>
  95     </itemizedlist>
  96
  97     <para>
  98       Each clock mode has a number of different fields. For example, SMPTE
  99       has hours, minutes, seconds, and video frames.
 100     </para>
 101
 102     <para>
 103       To edit the value of a particular clock, click in the leftmost field
 104       you want to modify. You can then enter a new value for that field
 105       using numeric keys, along with '.' where appropriate. Editing will
 106       move the next field of the clock after you have entered the maximum
 107       number of digits for a field. To move to the next field before this
 108       press Tab. To finish editing, either press <keycap>Return</keycap> or
 109       use the <keycap>Tab</keycap> key to advance through all remaining
 110       fields.
 111     </para>
 112   </section>
 113
 114   <section id="interface-bar-controllers">
 115     <title>Bar Controllers</title>
 116     <para>
 117       Bar controllers were inspired by a comment made by "Larry the O" in
 118       Electronic Musician in 2001.
 119     </para>
 120
 121     <para>
 122       A bar controller is a user interface element that works rather
 123       differently than any standard element found in most programs. They are
 124       used to provide a combined method of displaying and modifying a
 125       parameter.
 126     </para>
 127
 128     <para>
 129       To graphically edit the value of the parameter represented by a bar
 130       controller, press <mousebutton>Button1</mousebutton> and drag the
 131       controller left/right or up/down as appropriate. To edit the value
 132       with greater precision, double click the controller and it will
 133       transform into a data entry box. You can enter an exact value for the
 134       parameter, or use arrow buttons to increment/decrement the displayed
 135       value. When you are finished editing, the Enter or Tab keys will
 136       transform the data entry box back into the normal version of the bar
 137       controller.
 138     </para>
 139   </section>
 140
 141   <section id="interface-click-boxes">
 142     <title>Click Boxes</title>
 143     <para>
 144       Click boxes were also inspired by Larry's comment.
 145     </para>
 146
 147     <para>
 148       A click box is, as its name suggests, just a part of a window you can
 149       click on to change some parameter or control value.
 150     </para>
 151
 152     <para>
 153       Clicking with 3 moves the parameter to the next value, clicking with 1
 154       moves to the previous value. Clicking and holding either button will
 155       automatically advance through the possible values in the appropriate
 156       direction.
 157     </para>
 158
 159     <note>
 160       <para>
 161         we are slowly eliminating click boxes in favor of bar controllers
 162       </para>
 163     </note>
 164   </section>
 165
 166   <section id="interface-panes">
 167     <title>Panes</title>
 168     <para>
 169       Panes are user interface elements that allow you to adjust the
 170       relative sizes of two sections of a window. The panes in Ardour work
 171       perfectly normally but have one additional feature: a Delete-click on
 172       the pane divider will completely hide one side of its two sections.
 173       Which section depends on the pane, and is not user configurable, but
 174       is neary always precisely what you'd want anyway. If the pane is
 175       already hidden, then Delete-click (on the still-visible pane) will
 176       restore it to the size it had before it was hidden.
 177     </para>
 178   </section>
 179 <!--
 180         <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
 181                 href="Some_Subsection.xml" />
 182         -->
 183 </section>