doc: Convert several more itemizedlists to variablelists
[fw/altos] / doc / altusmetrum.xsl
index eed6b7d702627ee098afe49314c753b33c246c3e..3022b8e3ff708b2c467942e4d81e91732c7fead7 100644 (file)
@@ -1793,35 +1793,47 @@ NAR #88757, TRA #12200
       <para>
         At the bottom of the dialog, there are four buttons:
       </para>
-      <itemizedlist>
-        <listitem>
-          <para>
-            Save. This writes any changes to the
-            configuration parameter block in flash memory. If you don't
-            press this button, any changes you make will be lost.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            Reset. This resets the dialog to the most recently saved values,
-            erasing any changes you have made.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            Reboot. This reboots the device. Use this to
-            switch from idle to pad mode by rebooting once the rocket is
-            oriented for flight, or to confirm changes you think you saved 
-           are really saved.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            Close. This closes the dialog. Any unsaved changes will be
-            lost.
-          </para>
-        </listitem>
-      </itemizedlist>
+      <variablelist>
+       <varlistentry>
+         <term>Save</term>
+         <listitem>
+           <para>
+             This writes any changes to the
+             configuration parameter block in flash memory. If you don't
+             press this button, any changes you make will be lost.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>Reset</term>
+         <listitem>
+           <para>
+             This resets the dialog to the most recently saved values,
+             erasing any changes you have made.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>Reboot</term>
+         <listitem>
+           <para>
+             This reboots the device. Use this to
+             switch from idle to pad mode by rebooting once the rocket is
+             oriented for flight, or to confirm changes you think you saved 
+             are really saved.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>Close</term>
+         <listitem>
+           <para>
+             This closes the dialog. Any unsaved changes will be
+             lost.
+           </para>
+         </listitem>
+       </varlistentry>
+      </variablelist>
       <para>
         The rest of the dialog contains the parameters to be configured.
       </para>
@@ -1913,32 +1925,41 @@ NAR #88757, TRA #12200
          computers. This configuration parameter allows the two
          channels to be used in different configurations.
        </para>
-       <itemizedlist>
-         <listitem>
-           <para>
-             Dual Deploy. This is the usual mode of operation; the
-             'apogee' channel is fired at apogee and the 'main'
-             channel at the height above ground specified by the
-             'Main Deploy Altitude' during descent.
-           </para>
-         </listitem>
-         <listitem>
-           <para>
-             Redundant Apogee. This fires both channels at
-             apogee, the 'apogee' channel first followed after a two second
-             delay by the 'main' channel.
-           </para>
-         </listitem>
-         <listitem>
-           <para>
-             Redundant Main. This fires both channels at the
-             height above ground specified by the Main Deploy
-             Altitude setting during descent. The 'apogee'
-             channel is fired first, followed after a two second
-             delay by the 'main' channel.
-           </para>
-         </listitem>
-       </itemizedlist>
+          <variablelist>
+           <varlistentry>
+             <term>Dual Deploy</term>
+             <listitem>
+               <para>
+                 This is the usual mode of operation; the
+                 'apogee' channel is fired at apogee and the 'main'
+                 channel at the height above ground specified by the
+                 'Main Deploy Altitude' during descent.
+               </para>
+             </listitem>
+           </varlistentry>
+           <varlistentry>
+             <term>Redundant Apogee</term>
+             <listitem>
+               <para>
+                 This fires both channels at
+                 apogee, the 'apogee' channel first followed after a two second
+                 delay by the 'main' channel.
+               </para>
+             </listitem>
+           </varlistentry>
+           <varlistentry>
+             <term>Redundant Main</term>
+             <listitem>
+               <para>
+                 This fires both channels at the
+                 height above ground specified by the Main Deploy
+                 Altitude setting during descent. The 'apogee'
+                 channel is fired first, followed after a two second
+                 delay by the 'main' channel.
+               </para>
+             </listitem>
+           </varlistentry>
+       </variablelist>
       </section>
       <section>
         <title>Pad Orientation</title>
@@ -1949,22 +1970,28 @@ NAR #88757, TRA #12200
          parameter allows that default to be changed, permitting the
          board to be mounted with the antenna pointing aft instead.
        </para>
