manual/xml/formatting_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-formatting-conventions">
   8   <title>Formatting Conventions</title>
   9   <section id="typography">
  10     <title>Typography</title>
  11     <para>
  12       This manual uses a few conventions to indicate key commands, menu
  13       choices and other user interactions:
  14     </para>
  15
  16     <para>
  17       Key commands such as <keycombo><keycap>Ctrl</keycap><keycap>a</keycap>
  18       </keycombo> mean "Hold down the Ctrl key and press the 'a' key".
  19     </para>
  20
  21     <para>
  22       The names of on-screen buttons are shown like this
  23       <guibutton>Button</guibutton>
  24     </para>
  25
  26     <para>
  27       The name of a menu item is shown like <guimenuitem>This</guimenuitem>,
  28       and nested menu items will appear as <menuchoice>
  29       <guimenu>Menu</guimenu> <guisubmenu>Sub Menu</guisubmenu>
  30       </menuchoice>
  31     </para>
  32   </section>
  33
  34   <section id="admonitions">
  35     <title>Admonitions</title>
  36     <para>
  37       Admonitions are set apart from the main text and are meant to draw
  38       your attention to pieces of information. In the order of how critical
  39       the information is to you, these items are marked as follows:
  40     </para>
  41
  42     <note>
  43       <title>Note</title>
  44       <para>
  45         A note is typically information that you need to understand the
  46         behavior of Ardour.
  47       </para>
  48     </note>
  49     <tip><title>Tip</title>
  50       <para>
  51         A tip is typically an alternative way of performing a task.
  52       </para>
  53     </tip>
  54     <important>
  55       <title>Important</title>
  56       <para>
  57         The important admonition is used to draw attention to parts of the
  58         interface that may be overlooked or certain settings that are vital
  59         in determining the behaviour of ardour.
  60       </para>
  61     </important>
  62
  63     <warning>
  64       <title>Warning</title>
  65       <para>
  66         The warning admonition is used where an action may result in
  67         consequences that are unintended or permanent such as changes to the
  68         session that can not be undone or the removal of files.
  69       </para>
  70     </warning>
  71   </section>
  72
  73   <section id="mouse-buttons">
  74     <title>Mouse Buttons</title>
  75     <para>
  76       You might be used to terms like "right mouse button", "left mouse
  77       button" etc. These are widely used, but they can be very confusing for
  78       left-handed people, or people using mice with many buttons arranged in
  79       an unconventional way. Ardour is typically used with mice equipped
  80       with at least 3 buttons that can be remapped for left- and
  81       right-handed users, making it hard to unambiguously define "left" and
  82       "right" in a useful way.
  83     </para>
  84
  85     <para>
  86       If you are right-handed and use a conventional mouse, then
  87       <mousebutton>Button1</mousebutton> corresponds to "left mouse button",
  88       <mousebutton>Button2</mousebutton> to "middle mouse button" and
  89       <mousebutton>Button3</mousebutton> to "right mouse button". Otherwise,
  90       the numbered button nomenclature refers to the same button numbers as
  91       defined by your X Window configuration.
  92     </para>
  93
  94     <para>
  95       If you see instructions to use <keycombo><keycap>Ctrl</keycap>
  96       <mousebutton>Button1</mousebutton> </keycombo> , it means "Hold down
  97       the <keycap>Ctrl</keycap> key and click
  98       <mousebutton>Button1</mousebutton> ".
  99     </para>
 100   </section>
 101
 102   <section id="select-choose">
 103     <title>Select/Choose</title>
 104     <para>
 105       In conventional English, "select" and "choose" are often used as
 106       synonyms. In this manual, we use them to mean quite different things:
 107     </para>
 108
 109     <variablelist>
 110       <title></title>
 111       <varlistentry>
 112         <term>Select</term>
 113         <listitem>
 114           <para>
 115             When you select something, it will stay selected. Putting a
 116             check-mark in a box, for example, would be referred to as
 117             "selecting" that box. This is also true for menu items that
 118             enable or disable options ("select Big Clock from the Windows
 119             menu", for example) and various editing functions.
 120           </para>
 121         </listitem>
 122       </varlistentry>
 123
 124       <varlistentry>
 125         <term>Choose</term>
 126         <listitem>
 127           <para>
 128             "Choosing" involves clicking or using the keyboard to accomplish
 129             a one-time action. A command to save the current session might
 130             be described as, "Choose Save from the Session menu.
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134     </variablelist>
 135   </section>
 136 <!--
 137         <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
 138                 href="Some_Subsection.xml" />
 139         -->
 140 </section>