Many editorial changes to User Guide.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7235 ab8295b8-cf94-4d9e-aec4-7959e3be5d79

doc/CMakeLists.txt

@@ -67,6 +67,7 @@ set (UG_IMGS
   images/config-menu.png
   images/decode-menu.png
   images/decodes.png
+  images/download_samples.png
   images/file-menu.png
   images/freemsg.png
   images/help-menu.png

doc/user_guide/en/acknowledgements.adoc

@@ -2,7 +2,7 @@
 
 The _WSJT_ project was started in 2001.  Since 2005 it has been an
 Open Source project, and it now includes programs _WSJT_, _MAP65_,
-_WSPR_, _WSJT-X_, and _WSPR-X_.  All all code is licensed under the
+_WSPR_, _WSJT-X_, and _WSPR-X_.  All code is licensed under the
 GNU Public License (GPL).  Many users of these programs, too numerous
 to mention here individually, have contributed suggestions and advice
 that have greatly aided the development of _WSJT_ and its sister
@@ -12,7 +12,7 @@ For _WSJT-X_ in particular, we acknowledge contributions from *AC6SL,
 AE4JY, DJ0OT, G3WDG, G4KLA, G4WJS, IV3NWV, IW3RAB, K3WYC, K9AN,
 KA6MAL, KA9Q, KB1ZMX, KD6EKQ, KI7MT, KK1D, ND0B, PY2SDR, VK3ACF,
 VK4BDJ, VK7MO, W4TI, W4TV, and W9MDB*.  Each of these amateurs has helped to
-bring the program’s design, code, tetsting, and/or documentation to
+bring the program’s design, code, testing, and/or documentation to
 its present state.
 
 Most of the color palettes for the _WSJT-X_ waterfall were copied from

doc/user_guide/en/controls-functions-center.adoc

@@ -23,7 +23,7 @@ Tx=Rx* to make the frequencies always track one another.  The
 on-the-air frequency of your lowest JT9 or JT65 tone is the sum of
 dial frequency and audio Tx frequency.
 
-IMPORTANT: In general we do not recommend using *Lock Tx=Rx* since it
+TIP: In general we do not recommend using *Lock Tx=Rx* since it
 encourages poor radio etiquette when running a frequency.  With *Lock
 Tx=Rx* checked, your own Tx frequency will move around following your
 callers.
@@ -33,6 +33,6 @@ inserted automatically. Typical reports for the various modes fall in
 the range –30 to +20 dB.  Remember that JT65 reports saturate at an
 upper limit of -1 dB.
 
-IMPORTANT: Consider reducing power if your QSO partner reports your
+TIP: Consider reducing power if your QSO partner reports your
 signal above -5 dB in one of the _WSJT-X_ slow modes.  These are
 supposed to be weak signal modes!

doc/user_guide/en/controls-functions-left.adoc

@@ -24,10 +24,10 @@ if the rig is detected to be in *Split* mode.  The circle becomes red
 if you have requested CAT control but communication with the radio has
 been lost.
 
-IMPORTANT: Many Icom rigs cannot be queried for split status, current
+TIP: Many Icom rigs cannot be queried for split status, current VFO or
-VFO or split transmit frequency.  Consequently you should not change
+split transmit frequency. When using _WSJT-X_ with such radios you
-the current VFO, split status or frequency using controls on the radio
+should not change the current VFO, split status or dial frequency
-when using _WSJT-X_ with an Icom radio.
+using controls on the radio.
 
 * If *DX Grid* contains a valid Maidenhead locator, the corresponding
 great-circle azimuth and distance from your location are displayed.
@@ -37,4 +37,5 @@ future reference.  Click *Add* to insert the present call and locator
 in the database; click *Lookup* to retrieve the locator for a
 previously stored call.  This feature is mainly useful for situations
 in which the number of active stations is modest and reasonably
-stable, such as EME (Earth-Moon-Earth) communication.
+stable, such as EME (Earth-Moon-Earth) communication.  The callsign
+file name is `CALL3.TXT`.

doc/user_guide/en/controls-functions-wide-graph.adoc

@@ -46,7 +46,8 @@ messages are used.
 - Four sliders control reference levels and scaling for waterfall
 colors and the spectrum plot.  Values around midscale are usually
 about right, depending on the input signal level, the chosen palette,
-and your own preferences.
+and your own preferences. Hover the mouse over a control to display a
+tip reminding you of its function.
 
 - *Smoothing* is active only when *Linear Average* has been selected.
 Smoothing the displayed spectrum over more than one bin can enhance
@@ -80,7 +81,7 @@ to compress the spectral display.
 spectra.
 
 - *Smooth* values greater than 0 apply running averages to the plotted
-spectra, therebu smoothing the curves over multiple bins.
+spectra, thereby smoothing the curves over multiple bins.
 
 - Label *N* shows the number of echo pulses averaged.
 

doc/user_guide/en/install-windows.adoc

@@ -14,7 +14,7 @@ installation directory and its subdirectories.
 directory +
 `C:\Users\<username>\AppData\Local\WSJT-X`.
 
-IMPORTANT: Your computer may be configured so that this directory is
+TIP: Your computer may be configured so that this directory is
 "`invisible`".  It's there, however, and accessible.  An alternative
 (shortcut) directory name is `%LOCALAPPDATA%\WSJT-X\`.
 

doc/user_guide/en/make-qso.adoc

@@ -31,7 +31,7 @@ lie in the range –30 to –1 dB, and values are significantly compressed
 above about -10 dB.  JT9 supports the extended range –50 to +49 dB and
 assigns more reliable numbers to relatively strong signals.
 
-IMPORTANT: Signals become visible on the waterfall around S/N = –26 dB
+NOTE: Signals become visible on the waterfall around S/N = –26 dB
 and audible (to someone with very good hearing) around –15
 dB. Thresholds for decodability are around -23 dB for JT4, –24 dB for
 JT65, –26 dB for JT9.
@@ -109,11 +109,10 @@ In each case, the compound callsign is treated as *Type 2* because the
 add-on prefix or suffix is _not_ one of those in the fixed list.  Note
 that a second callsign is never permissible in these messages.
 
-IMPORTANT: Remember that during a transmission your transmitted message is
+TIP: During a transmission your outgoing message is displayed in the
-always displayed in the first label on the *Status Bar*, highlighted
+first label on the *Status Bar* and shown exactly as another station
-in yellow.  It is displayed there exactly as another station will
+will receive it.  You can check to see that you are actually
-receive it.  Be sure to check that you are actually transmitting the
+transmitting the message you wish to send.
-message you wish to send!
 
 QSOs involving *Type 2* compound callsigns might look like either
 of the following sequences
@@ -138,7 +137,7 @@ and possibly also in a 73 transmission, as may be required by
 licensing authorities.  Other transmissions during a QSO may use the
 standard structured messages without callsign prefix or suffix. 
 
-IMPORTANT: If you are using a compound callsign, you may want to
+TIP: If you are using a compound callsign, you may want to
 experiment with the option *Message generation for type 2 compound
 callsign holders* on the *Settings | General* tab, so that messages
 will be generated that best suit your needs.
@@ -159,6 +158,6 @@ as the following checklist:
 
 - Radio filters centered and set to widest available passband (up to 5 kHz).
 
-IMPORTANT: Remember that JT4, JT9, J65, and WSPR generally do not
+TIP: Remember that in many circumstances JT4, JT9, JT65, and WSPR do
-require high power. Under most HF propagation conditions, QRP is the
+not require high power. Under most HF propagation conditions, QRP is
-norm.
+the norm.

doc/user_guide/en/protocols.adoc

@@ -97,30 +97,32 @@ Still to come ...
 
 Table 1 provides a brief summary parameters for the slow modes in
 _WSJT-X_.  Parameters K and r specify the constraint length and rate
-of the convolutional codes; n and k give the sizes of the (equivalent)
+of the convolutional codes; n and k specify the sizes of the
-block codes; Q is the alphabet size for the information-carrying
+(equivalent) block codes; Q is the alphabet size for the
-channel symbols; Mod, Baud, and BW specify the modulation type, keying
+information-carrying channel symbols; Sync Energy is the fraction of
-rate, and occupied bandwidth; fSync is the fraction of transmitted
+transmitted energy devoted to synchronizing symbols; and S/N Threshold
-energy devoted to synchronizing symbols; TxT is the transmission
+is the signal-to-noise ratio (in a 2500 Hz reference bandwidth) above
-duration, and S/N is the signal-to-noise ratio (in a 2500 Hz reference
+which the probability of decoding is 50% or higher.
-bandwidth) above which the probability of decoding is 50% or higher.
 
 [[SLOW_TAB]]
 .Parameters of Slow Modes
 [width="90%",cols="3h,^3,^2,^1,^2,^2,^2,^2,^2,^2",frame=topbot,options="header"]
 |===============================================================================
-|Mode  |FEC Type   |(n,k)   | Q|  Mod | Baud |BW (Hz)|fSync|TxT (s)|S/N (dB)
+|Mode |FEC Type |(n,k) | Q|Modulation type|Keying rate (Baud)|Bandwidth (Hz)
-|JT4A  |K=32, r=1/2|(206,72)| 2| 4-FSK| 4.375|  17.5 | 0.50| 47.1   | -23
+|Sync Energy|Tx Duration (s)|S/N Threshold (dB)
-|JT9A  |K=32, r=1/2|(206,72)| 8| 9-FSK| 1.736|  15.6 | 0.19| 49.0   | -27
+|JT4A |K=32, r=1/2|(206,72)| 2| 4-FSK| 4.375| 17.5 |
-|JT65A |Reed Solomon|(63,12) |64|65-FSK| 2.692| 177.6 | 0.50| 46.8   | -25
+0.50| 47.1 | -23 |JT9A |K=32, r=1/2|(206,72)| 8| 9-FSK| 1.736| 15.6 |
-|QRA64A|Q-ary Repeat Accumulate|(63,12) |64|64-FSK| 1.736| 111.1 | 0.25| 48.4   | -26
+0.19| 49.0 | -27 |JT65A |Reed Solomon|(63,12) |64|65-FSK| 2.692| 177.6
-| WSPR |K=32, r=1/2|(162,50)| 2| 4-FSK| 1.465|   5.9 | 0.50|110.6   | -29
+| 0.50| 46.8 | -25 |QRA64A|Q-ary Repeat Accumulate|(63,12) |64|64-FSK|
+1.736| 111.1 | 0.25| 48.4 | -26 | WSPR |K=32, r=1/2|(162,50)| 2|
+4-FSK| 1.465| 5.9 | 0.50|110.6 | -29
 |===============================================================================
 
-Submodes of the JT4, JT9, JT65, and QRA64 protocols offer wider tone
+Submodes of JT4, JT9, JT65, and QRA64 offer wider tone spacings for
-spacings that may be desirable for channels causing significant
+circumstances that may require them, such significant Doppler spread.
-Doppler spread.  Table 2 summarizes the tone spacings, bandwidths, and
+Table 2 summarizes the tone spacings, bandwidths, and approximate
-threshold sensitivities of the various submodes.
+threshold sensitivities of the various submodes when spreading is
+comparable to tone spacing.
 
 [[SLOW_SUBMODES]]
 .Parameters of Slow Submodes

doc/user_guide/en/settings-advanced.adoc

@@ -11,6 +11,10 @@ most purposes a good setting is 6 or 7.
 decodes using Deep Search.  Higher numbers will display results 
 with lower confidence levels.
 
+- Check *MSK144 Contest Mode* to cause generation and auto-sequencing
+of MSK144 messages with four-character grid locators in place of signal
+reports.
+
 - Check *Two-pass decoding* to enable a second decoding pass after
 signals producing first-pass decodes have been subtracted from the
 received data stream.

doc/user_guide/en/settings-audio.adoc

@@ -8,14 +8,15 @@ Select the *Audio* tab to configure your sound system.
 *Output*.  Usually the *Mono* settings will suffice, but in special
 cases you can choose *Left*, *Right*, or *Both* stereo channels.
 
+- Be sure that your audio device is configured to sample at 48000 Hz,
+16 bits.
+
+
 IMPORTANT: If you select the audio output device that is also your
 computer's default audio device, be sure to turn off all system sounds
-to prevent inadvertently transmitting them over the air.
+to prevent inadvertently transmitting them over the air.  
 
-IMPORTANT: Be sure that your audio device is configured to sample at
+NOTE: Windows Vista and later may configure audio devices using
-48000 Hz, 16 bits.
-
-IMPORTANT: Windows Vista and later may configure audio devices using
 the Texas Instruments PCM2900 series CODEC for microphone input rather
 line input.  (This chip is used in many radios with built-in USB
 CODECs, as well as various other audio interfaces.)  If you are using

doc/user_guide/en/settings-general.adoc

@@ -10,6 +10,6 @@ Meanings of remaining options on the *General* tab should be
 self-explanatory after you have made some QSOs using _WSJT-X_.  You
 may return to set these options to your preferences later.  
 
-IMPORTANT: If you are using a callsign with an add-on prefix or
+TIP: If you are using a callsign with an add-on prefix or
 suffix, or wish to work a station using such a call, be sure to read
 the section <<COMP-CALL,Compound Callsigns>>.

doc/user_guide/en/tutorial-example1.adoc

@@ -1,5 +1,3 @@
-// Status=review
-
 For this step and the next, you may want to pretend you are K1JT
 by entering that callsign temporarily as *My Call* on the 
 *Settings | General* tab.  Your results should then be identical to
@@ -8,8 +6,8 @@ those shown in the screen shot below.
 .Open a Wave File:
 
 - Select *File | Open* and select the file
-+...\save\samples\130418_1742.wav+. When the file opens you should see
++...\save\samples\JT9\130418_1742.wav+. When the file opens you should
-something similar to the to the following screen shot:
+see something similar to the to the following screen shot:
 
 [[X12]]
 image::main-ui.png[align="center",alt="Main UI and Wide Graph"]

doc/user_guide/en/tutorial-example2.adoc

@@ -50,7 +50,7 @@ image::decodes.png[align="center"]
 earlier, in <<TUT_EX1,Example 1>>.  _WSJT-X_ automatically determines
 the mode of each JT9 or JT65 message.
 
-IMPORTANT: When you double-click on a signal in the waterfall it will be
+TIP: When you double-click on a signal in the waterfall it will be
 properly decoded even if on the "`wrong`" side of the *JT65 nnnn JT9*
 marker.  The Tx mode automatically switches to that of the decoded
 signal and the Rx and Tx frequency markers on the waterfall scale

doc/user_guide/en/tutorial-main-window.adoc

@@ -6,7 +6,7 @@
 
 - Set the audio frequencies to *Tx 1224 Hz* and *Rx 1224 Hz*.  
 
-IMPORTANT: Sliders and spinner controls respond to *Arrow* key presses
+TIP: Sliders and spinner controls respond to *Arrow* key presses
 and *Page Up/Down* key presses, with the *Page* keys moving the
 controls in larger steps.  You can also type numbers directly into
 the spinner controls or use the mouse wheel.
@@ -14,3 +14,12 @@ the spinner controls or use the mouse wheel.
 - Select *Tab 2* (below the *Decode* button) to choose the alternative
 set of controls for generating and selecting Tx messages.
 
+=== Download Samples
+
+- Select *Download samples...* from the *Help* menu.
+
+- Download some or all of the available sample files using checkboxes
+on the screen shown below.  For this tutorial you will need at least
+the JT9 and JT9+JT65 files.
+
+image::download_samples.png[align="center",alt="Downlod Samples"]

doc/user_guide/en/vhf-features.adoc

@@ -38,12 +38,13 @@ received signals.
 - If you will use automatic Doppler tracking and your radio accepts
 frequency-setting commands while transmitting, check *Allow Tx
 frequency changes while transmitting*.  Transceivers known to permit
-such changes include the IC-735, IC-756 Pro II, IC-910-H, FT-817,
+such changes include the IC-735, IC-756 Pro II, IC-910-H, FT-847,
-FT-847, FT-857, FT-897, TS-590S, TS-590SG, TS-2000 (with Rev 9 or
+TS-590S, TS-590SG, TS-2000 (with Rev 9 or later firmware upgrade),
-later firmware upgrade), Flex 1500 and 5000, HPSDR, Anan-10, Anan-100,
+Flex 1500 and 5000, HPSDR, Anan-10, Anan-100, and KX3.  To gain full
-and KX3.
+benefit of Doppler tracking your radio should allow frequency changes
+under CAT control in 1 Hz steps.
 
-IMPORTANT: If your radio does not accept commands to change frequency
+NOTE: If your radio does not accept commands to change frequency
 while transmitting, Doppler tracking will be approximated with a
 single Tx frequency adjustment before a transmission starts, using a
 value computed for the middle of the Tx period.
@@ -218,10 +219,10 @@ capability being used by the MSK144 real-time decoder.  If it is well
 below 100% you may increase the decoding depth from *Fast* to *Normal*
 or *Deep*, and increase *F Tol* from 100 to 200 Hz.
 
-IMPORTANT: Most modern multi-core computers can easily handle the
+NOTE: Most modern multi-core computers can easily handle the
 optimum parameters *Deep* and *F Tol 200*.  Older and slower machines
 may not be able to keep up at these settings; in that case there will
-be a modest loss in decoding capability for the very weakest pings.
+be a modest loss in decoding capability for the weakest pings.
 
 - T/R sequences of 15 seconds or less requires selecting your
 transmitted messages very quickly.  Check *Auto Seq* to have the
@@ -245,7 +246,7 @@ enclosed in <> angle brackets, as in the following model QSO
                     <K1ABC W9XYZ> 73
 
 
-IMPORTANT: There is little or no advantage to using MSK144 *Sh*
+NOTE: There is little or no advantage to using MSK144 *Sh*
 messages at 50 or 70 MHz.  At these frequencies, most pings are long
 enough to support standard messages -- which have the advantage of
 being readable by anyone listening in.