Many more updates to WSJT-X v1.7 User Guide.

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

doc/CMakeLists.txt

@@ -12,6 +12,7 @@ set (UG_SRCS
   docinfo.html
   docinfo.xml
   acknowledgements.adoc
+  astro_data.adoc
   compiling.adoc
   config-details.adoc
   controls-functions-center.adoc
@@ -58,8 +59,11 @@ set (UG_SRCS
 
 set (UG_IMGS
   images/130610_2343-wav-80.png
+  images/AstroData_2.png
+  images/Astronomical_data.png
   images/band-settings.png
   images/colors.png
+  images/config-menu.png
   images/decode-menu.png
   images/decodes.png
   images/file-menu.png
@@ -69,7 +73,7 @@ set (UG_IMGS
   images/keyboard-shortcuts.png
   images/log-qso.png
   images/MacAppMenu.png
-  images/main-ui-1.5.png
+  images/main-ui.png
   images/main-ui-controls.png
   images/misc-controls-center.png
   images/misc-main-ui.png

doc/user_guide/en/astro_data.adoc

@@ -0,0 +1,44 @@
+A text box entitled Astronomical Data provides information needed for
+tracking the sun or moon, moon, compensating for EME Doppler shift,
+and estimating EME Doppler spread and path degradation. Toggle the
+*Astronomical data* on the *View* menu to display or remove this window.
+
+image::AstroData_2.png[align="center",alt="Astronomical Data"]
+
+Available information includes the current *Date* and *UTC* time; *Az*
+and *El*, azimuth and elevation of the moon at your own location, in
+degrees; *SelfDop*, *Width*, and *Delay*, the Doppler shift, full
+limb-to-limb Doppler spread, and delay of your own EME echoes; and
+*DxAz* and *DxEl*, *DxDop*, and *DxWid*, corresponding parameters for
+a station located at the DX Grid entered on the main window.  These
+numbers are followed by *Dec*, the declination of the moon; *SunAz*
+and *SunEl*, the azimuth and elevation of the Sun; *Freq*, your stated
+operating frequency in MHz; *Tsky*, the estimated sky background
+temperature in the direction of the moon, scaled to the operating
+frequency; *Dpol*, the spatial polarization offset in degrees; *MNR*,
+the maximum non-reciprocity of the EME path in dB, owing to spatial
+polarization; and finally *Dgrd*, an estimate of the signal
+degradation in dB, relative to the best possible time with the moon 
+at perigee in a cold part of the sky.
+
+The state of the art for establishing three-dimensional locations of
+the sun, moon, and planets at a specified time is embodied in a
+numerical model of the solar system maintained at the Jet Propulsion
+Laboratory. The model has been numerically integrated to produce
+tabular data that can be interpolated with very high accuracy. For
+example, the celestial coordinates of the moon or a planet can be
+determined at a specified time to within about 0.0000003 degrees. The
+JPL ephemeris tables and interpolation routines have been incorporated
+into _WSJT-X_.  Further details on accuracy, especially concerning
+calculated EME Doppler shifts, are described in 
+
+The sky background temperatures reported by _WSJT-X_ are derived from
+the all-sky 408 MHz map of Haslam et al. (Astronomy and Astrophysics
+Supplement Series, 47, 1, 1982), scaled by frequency to the (-2.6)
+power. This map has angular resolution of about 1 degree, and of
+course most amateur EME antennas have much broader beamwidths than
+this. Your antenna will therefore smooth out the hot spots
+considerably, and the observed extremes of sky temperature will be
+less. Unless you understand your sidelobes and ground reflections
+extremely well, it is unlikely that more accurate sky temperatures
+would be of much practical use.

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

@@ -1,22 +1,24 @@
 // Status=review
 
 At the center of the main window are a number of controls used when
-making QSOs:
+making QSOs.  Controls not relevant to a particular mode or submode
+may be "grayed out" (diabled) or removed from the display.
 
 //.Misc Controls Center
 image::misc-controls-center.png[align="center",alt="Misc Controls Center"]
 
-* Check *Tx even* to transmit in even-numbered UTC minutes.  Uncheck
-this box to transmit in the odd minutes.  This selection is made
-automatically when you double-click on a decoded text line, as
-described in the <<TUTORIAL,Basic Operating Tutorial>>.
+* Check *Tx even* to transmit in even-numbered UTC minutes or
+sequences, starting at 0.  Uncheck this box to transmit in the odd
+sequences.  The correct selection is made automatically when you
+double-click on a decoded text line, as described in the
+<<TUTORIAL,Basic Operating Tutorial>>.
 
-* The Tx and Rx audio frequencies are usually set automatically by
-double-clicking on decoded text or a signal in the waterfall.  They 
-can also be adjusted with spinner controls. 
+* The Tx and Rx audio frequencies can be set automatically by
+double-clicking on decoded text or a signal in the waterfall.  They
+can also be adjusted using the spinner controls.
 
 * You can force Tx frequency to the current Rx frequency by clicking
-the *Tx<Rx* button, and vice-versa for *Rx<Tx*.  Check the box *Lock
+the *Tx<-Rx* button, and vice-versa for *Rx<-Tx*.  Check the box *Lock
 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.

doc/user_guide/en/controls-functions-main-window.adoc

@@ -29,6 +29,10 @@ return to the original frequency.
 * *Erase* clears the right-hand decoded text window. 
 Double-clicking *Erase* clears both text windows.
 
+* *Clear Avg* is present only in modes that support message averaging.
+It provides a way to erase all previous decode information, thus
+preparing to start a new average.
+
 * *Decode* tells the program to repeat the decoding procedure at the
 Rx frequency (green marker on waterfall scale), using the most recently
 completed sequence of received data.  
@@ -36,8 +40,8 @@ completed sequence of received data.
 * *Enable Tx* toggles the program into automatic T/R sequencing mode
 and highlights the button in red.  A transmission will start at
 the beginning of the selected (odd or even) sequence, or immediately
-if appropriate.  A transmission will not be started any later than 24
-s into a UTC minute.
+if appropriate.  Toggling the button a second time will remove the
+highlighted background color and 
 
 * *Halt Tx* terminates a transmission in progress and disables
 automatic T/R sequencing.
@@ -47,5 +51,6 @@ unmodulated carrier at the specified Tx frequency (red marker on
 waterfall scale).  This process may be useful for adjusting an antenna
 tuner.  The button is highlighted in red while *Tune* is active.
 Toggle the button a second time or click *Halt Tx* to terminate the
-*Tune* process.
+*Tune* process.  Note that activating *Tune* interrupts a receive
+sequence and will prevent decoding during that sequence.
 

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

@@ -16,6 +16,10 @@ WSJT-X* appears here rather than on the *Help* menu.
 ==== File menu
 image::file-menu.png[align="left",alt="File Menu"]
 
+[[CONFIG_MENU]]
+==== Configuration Menu
+image::config-menu.png[align="left",alt="File Menu"]
+
 [[VIEW_MENU]]
 ==== View Menu
 image::view-menu.png[align="left",alt="View Menu"]

doc/user_guide/en/controls-functions-status-bar.adoc

@@ -12,6 +12,11 @@ recent transmitted message, and whether *Double-click on call sets Tx
 enable* has been selected on the *Settings | General* tab. The first
 label (operating state) can be Receiving, Tx (for Transmitting), Tune,
 or the name of file opened from the *File* menu; this label is
-highlighted in green for Receiving, yellow for Tx, and red for Tune.
-When transmitting, the Tx message is displayed exactly as it will be
-decoded by receiving stations.
+highlighted in green for Receiving, yellow for Tx, red for Tune, and
+light blue for a file name.  When transmitting, the Tx message is
+displayed exactly as it will be decoded by receiving stations.  A
+progress bar shows the elapsed fraction of a Tx or Rx sequence.
+Finally, if the Watchdog timer was enabled on the *settings | General*
+tab, a label in the lower right-hand corner diaplays the number of
+minutes remaining before timout.
+

doc/user_guide/en/protocols.adoc

@@ -136,6 +136,10 @@ efficiency. On a busy HF band, the conventional 2-kHz-wide JT65
 sub-band is often filled with overlapping signals. Ten times as many
 JT9 signals can fit into the same frequency range, without collisions.
 
+=== QRA64
+
+TBD
+
 === ISCAT
 
 ISCAT messages are free-form, up to 28 characters in length.
@@ -176,18 +180,6 @@ symbols in each 24, the user message +@CQ WA9XYZ+ repeats at its own
 natural length, 10 characters.  The resulting sequence is extended as
 many times as will fit into a Tx sequence.
 
-=== JTMSK
+=== MSK144
 
-The letters MS are often used to abbreviate meteor scatter; the three
-letters MSK mean "Minimum Shift Keying", the modulation scheme used in
-JTMSK.  This mode uses the same standard message structure as the slow
-modes JT4, JT9, and JT65.  User information is "`source encoded`" to
-72 bits; a 15-bit cyclic redundancy check (CRC) is appended, and a
-convolutional code with constraint length K=13 and rate r=1/2 is then
-applied.  This procedure makes for a total of (72+15+12)*2 = 198
-information bits for the encoded message.  Three copies of the
-"`Barker-11`" code and three even-parity bits are added for
-synchronization, making a total of 198+33+3 = 234 channel symbols.
-Modulation is carried out using a constant-envelope, continuous-phase
-minimum-shift keying (MSK) waveform, with tone frequencies of 1000
-and 2000 Hz.
+TBD

doc/user_guide/en/tutorial-example2.adoc

@@ -21,7 +21,7 @@ The waterfall should look something like this:
 [[X14]]
 image::130610_2343-wav-80.png[align="left",alt="Wide Graph Decode 130610_2343"]
 
-IMPORTANT: The position pf the blue marker on the waterfall scale is
+The position of the blue marker on the waterfall scale is
 set by the spinner control *JT65 nnnn JT9*, where nnnn is an audio
 frequency in Hz. In *JT9+JT65* mode the program will automatically
 decode JT9 signals only above this frequency. JT65 signals will be

doc/user_guide/en/vhf-features.adoc

@@ -29,18 +29,20 @@ To activate the VHF-and-up features:
 - If you will be doing EME, check the box *Decode at t = 52 s*
 to allow for the EME path delay on received signals
 
-- If you will use automatic Doppler tracking, check the box *Allow Tx
-frequency changes while transmitting*.
+- If you will use automatic Doppler tracking and your radio accepts
+QSY commands while transmitting, check the box *Allow Tx frequency
+changes while transmitting*.  Transceivers that allow such changes
+include the IC-735, IC-756 Pro II, IC-910-H, FT-817, FT-847, FT-857,
+FT-897, TS-590S, TS-590SG, TS-2000 (with Rev 9 firmware upgrade), Flex
+1500 and 5000, HPSDR, Anan-10, Anan-100, and KX3. On the *Radio* tab
+select *Split Operation* (use either *Rig* or *Fake It*; you may need
+to experiment with both options to find one that works best with your
+radio).
 
-IMPORTANT: Not all transceivers permit computer adjustments of Tx
-frequency while transmitting.  Among those that do are the IC-735,
-IC-756 Pro II, IC-910-H, FT-847, TS-2000 (with Rev 9 firmware
-upgrade), TS-590S, TS-590SG, Flex 1500 and 5000, HPSDR, Anan-10,
-Anan-100, and KX3.
-
-- On the *Radio* tab select *Split Operation* (use either *Rig* or
-*Fake It*; you may need to experiment with both options to find one
-that works best with your radio).
+- If your radio does not accept commands to change frequency while
+transmissing, Doppler tracking is accomplished by making a single Tx
+frequency adjustment before transmitting, using a value computed for
+the middle of the Tx period.
 
 - The main window reconfigures itself as necessary to include controls
 supporting features of each mode.  For example, in JT4 mode the
@@ -83,28 +85,29 @@ will be reset to 12183 Hz _below_ the nominal on-the-moon frequency.
 
 - Select the desired submode, which determines the tone spacing.
 Higher spacings are used on the higher microwave bands, to allow for
-larger Doppler spreads. For example, JT4F is generally used for EME on
-the 10 GHz band.  
+larger Doppler spreads. For example, submode JT4F is generally used
+for EME on the 10 GHz band.
 
 - If using a transverter, set the appropriate offset on the *Settings
-| Frequencies* tab.  Offset is defined as (desired transceiver dial
-reading) minus (desired on-the-air frequency).  For example, when
-using a 144 MHz radio at 10368 MHz, *Offset (MHz)* = (144 - 10368) =
--10224.000.  If the band is already in the table, you can edit the
-offset by double clicking on the offset field itself.  Otherwise a new
-band can be added by right clicking in the table and selecting *Insert*.
+| Frequencies* tab.  Offset is defined as (transceiver dial reading)
+minus (on-the-air frequency).  For example, when using a 144 MHz radio
+at 10368 MHz, *Offset (MHz)* = (144 - 10368) = -10224.000.  If the
+band is already in the table, you can edit the offset by double
+clicking on the offset field itself.  Otherwise a new band can be
+added by right clicking in the table and selecting *Insert*.
 
 image::Add_station_info.png[align="center",alt="Station information"]
 
 - The JT4 decoder in _WSJT-X_ includes optional facilities for
 averaging over successive transmissions and also correlation decoding,
-also known as "`Deep Search`".  
+also known as "`Deep Search`".  Either or both of these options may
+be selected from the *Decode* menu.
 
 image::decoding_depth.png[align="center",alt="Decoding Depth"]
 
-- By convention, EME with JT4 can use "`short form`" messages.  To
-activate automatic generation of these messages, check the box labeled
-*Sh* on the main window.
+- By convention, EME with JT4 can use "`short form`" messages
+consisting of a single tone.  To activate automatic generation of
+these messages, check the box labeled *Sh* on the main window.
 
 IMPORTANT: Thanks to G3WDG, many additional hints for using JT4 and
 Echo mode on the EME path are available in {jt4eme}.

doc/user_guide/en/wsjtx-main.adoc

@@ -198,6 +198,9 @@ include::faq.adoc[]
 == Protocol Specifications
 include::protocols.adoc[]
 
+[[ASTRODATA]]
+== Astronomical Data
+include::astro_data.adoc[]
 
 [[TXRX]]
 == Implementation Details