[amateur-radio-guide] Add Chirp documentation

John J. McDonough jjmcd at fedoraproject.org
Thu Nov 24 03:47:51 UTC 2011


commit aa1cafb99f117ea5c737c101ff81a743beaea777
Author: John J. McDonough <jjmcd at fedoraproject.org>
Date:   Wed Nov 23 22:47:41 2011 -0500

    Add Chirp documentation

 en-US/Revision_History.xml |    1 +
 en-US/rig-chirp.xml        |   34 +++++++++++++++++++++++++++++++---
 2 files changed, 32 insertions(+), 3 deletions(-)
---
diff --git a/en-US/Revision_History.xml b/en-US/Revision_History.xml
index 49d0a63..10972d1 100644
--- a/en-US/Revision_History.xml
+++ b/en-US/Revision_History.xml
@@ -17,6 +17,7 @@
 	<revdescription>
 	  <simplelist>
 	    <member>Remove xdx, obsoleted in Fedora 16</member>
+	    <member>Documentation for Chirp</member>
 	  </simplelist>
 	</revdescription>
       </revision>
diff --git a/en-US/rig-chirp.xml b/en-US/rig-chirp.xml
index 492b58c..3c68611 100644
--- a/en-US/rig-chirp.xml
+++ b/en-US/rig-chirp.xml
@@ -14,6 +14,7 @@
   </para>
 
   <para>
+    <application>chirp</application> is started by clicking the chirp icon.
     <figure float="0"><title>Chirp icon</title>
     <mediaobject>
       <imageobject><imagedata scale="40" scalefit="1" fileref="images/rig-chirp/chirp001.png" format="PNG"/></imageobject>
@@ -23,10 +24,18 @@
       </textobject>
     </mediaobject>
     </figure>
+    This will present a rather uninteresting blank screen.
   </para>
 
   <para>
-    <figure float="0"><title>Chirp Radio Dialog</title>
+    In most cases, the user will wish to begin by selecting
+    <guilabel>Download from Radio</guilabel> from the
+    <guimenu>Radio</guimenu> menu.  This will launch a dialog
+    requesting some basic information such as the desired serial port,
+    radio vendor and model.  Note that the selected serial port must
+    permit read/write access.
+    <figure float="0"><title>Chirp Radio
+    Dialog</title>
     <mediaobject>
       <imageobject><imagedata scale="99" scalefit="1" fileref="images/rig-chirp/chirp002.png" format="PNG"/></imageobject>
       <textobject><para>
@@ -35,9 +44,15 @@
       </textobject>
     </mediaobject>
     </figure>
+    Clicking the <guilabel>OK</guilabel> button will begin reading the
+    radio's memory.
   </para>
 
   <para>
+    As the data is read, the data will begin to appear in the window.
+    However, depending on the radio this could take some time.
+    Numbers at the bottom of the window indicate how many memories
+    remain to be read, and how many have been read.
     <figure float="0"><title>Chirp Main Screen</title>
     <mediaobject>
       <imageobject><imagedata scale="99" scalefit="1" fileref="images/rig-chirp/chirp003.png" format="PNG"/></imageobject>
@@ -50,6 +65,7 @@
   </para>
 
   <para>
+    To change a value, simply click on the field and begin typing.
     <figure float="0"><title>Changing a memory location</title>
     <mediaobject>
       <imageobject><imagedata scale="99" scalefit="1" fileref="images/rig-chirp/chirp004.png" format="PNG"/></imageobject>
@@ -59,9 +75,17 @@
       </textobject>
     </mediaobject>
     </figure>
+    On some radios, data is changed in the radio as soon as it is
+    changed onscreen.  For others, it will be necessary to select the
+    <guilabel>Download to Radio</guilabel> from the
+    <guimenu>Radio</guimenu> menu.
   </para>
 
   <para>
+    By default, only the first 25 memories are displayed.  Near the
+    top of the screen the <guilabel>Memory range</guilabel> controls
+    allow for selecting those memories to be displayed.  If a large
+    number of memories are selected, it may take some time to display.
     <figure float="0"><title>Selecting Memory Range to Display</title>
     <mediaobject>
       <imageobject><imagedata scale="100" scalefit="1" fileref="images/rig-chirp/chirp005.png" format="PNG"/></imageobject>
@@ -74,7 +98,9 @@
   </para>
 
   <para>
-    <figure float="0"><title>Large Display</title>
+    Depending on the radio, there may be quite a few columns to
+    display, so maximizing the windw could be helpful.  <figure
+    float="0"><title>Large Display</title>
     <mediaobject>
       <imageobject><imagedata scale="99" scalefit="1" fileref="images/rig-chirp/chirp006.png" format="PNG"/></imageobject>
       <textobject><para>
@@ -86,7 +112,9 @@
   </para>
 
   <para>
-    <figure float="0"><title>Selecting Columns</title>
+    Individual columns may be removed from the display, making the
+    display more manageable.  <figure float="0"><title>Selecting
+    Columns</title>
     <mediaobject>
       <imageobject><imagedata scale="99" scalefit="1" fileref="images/rig-chirp/chirp007.png" format="PNG"/></imageobject>
       <textobject><para>


More information about the docs-commits mailing list