Updates to the WSJT-X User Guide for Version 1.8.

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

doc/CMakeLists.txt

@@ -63,6 +63,7 @@ set (UG_IMGS
   images/170709_135615.wav.png
   images/AstroData_2.png
   images/Astronomical_data.png
+  images/auto-seq.png
   images/band-settings.png
   images/colors.png
   images/config-menu.png
@@ -104,6 +105,7 @@ set (UG_IMGS
   images/setup-menu.png
   images/special-mouse-commands.png
   images/status-bar-a.png
+  images/tools-menu.png
   images/traditional-msg-box.png
   images/tx-macros.png
   images/view-menu.png

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

@@ -24,7 +24,7 @@ Many users prefer to create and use entries on the *Configurations*
 menu for switching between modes.  Simply *Clone* the *Default* entry,
 *Rename* it as desired, and then make all desired settings for that
 configuration.  These settings will be restored whenever you select
-that entry.
+that configuration.
 
 [[VIEW_MENU]]
 ==== View Menu
@@ -43,6 +43,9 @@ image::decode-menu.png[align="left",alt="Decode Menu"]
 ==== Save Menu
 image::save-menu.png[align="left",alt="Save Menu"]
 
+==== Tools Menu
+image::tools-menu.png[align="left",alt="Tools Menu"]
+
 [[HELP_MENU]]
 ==== Help Menu
 image::help-menu.png[align="left",alt="Help Menu"]

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

@@ -29,6 +29,12 @@ pre-stored messages entered on the *Settings | Tx Macros* tab.
 Pressing *Enter* on a modified message #5 automatically adds that
 message to the stored macros.
 
+* In some circumstances it may be desirable to make your QSOs as
+shiort as possible.  To configure the program to start contacts with
+message #2, disable message #1 by double-clicking on its round
+radio-button or rectangular *Tx 1* button.  Similarly, to send RR73
+rather than RRR for message #4, double-click on one of its buttons.
+
 The second arrangement of controls for generating and selecting
 Tx messages appears on *Tab 2* of the Message Control Panel:
 

doc/user_guide/en/make-qso.adoc

@@ -47,6 +47,26 @@ compound callsign.  It should be obvious that the JT4, JT9, and JT65
 protocols are not designed or well suited for extensive conversations
 or rag-chewing.
 
+=== Auto-Sequencing
+
+The slow modes JT4, JT9, JT65, and QRA64 allow nearly 10 seconds at
+the end of each one-minute receiving sequence in which you can inspect
+decoded messages and decide how to reply.  With its 15-second T/R
+cycles, FT8 allows only about two seconds for this task.  For this
+reason a basic auto-sequencing feature is offered. Check *Auto Seq*
+on the main window to enable this feature:
+
+image::auto-seq.png[align="center",alt="AutoSeq"]
+
+When calling CQ you may also choose to check the box *Call 1st*.
+_WSJT-X_ will then respond automatically to the first decoded
+responder to your CQ.
+
+TIP: When *Auto-Seq* is enabled the program will de-activate *Enable
+Tx* at the end of each QSO.  We do not want _WSJT-X_ to make fully
+automated QSOs.
+
+
 [[COMP-CALL]] 
 === Compound Callsigns
 

doc/user_guide/en/new_features.adoc

@@ -3,7 +3,9 @@
 For quick reference, here's a short list of features and capabilities
 added to _WSJT-X_ since Version 1.7.0:
 
-- New modes: *FT8* and *FreqCal*
+- New mode *FT8* designed for fast QSOs
+
+- New tool *FreqCal* for accurate frequency calibration of your radio
 
 - Improved decoding performance for JT65, QRA64, and MSK144
 
@@ -11,18 +13,19 @@ added to _WSJT-X_ since Version 1.7.0:
 
 - Experimental amplitude and phase equalization for MSK144
     
-- Options to minimize screen space used by the *Main* and *Wide Graph*
+- Options to minimize screen space used by *Main* and *Wide Graph*
 windows
     
 - New set of suggested default frequencies specific to the three IARU
 Regions.
 
-- Enhanced scheme for managing table of default operating frequencies
+- Enhanced scheme for managing table of suggested default operating
+frequencies
 
-- Improved CAT control for many rigs, including those controlled
+- Improved CAT control for many radios, including those controlled
 through Commander or OmniRig.
 
-- Bug fixes and tweaks to the user interface
+- Bug fixes and tweaks to user interface
 
 === Documentation Conventions
 

doc/user_guide/en/odds_and_ends.adoc

@@ -14,7 +14,7 @@ summarized in the following Table:
 [width="50%",cols="h,3*^",frame=topbot,options="header"]
 |===========================================
 |Mode    |Mode character|Sync character|End of line information
-|FT8     | ~            |      |
+|FT8     | ~            |      | aP
 |JT4     | $            | *, # | f, fN, dNC
 |JT9     | @            |      |
 |JT65    | #            |      |
@@ -28,14 +28,32 @@ Sync character::
  `#` - Alternate sync
 
 End of line information::
+ `a` - Decoded with aid of some a priori (AP) information
  `C` - Confidence indicator [ISCAT and Deep Search; (0-9,*)] +
  `d` - Deep Search algorithm +
  `f` - Franke-Taylor or Fano algorithm +
  `M` - Message length (characters) +
  `N` - Number of Rx intervals or frames averaged +
+ `P` - Number indicating type of AP information (see table below)
  `R` - Return code from QRA64 decoder +
  `T` - Length of analyzed region (s)
 
+[[AP_INFO_TABLE]]
+.AP information types
+[width="25%",cols="h10,<m20",frame=topbot,options="header"]
+|===========================================
+|P | Message components
+|1 | CQ   &#160; &#160;   ?   &#160; &#160;   ? 
+|2 | DE   &#160; &#160;   ?   &#160; &#160;   ? 
+|3 | MyCall &#160; &#160; ?   &#160; &#160;   ? 
+|4 | MyCall DxCall &#160; &#160;  ? 
+|5 | MyCall DxCall RRR
+|6 | MyCall DxCall 73
+|7 | MyCall DxCall RR73
+|8 |   ? &#160; &#160;   DxCall &#160; &#160; ?
+|===========================================
+
+
 === Reference Spectrum
 
 WSJT-X provides a tool that can be used to determine the detailed

doc/user_guide/en/settings-advanced.adoc

@@ -11,9 +11,9 @@ 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
+- Check *FT8 and MSK144 Contest Mode* to enable generation and
-of MSK144 messages with four-character grid locators in place of signal
+auto-sequencing of MSK144 messages with four-character grid locators
-reports.
+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

doc/user_guide/en/settings-general.adoc

@@ -3,8 +3,11 @@
 image::settings-general.png[align="center",alt="Settings Window"]
 
 Select the *General* tab on the *Settings* window.  Under _Station
-Details_, enter your callsign and 4-digit or preferably 6-digit grid
+Details_ enter your callsign, grid locator (preferably the 6-character
-locator.  This information will be sufficient for initial tests.
+locator) and IARU Region number.  Region 1 is Europe, Africa, the
+Middle East, and Northern Asia; Region 2 the Americas; and Region 3
+Southern Asia and the Pacific.  This information will be sufficient
+for initial tests.
 
 Meanings of remaining options on the *General* tab should be
 self-explanatory after you have made some QSOs using _WSJT-X_.  You

doc/user_guide/en/transceiver-setup.adoc

@@ -21,14 +21,13 @@ about 5 kHz.  This choice has the desirable effect of allowing the
 JT65 and JT9 sub-bands simultaneously on most HF bands.  Further
 details are provided in the <<TUTORIAL,Basic Operating Tutorial>>.  A
 wider displayed bandwidth may also be helpful at VHF and above, where
-JT4, JT65, and QRA64 signals are found over much wider ranges of
+FT8, JT4, JT65, and QRA64 signals may be found over much wider ranges
-frequencies.
+of frequencies.
 
 - If you have only a standard SSB filter you won’t be able to display
 more than about 2.7 kHz bandwidth.  Depending on the exact dial
 frequency setting, on HF bands you can display the full sub-band
-generally used for one mode (JT65 or JT9) and part of the sub-band for
+generally used for one mode.
-the other mode.
 
 - Of course, you might prefer to concentrate on one mode at a time,
 setting your dial frequency to (say) 14.074 for FT8, 14.076 for JT65,

doc/user_guide/en/tutorial-example3.adoc

@@ -6,22 +6,45 @@
 
 .Wide Graph Settings:
 
-- *Bins/Pixel* = 4
+- *Bins/Pixel* = 4, *Start* = 200 Hz, *N Avg* = 2
 - Adjust the width of the Wide Graph window so that the upper
-frequency limit is approximately 2500 Hz.
+frequency limit is approximately 2600 Hz.
 
 .Open a Wave File:
 
-- Select *File | Open* and navigate to +...\save\samples\FT8\170709_135615.wav+.
+- Select *File | Open* and navigate to
-The waterfall should look something like this:
++...\save\samples\FT8\170709_135615.wav+.  The waterfall and decoded
+text window should look something like the following screen shots:
 
 [[X15]]
 image::170709_135615.wav.png[align="left",alt="Wide Graph Decode 170709_135615"]
 
-- You should see decodes of the three FT8 signals in the *Band Activity*
-text box, as shown below:
-
 image::ft8_decodes.png[align="left"]
 
+- Click with the mouse anywhere on the waterfall display. The green Rx
+frequency marker will jump to your selected frequency, and the Rx
+frequency control on the main window will be updated accordingly.
+
+- Do the same thing with the Shift key held down.  Now the red Tx
+frequency marker and its associated control on the main window will
+follow your frequency selections.
+
+- Do the same thing with the Ctrl key held down.  Now the both colored 
+markers and both spinner controls will follow your selections.
+
+- Double-clicking at any frequency on the waterfall does all the
+things just described and also invokes the decoder in a small range
+around that frequency.
+
+- Now double-click on any of the the lines of decoded text in the main
+window.  Unless you have *My Call* set to K1JT or KY7M on the
+*Settings -> General* tab, all three lines will show the same
+behavior, setting both RxFreq and TxFreq to the frequency of the
+selected message.  However, if MyCall is set to K1JT then clicking on
+a message directed to K1JT will move only the Rx frequency setting.
+This behavior is desirable so that you will not inadvertently change
+your Tx frequency to that of a tail-ender who called you somewhere
+else in the FT8 subband.
+
 IMPORTANT: When finished with this Tutorial, don’t forget to re-enter
 your own callsign as *My Call* on the *Settings | General* tab.

doc/user_guide/en/vhf-features.adoc

@@ -1,9 +1,6 @@
 _WSJT-X_ v1.8 suppports a number of features designed for use
 on the VHF and higher bands.  These features now include:
 
-- *FT8*, a mode optimized for weak, fading signals such as those often
-encountered with multi-hop sporadic E propagation on 50 MHz.
-
 - *JT4*, a mode particularly useful for EME on the microwave bands
 
 - *JT9* fast modes, useful for scatter propagation on VHF bands
@@ -24,9 +21,6 @@ propagation
 - *Doppler tracking*, which becomes increasingly important for EME
 on bands above 1.2 GHz.
 
-- *Auto-sequencing* of transmitted messages for FT8 and the fast modes
-with forward error control
-
 [[VHF_SETUP]]
 === VHF Setup
 

mouse_commands.txt

@@ -21,7 +21,7 @@
         changed unless Ctrl is held down when double-clicking.<br/>
 	<br/>
 	Hold down Alt to only move the Rx frequency when<br/>
-	when double-clicking to reply to a CQ or QRZ caller.
+	double-clicking to reply to a CQ or QRZ caller.
     </td>
   </tr>
   <tr>