-       <itemizedlist>
-         <listitem>
-           <para>
-             Antenna Up. In this mode, the antenna end of the
-             TeleMetrum board must point forward, in line with the
-             expected flight path.
-           </para>
-         </listitem>
-         <listitem>
-           <para>
-             Antenna Down. In this mode, the antenna end of the
-             TeleMetrum board must point aft, in line with the
-             expected flight path.
-           </para>
-         </listitem>
-       </itemizedlist>
+       <variablelist>
+         <varlistentry>
+           <term>Antenna Up</term>
+           <listitem>
+             <para>
+               In this mode, the antenna end of the
+               TeleMetrum board must point forward, in line with the
+               expected flight path.
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term>Antenna Down</term>
+           <listitem>
+             <para>
+               In this mode, the antenna end of the
+               TeleMetrum board must point aft, in line with the
+               expected flight path.
+             </para>
+           </listitem>
+         </varlistentry>
+       </variablelist>
       </section>
       <section>
        <title>Configure Pyro Channels</title>
@@ -2111,27 +2138,36 @@ NAR #88757, TRA #12200
       <para>
         At the bottom of the dialog, there are three buttons:
       </para>
-      <itemizedlist>
-        <listitem>
-          <para>
-            Save. This writes any changes to the
-            local Java preferences file. If you don't
-            press this button, any changes you make will be lost.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            Reset. This resets the dialog to the most recently saved values,
-            erasing any changes you have made.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            Close. This closes the dialog. Any unsaved changes will be
-            lost.
-          </para>
-        </listitem>
-      </itemizedlist>
+      <variablelist>
+       <varlistentry>
+         <term>Save</term>
+         <listitem>
+           <para>
+             This writes any changes to the
+             local Java preferences file. If you don't
+             press this button, any changes you make will be lost.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>Reset</term>
+         <listitem>
+           <para>
+             This resets the dialog to the most recently saved values,
+             erasing any changes you have made.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>Close</term>
+         <listitem>
+           <para>
+             This closes the dialog. Any unsaved changes will be
+             lost.
+           </para>
+         </listitem>
+       </varlistentry>
+      </variablelist>
       <para>
         The rest of the dialog contains the parameters to be configured.
       </para>
@@ -2871,13 +2907,6 @@ NAR #88757, TRA #12200
       Self-programmable devices (TeleMega, TeleMetrum v2 and EasyMini)
       are reprogrammed by connecting them to your computer over USB
     </para>
-    <para>
-      The big concept to understand is that you have to use a
-      TeleMega, TeleMetrum or TeleDongle as a programmer to update a
-      pair programmed device. Due to limited memory resources in the
-      cc1111, we don't support programming directly over USB for these
-      devices.
-    </para>
     <section>
       <title>
        Updating TeleMega, TeleMetrum v2 or EasyMini Firmware
@@ -2933,6 +2962,72 @@ NAR #88757, TRA #12200
          </para>
        </listitem>
       </orderedlist>
+      <section>
+       <title>Recovering From Self-Flashing Failure</title>
+       <para>
+         If the firmware loading fails, it can leave the device
+         unable to boot. Not to worry, you can force the device to
+         start the boot loader instead, which will let you try to
+         flash the device again.
+       </para>
+       <para>
+         On each device, connecting two pins from one of the exposed
+         connectors will force the boot loader to start, even if the
+         regular operating system has been corrupted in some way.
+       </para>
+       <variablelist>
+         <varlistentry>
+           <term>TeleMega</term>
+           <listitem>
+             <para>
+               Connect pin 6 and pin 1 of the companion connector. Pin 1
+               can be identified by the square pad around it, and then
+               the pins could sequentially across the board. Be very
+               careful to <emphasis>not</emphasis> short pin 8 to
+               anything as that is connected directly to the battery. Pin
+               7 carries 3.3V and the board will crash if that is
+               connected to pin 1, but shouldn't damage the board.
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term>TeleMetrum v2</term>
+           <listitem>
+             <para>
+               Connect pin 6 and pin 1 of the companion connector. Pin 1
+               can be identified by the square pad around it, and then
+               the pins could sequentially across the board. Be very
+               careful to <emphasis>not</emphasis> short pin 8 to
+               anything as that is connected directly to the battery. Pin
+               7 carries 3.3V and the board will crash if that is
+               connected to pin 1, but shouldn't damage the board.
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term>EasyMini</term>
+           <listitem>
+             <para>
+               Connect pin 6 and pin 1 of the debug connector, which is
+               the six holes next to the beeper. Pin 1 can be identified
+               by the square pad around it, and then the pins could
+               sequentially across the board, making Pin 6 the one on the
+               other end of the row.
+             </para>
+           </listitem>
+         </varlistentry>
+       </variablelist>
+      </section>
+    </section>
+    <section>
+      <title>Pair Programming</title>
+      <para>
+       The big concept to understand is that you have to use a
+       TeleMega, TeleMetrum or TeleDongle as a programmer to update a
+       pair programmed device. Due to limited memory resources in the
+       cc1111, we don't support programming directly over USB for these
+       devices.
+      </para>
     </section>
     <section>
       <title>Updating TeleMetrum v1.x Firmware</title>