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