diff --git a/doc/images/main-ui-controls.png b/doc/images/main-ui-controls.png index c60bd4d86..a5fa58011 100644 Binary files a/doc/images/main-ui-controls.png and b/doc/images/main-ui-controls.png differ diff --git a/doc/images/misc-main-ui.png b/doc/images/misc-main-ui.png index ebbfa0d19..f8448f95a 100644 Binary files a/doc/images/misc-main-ui.png and b/doc/images/misc-main-ui.png differ diff --git a/doc/images/wide-graph-controls.png b/doc/images/wide-graph-controls.png index f16a013d9..f806b7c34 100644 Binary files a/doc/images/wide-graph-controls.png and b/doc/images/wide-graph-controls.png differ diff --git a/doc/source/acknowledgements.txt b/doc/source/acknowledgements.txt index 81a0d943a..3aa9795ec 100644 --- a/doc/source/acknowledgements.txt +++ b/doc/source/acknowledgements.txt @@ -2,18 +2,18 @@ Many users of WSJT, too numerous to mention here individually, have contributed suggestions and advice that have greatly aided the -development of {wsjtx} and its sister programs. Since 2005 the -overall project (including WSJT, MAP65, WSPR, {wsjtx}, and WSPR-X) has +development of _WSJT-X_ and its sister programs. Since 2005 the +overall project (including WSJT, MAP65, WSPR, _WSJT-X_, and WSPR-X) has been “open source”, with all code licensed under the GNU Public License (GPL). -For {wsjtx} in particular, we acknowledge contributions from *AC6SL, +For _WSJT-X_ in particular, we acknowledge contributions from *AC6SL, AE4JY, DJ0OT, G4KLA, G4WJS, K3WYC, KA6MAL, KA9Q, KI7MT, KK1D, PY2SDR, VK3ACF, VK4BDJ, and W4TV*. Each of these amateurs has helped to bring the program’s design, code, and documentation to its present state. -Most of the color palettes for the {wsjtx} waterfall were copied from +Most of the color palettes for the _WSJT-X_ waterfall were copied from the excellent, well documented, open-source program _fldigi_, by *W1HKJ* and friends. diff --git a/doc/source/configuration-band-settings.txt b/doc/source/configuration-band-settings.txt index d84dc4713..d2621e396 100644 --- a/doc/source/configuration-band-settings.txt +++ b/doc/source/configuration-band-settings.txt @@ -2,5 +2,5 @@ The Band Settings tab allows you to set the default frequency and a brief description of your antenna for each amateur band. The antenna -information will be included with reception reports, if they have been -enabled. +information will be included with reception reports to {pskreporter}, +if they have been enabled. diff --git a/doc/source/configuration-main-window.txt b/doc/source/configuration-main-window.txt index 05f69611c..076d3f98a 100644 --- a/doc/source/configuration-main-window.txt +++ b/doc/source/configuration-main-window.txt @@ -1,20 +1,19 @@ // Status=review -To set the proper level of audio drive from {wsjtx} to your radio: +To set the proper level of audio drive from _WSJT-X_ to your radio: -* Click the Tune button on the main screen.{wsjtx} should set the -radio into transmit mode and generate a steady audio tone at the -amplitude that will be used for a generated JT9 signal. +* Click the *Tune* button on the main screen._WSJT-X_ to switch the +radio into transmit mode and generate a steady audio tone. * Listen to the generated audio tone using your radio’s Monitor facility. The tone should be perfectly smooth, with no clicks or glitches. -* Open the computer’s audio mixer controls for output (“playback”) -devices and adjust the volume slider downward from 100% until the RF -output from your transmitter falls by around ten percent. This will -be a good level for audio drive. +* Open the computer’s audio mixer controls for output (“Playback”) +devices and adjust the volume slider downward from its maximum until +the RF output from your transmitter falls by around ten percent. This +will be a good level for audio drive. * Alternatively, you can make the same adjustment using the digital slider labeled *Pwr* at the right edge of the main window. -* Toggle the Tune button once more to stop your test transmission. +* Toggle the *Tune* button once more to stop your test transmission. diff --git a/doc/source/configuration-station.txt b/doc/source/configuration-station.txt index 422e1db4f..a8c83ddbf 100644 --- a/doc/source/configuration-station.txt +++ b/doc/source/configuration-station.txt @@ -1,29 +1,30 @@ // Status=review -Start {wsjtx} and Select Configuration from its Setup menu. Enter +- Start _WSJT-X_ and Select Configuration from its Setup menu. Enter the following information: -- *Call Sign*: -- *Grid*: -- *PTT method*: choose from RTS, DTR, CAT, VOX, or None. -- *PTT port*: if you will use RTS or DTR, choose a serial port. -- *PSK Reporter*: check to enable sending reception reports to the +* *Call Sign*: +* *Grid*: +* *PTT method*: choose from RTS, DTR, CAT, VOX, or None. +* *PTT port*: if you will use RTS or DTR, choose a serial port. +* *PSK Reporter*: check to enable sending reception reports to the {pskreporter} mapping facility. -- *CW ID*: Check to send your callsign in CW after sending 73. -- *CW Interval*: set the time interval for sending your CW identification. +* *CW ID*: Check to send your callsign in CW after sending 73. +* *CW Interval*: set the time interval for sending your CW identification. Default is 0 (never). -{wsjtx} does not implement full transceiver control, but it provides a -way to ensure that {wsjtx} can read and set the radio’s dial +_WSJT-X_ does not implement full transceiver control, but it provides a +way to ensure that _WSJT-X_ can read and set the radio’s dial frequency. If you want this capability: -- Check the box Enable CAT +- Check the box *Enable CAT* - Select your radio type from a drop-down list -- Select a CAT port (not the same port selected for PTT control) -- Set port parameters for your radio -- If you use {dxlcommander} by DX Lab or {hrd} to control your -transceiver, you can configure {wsjtx} to communicate with the radio -through that program. Entries for these programs appear at the end of -the drop-down list of supported radios. +- Select a *CAT port* (not the same port selected for PTT control) +- Set port parameters (*Serial rate*, *Handshake*, *Data bits*, *Stop +bits*) for your radio +- If you use {dxlcommander} or {hrd} to control your transceiver, you +can configure _WSJT-X_ to communicate with the radio through that +program. Entries for these programs appear at the end of the +drop-down list of supported rigs. [[X11]] image::images/r3563-config-screen-80.png[align="center",alt="Configuration Screen"] @@ -33,35 +34,35 @@ control, most radios will allow you to set *PTT method* = CAT. Some radios support two types of PTT assertion via CAT control: one takes audio input from the Mic connector, the other from a rear-panel Data connector. The simplest CAT configuration sets *Polling interval* = 0 -(no polling the radio for dial frequency). {wsjtx} will then be able +(no polling the radio for dial frequency). _WSJT-X_ will then be able to set the radio’s frequency, but the program will be unaware of subsequent changes made using the radio’s panel controls. TIP: If you need an additional item in the list of devices for the CAT port, edit the configuration file wsjtx.ini and add your requirement as CATdriver=yourdriver (for example, -CATdriver=/dev/ttyUSBserial ) in the group of entries marked +CATdriver=/dev/tty.usbserial ) in the group of entries marked [Common]. With most radios you can set *Polling interval* to a small number (say 1 – 3 s) and the program will follow any frequency changes made at the radio. Note that you may not be able simultaneously to control your -radio from {wsjtx} and from another program. Some experimentation may +radio from _WSJT-X_ and from another program. Some experimentation may be required, and you may need to refer to the documentation for your rig-control software and your radio. It is best to have the radio and any interface equipment turned on and connected before starting -{wsjtx}, and to exit the program before turning your equipment off. +_WSJT-X_, and to exit the program before turning your equipment off. -- Click the *Test CAT Control* and Test PTT buttons to see that you +- Click the *Test CAT Control* and *Test PTT* buttons to see that you have established the desired control of station functions. _ Select the devices you will use for Audio input and output. -- Click OK to dismiss the Configuration window. +- Click OK to dismiss the *Configuration* window. -- {wsjtx} expects your sound card to do its raw sampling at 48000 Hz. +- _WSJT-X_ expects your sound card to do its raw sampling at 48000 Hz. To ensure that this will be so when running under recent versions of -Windows, open the system's Sound control panel and select in turn the -“Recording” and “Playback” options. Click on Properties, then -Advanced, and select “16 bit, 48000 Hz (DVD Quality).” +Windows, open the system's sound control panel and select in turn the +*Recording* and *Playback* options. Click on *Properties*, then +*Advanced*, and select “16 bit, 48000 Hz (DVD Quality).” CAUTION: If you are using a sound card that is also the default device for Windows sounds, be sure to turn off all such sounds so they are diff --git a/doc/source/configuration-txmacros.txt b/doc/source/configuration-txmacros.txt index 255fcbdbb..99293375a 100644 --- a/doc/source/configuration-txmacros.txt +++ b/doc/source/configuration-txmacros.txt @@ -1,7 +1,6 @@ // Status=review -TX Macros are an aid for sending commonly used free-text messages. +*Tx Macros* are an aid for sending commonly used free-text messages. To enable a pull-down selection, add your custom messages to the entry -fields provided. Remember that the maximum free-text message length -is 13 characters. You access your macros by selecting Tx message #5 -(or the Free MSG Radio Button) on the main window, then right-click to -select the message to be sent. +fields provided. The maximum free-text message length in JT65 and JT9 +is 13 characters. + diff --git a/doc/source/controls-functions-center.txt b/doc/source/controls-functions-center.txt index 3287951de..2c8e9fe8a 100644 --- a/doc/source/controls-functions-center.txt +++ b/doc/source/controls-functions-center.txt @@ -3,16 +3,16 @@ At the center of the main window are a number of controls you will use when making QSOs: //.Misc Controls Center -image::images/misc-controls-center.png[align="left",alt="Misc Controls Center"] +image::images/misc-controls-center.png[align="center",alt="Misc Controls Center"] * Select *Tx even* to transmit in even-numbered UTC minutes. Uncheck this box to transmit in the odd intervals. This selection is made automatically when you double-click on a decoded text line as -described in the Basic Operating Tutorial, Sections 5.1 thru 5.8. +described in the Basic Operating Tutorial. -* Your audio Tx and Rx frequencies are displayed and can be adjusted -with spinner controls. These settings are usually handled -automatically by the double-click procedure. +* Your audio Tx and Rx frequencies can be adjusted with spinner +controls. These settings are usually handled automatically by the +double-click procedure. * The on-the-air frequency of your lowest JT9 or JT65 tone is the sum of dial and audio frequencies. You can force Tx frequency to the @@ -22,7 +22,7 @@ always track one another. * The *Report* control lets you change a signal report that has been inserted automatically. Most reports will fall in the range –26 to -\+10 dB. Remember that JT65 reports cannot be greater than -1 dB. ++10 dB. Remember that JT65 reports cannot be greater than -1 dB. IMPORTANT: When signals are close to or above 0 dB, you and your QSO partner should probably reduce power. JT65 and JT9 are supposed to be diff --git a/doc/source/controls-functions-left.txt b/doc/source/controls-functions-left.txt index a5e22ef07..9506e9a42 100644 --- a/doc/source/controls-functions-left.txt +++ b/doc/source/controls-functions-left.txt @@ -1,23 +1,24 @@ // Status=review -Controls related to: *date*, *time*, *frequency*, *Rx Audio Level*, -and the *Station Being Worked* are found at lower left of the main -window: +Controls related to band and frequency selection, receiver audio +level, the station being worked, and date and time are found at lower +left of the main window: //.Misc Controls Left image::images/misc-main-ui.png[align="center",alt="Mist Menu Items"] -* The drop-down *Band* selector at upper left lets you select the +* The drop-down band selector at upper left lets you select the operating band and sets dial frequency to a default value taken from the *Default Frequencies* tab on the *Setup | Configuration* screen. * If you are using CAT control, a small colored square appears in -green if the CAT control is two-way between {wsjtx} and your radio, or -orange if the control is only from program to radio. You can request +green if the CAT control is two-way between _WSJT-X_ and your radio, or +orange if the control is only from program to radio. (You can request a one-time interrogation of the radio’s dial frequency by clicking on -the orange square. The square becomes red if you have requested CAT -control but communication with the radio has been lost. If the -*Dx Grid* is known, the great-circle azimuth and distance are given. +the orange square.) The square becomes red if you have requested CAT +control but communication with the radio has been lost. If the +locator *Dx Grid* is known, the great-circle azimuth and distance are +displayed. * The program can keep a database of call-signs and locators for future reference. Click *Add* to insert the present call and locator in diff --git a/doc/source/controls-functions-main-window.txt b/doc/source/controls-functions-main-window.txt index 7429beefc..5db05a11b 100644 --- a/doc/source/controls-functions-main-window.txt +++ b/doc/source/controls-functions-main-window.txt @@ -7,9 +7,9 @@ image::images/main-ui-controls.png[align="left",alt="Main UI Controls"] * *Log QSO* pops up a confirmation screen pre-filled with known information about a QSO you have nearly completed. You can edit or -add to this information before clicking OK to log the QSO. If you -select ``Prompt me to log QSO'' on the Setup menu, the program will -pop up the confirmation screen automatically when you send a ``73'' or +add to this information before clicking *OK* to log the QSO. If you +check *Prompt me to log QSO* on the *Setup* menu, the program will pop +up the confirmation screen automatically when you send a 73 or free-text message. //.Log QSO Window @@ -21,24 +21,25 @@ and explore previously recorded audio files. * *Monitor* restarts normal receive operation. This button is highlighted in green when the program is receiving. +* *Erase* clears the right (*Rx frequency*) window. Double-clicking +*Erase* clears both text windows. + * *Decode* tells the program to repeat the decoding procedure at the Rx frequency (green marker on waterfall), using the most recently -completed sequence of Rx data. - -* *Erase* clears the right (Rx frequency) window. Double-clicking -Erase clears both text windows. - -* *Tune* may be used to switch into Tx mode and generate an -unmodulated carrier at the specified Tx frequency (red marker on -waterfall). This process may be seful for adjusting an antenna tuner, -for example, toggle the button a second time to terminate the Tune -process. +completed sequence of Rx data. * *Enable Tx* puts the program into automatic Rx/Tx 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. +appropriate. A transmission will not be started any later than 24 s +into a UTC minute. * *Halt Tx* terminates a transmission in progress and disables automatic Rx/Tx sequencing. +* *Tune* may be used to switch into Tx mode and generate an +unmodulated carrier at the specified Tx frequency (red marker on +waterfall). This process may be useful for adjusting an antenna +tuner. Toggle the button a second time to terminate the *Tune* +process. + diff --git a/doc/source/controls-functions-messages.txt b/doc/source/controls-functions-messages.txt index 9a376ec69..129ac8d65 100644 --- a/doc/source/controls-functions-messages.txt +++ b/doc/source/controls-functions-messages.txt @@ -1,12 +1,11 @@ // Status=review -Two configurations of controls are provided for generating and -selecting Tx messages. -Traditional controls (carried over from program WSJT) appear on *Tab -1* and provide six fields for message entry. Pre-formatted messages -for the standard minimal QSO are generated when you click *Generate -Std Msgs* or when you double-click on an appropriate line of decoded -text. +Two arrangements of controls are provided for generating and selecting +Tx messages. Traditional controls carried over from program _WSJT_ +appear on *Tab 1* and provide six fields for message entry. +Pre-formatted messages for the standard minimal QSO are generated when +you click *Generate Std Msgs* or when you double-click on an +appropriate line in one of the decoded text windows. //.Traditional Message Menu image::images/traditional-msg-box.png[align="center",alt="Traditional Message Menu"] @@ -15,22 +14,22 @@ image::images/traditional-msg-box.png[align="center",alt="Traditional Message Me Tx sequence) by clicking on the circle under *Next*. * To change to a specified Tx message immediately, click on a -rectangular button (e.g., Tx 3) under the *Now* label. Changing Tx -messages after a transmission has started reduces the chance of a -correct decode, but in the first 10 s of a Tx period it will probably -succeed. +rectangular button under the *Now* label. Changing a Tx message +already underway reduces the chance of a correct decode, but will +probably succeed if done in the first 10 s of a Tx period. * Right-clicking on the entry field for message #5 pops up a list of free-text messages entered on the *Setup | Configuration | Tx Macros* -dialog window. You can select any of these pre-stored messages with -the left mouse button. +tab. You can select any of these pre-stored messages by using the +left mouse button. -*Tab 2* of the Message Control Panel looks like this: +The second arrangement of controls for generating and selecting +Tx messages appears on *Tab 2* of the Message Control Panel: //.New Message Menu image::images/new-msg-box.png[align="center",alt="New Message Menu"] -With this setup you will normally follow a top-to-bottom sequence of +With this setup you normally follow a top-to-bottom sequence of transmissions from the left column if you are calling CQ, or the right column if you are answering a CQ. Clicking a button puts the appropriate message in the *Gen Msg* box. If you are already @@ -38,8 +37,6 @@ transmitting, it changes the Tx message immediately. You can enter anything (up to 13 characters) in the *Free Msg* box. Right-clicking on this entry field pops up your previously defined list of *Tx Macros*. -IMPORTANT: WIth either of the message-control tabs, the actual message -being transmitted always appears highlighted in yellow in the first -box of the status bar, at bottom left of the main screen. - - +IMPORTANT: During a transmission the actual message being sent always +appears highlighted in yellow in the first box of the status bar +(bottom left of the main screen). diff --git a/doc/source/controls-functions-wide-graph.txt b/doc/source/controls-functions-wide-graph.txt index 262e0bdf0..da1037d6b 100644 --- a/doc/source/controls-functions-wide-graph.txt +++ b/doc/source/controls-functions-wide-graph.txt @@ -1,32 +1,41 @@ // Status=review -The following controls appear at the bottom of the Wide Graph window: -image::images/wide-graph-controls.png[align="left",alt="Wide Graph Controls"] +The following controls appear at the bottom of the Wide Graph window. +With the exception of *JT65 nnnn JT9*, they affect only the graphical +displays — they have no effect on the decoding process. -* *FFT Bins/Pixel* controls the displayed frequency resolution. Set +image::images/wide-graph-controls.png[align="center",alt="Wide Graph Controls"] + +- *Bins/Pixel* controls the displayed frequency resolution. Set to 1 for the highest possible resolution, or to higher values to compress the spectral display. Normal operation with a convenient window size works well at 2 to 8 bins per pixel. -* *N Avg* is the number of successive FFTs to be averaged before +- *JT65 nnnn JT9* sets the dividing point for wide-band decoding of +JT65 and JT9 signals in JT9+JT65 mode. The decoder looks for JT65 +signals below nnnn Hz and JT9 signals above that frequency. + +- *Start nnn Hz* sets the low-frequency starting point of the +waterfall frequency scale. + +- *N Avg* is the number of successive FFTs to be averaged before updating the spectral display. Values around 5 are suitable for normal JT9 and JT65 operation. -* *Gain* and *Zero* control the scaling and reference level for +- *Zero* and *Gain* control the scaling and reference level for waterfall colors. Values around 0 for both parameters are usually about right, depending on the input signal level and your own preferences. -* *JT65 nnnn JT9* sets the dividing point for wide-band decoding of -JT65 and JT9 signals in JT9+JT65 mode. The decoder looks for JT65 -signals below nnnn Hz and JT9 signals above that frequency. +- *Palette* lets you select from a number of waterfall color palettes. -* *Current / Cumulative* controls the graphical display in the bottom -one-third of the Wide Graph window. ** Current is the average -spectrum over the most recent N Avg FFT calculations. ** Cumulative -is the average spectrum since the start of the current Rx sequence. +- Check the *Flatten* box to have _WSJT-X_ compensate for uneven +spectral response across the received passband. + +- You can select *Current* or *Cumulative* for the spectrum displayed +in the bottom one-third of the Wide Graph window. *Current* is the +average spectrum over the most recent *N Avg* FFT calculations. +*Cumulative* is the average spectrum since the start of the current +minute. -* With the exception of *JT65 nnnn JT9*, controls on the Wide Graph -window affect only the graphical displays — they have no effect -on the decoding process. diff --git a/doc/source/font-sizes.txt b/doc/source/font-sizes.txt index 02eb0ce92..90b01ed15 100644 --- a/doc/source/font-sizes.txt +++ b/doc/source/font-sizes.txt @@ -1,11 +1,13 @@ // Status=review -- User control of font sizes can be effected by using a text editor -(Windows Notepad or similar) to create a one-line file named fonts.txt -in the wsjtx directory. A single line of text should contain four -numbers separated by spaces. The first two control the font size (in -points) and weight (on a 0 – 100 scale) of most GUI labels. The last -two numbers control size and weight of text in the Band Activity and -Rx Frequency windows. + +- You can control the program's font sizes by using a text editor +(e.g., Windows Notepad or similar) to create a one-line file named ++fonts.txt+ in the _WSJT-X_ installation directory. Enter a single +line of text with four numbers separated by spaces. The first two +numbers control the font size (in points) and weight (on a 0 – 100 +scale) of most labels on the user interface. The last two numbers +control size and weight of text in the *Band Activity* and *Rx +Frequency* windows. - The default is ``8 50 10 50''. If you need larger fonts and bold text in the decode windows, try ``10 50 12 100'' (without the quotes). diff --git a/doc/source/install-from-source.txt b/doc/source/install-from-source.txt index deb27c2b6..d5cd815ef 100644 --- a/doc/source/install-from-source.txt +++ b/doc/source/install-from-source.txt @@ -3,8 +3,8 @@ // to a very old src version of WSJT 5.7 or so. WSJTX is not listed at all. // Also, all the Qt4 stuff is now obsolete, and needs to be updated. -{wsjtx} is an open-source program released under the GNU General -Public License. Source code is available from the public repository +_WSJT-X_ is an open-source program released under the GNU General +Public License (GPL). Source code is available from the public repository at {devsvn}. To compile the program you will need to install the following packages: @@ -14,9 +14,10 @@ following packages: - gfortran or g95 - fftw3 - hamlib -- MinGW (Windows only) +- MinGW (for Windows only) -The full source code for {wsjtx} can be downloaded with the command: +With Subversion installed, the full source code for _WSJT-X_ can be +downloaded with the command: $ svn co svn://svn.berlios.de/wsjt/branches/wsjtx diff --git a/doc/source/install-mac.txt b/doc/source/install-mac.txt index c3222c46c..657caedbf 100644 --- a/doc/source/install-mac.txt +++ b/doc/source/install-mac.txt @@ -1,6 +1,14 @@ // Status=review -- Read the OS X installation instructions {osx-instructions}. -- Download the required installation package +Separate compiled versions of _WSJT-X_ are available for OS X 10.6 +through 10.8, and OS X 10.9. The two versions are not interchangeable. + +- Select the correct package for your OS X and download it to your desktop. + +- Double-click on the file to see a new folder, +WSJT-X+. Drop down +into that folder, where the +Readme+ file provides detailed instructions +on how to configure your system for _WSJT-X_. + +- Some additional information can be found {osx-instructions}. * {osx-108} -* {osx-109} +* {osx-109} diff --git a/doc/source/install-ubuntu.txt b/doc/source/install-ubuntu.txt index b12000478..e917f4cc8 100644 --- a/doc/source/install-ubuntu.txt +++ b/doc/source/install-ubuntu.txt @@ -1,6 +1,6 @@ // Status=review - Installation packages for Ubuntu 12.04, 12.10, 13.04, 13.10 are -available at {launchpadurl} +available at {launchpadurl}. - If you have not before obtained packages from the Personal Package Archive (PPA) at the above link, execute the following instruction at @@ -8,12 +8,12 @@ the command prompt: $ sudo add-apt-repository ppa:jnogatch/wsjtx -- Accept the PPA Key, then: +- Accept the PPA Key, then issue these commands: $ sudo apt-get update $ sudo apt-get install wsjtx -- Download the soft-decision Reed Solomon decoder {kvasd} and put it -in the same directory as the executable binaries wsjtx and -jt9. Normally (fter you have run the script /usr/bin/wsjtx at least -once) this directory will be $HOME/.wsjtx. +- Download the soft-decision Reed Solomon decoder, {kvasd}, and put it +in the same directory as the executable binaries +wsjtx+ and ++jt9+. Normally (after you have run the script +/usr/bin/wsjtx+ at +least once) this directory will be +$HOME/.wsjtx+. diff --git a/doc/source/install-windows.txt b/doc/source/install-windows.txt index c0096c92a..13e7011ca 100644 --- a/doc/source/install-windows.txt +++ b/doc/source/install-windows.txt @@ -2,12 +2,13 @@ - Execute the downloaded file and follow its installation instructions. -- Install {wsjtx} into its own directory rather than the conventional -C:\Program Files\WSJTX. The suggested default directory is C:\WSJTX. +- Install _WSJT-X_ into its own directory rather than the conventional +location +C:\Program Files\WSJTX+. The suggested default directory is ++C:\WSJTX+. -- All files relating to {wsjtx} will be stored in your chosen +- All files relating to _WSJT-X_ will be stored in your chosen installation directory and its subdirectories. You can uninstall -{wsjtx} by removing the installation directory and its contents. +_WSJT-X_ by removing the installation directory and its contents. - The built-in Windows facility for time synchronization is usually not adequate. We recommend Meinberg NTP: see {ntpsetup} for diff --git a/doc/source/installed-files.txt b/doc/source/installed-files.txt index 78d529739..bcaa164b5 100644 --- a/doc/source/installed-files.txt +++ b/doc/source/installed-files.txt @@ -1,5 +1,5 @@ // Status=review -After installing {wsjtx} as described in <>, the +After installing _WSJT-X_ as described in <>, the following files will be present in the installation directory: .Files Present After Installation @@ -42,8 +42,8 @@ following files will be present in the installation directory: |save|Directory for saved .wav files |shortcuts.txt|Keyboard shortcuts |unins000.dat|Uninstall Data File -|unins000.exe|Executable for uninstalling {wsjtx} +|unins000.exe|Executable for uninstalling _WSJT-X_ |wsjt.ico|WSJT icon -|wsjtx.exe|Executable for {wsjtx} +|wsjtx.exe|Executable for _WSJT-X_ |======== diff --git a/doc/source/introduction.txt b/doc/source/introduction.txt index 796bf24e7..3b8e05fbe 100644 --- a/doc/source/introduction.txt +++ b/doc/source/introduction.txt @@ -1,11 +1,11 @@ // Status=review -{wsjtx} is a computer program designed to facilitate basic amateur +_WSJT-X_ is a computer program designed to facilitate basic amateur radio communication using very weak signals. The first four letters in the program name stand for “Weak Signal communication by K1JT”, and -the “-X” suffix indicates that {wsjtx} started as an extended (and -experimental) branch of program WSJT. +the “-X” suffix indicates that _WSJT-X_ started as an extended (and +experimental) branch of program _WSJT_. -{wsjtx} offers two protocols or “modes,” JT9 and JT65. Both are +_WSJT-X_ offers two protocols or “modes,” JT65 and JT9. Both are designed for making reliable, confirmed QSOs under extreme weak-signal conditions. They use nearly identical message structure and source encoding. JT65 was designed for EME (“moon-bounce”) on the VHF/UHF @@ -18,17 +18,17 @@ six minutes — two or three transmissions by each station, one sending in odd UTC minutes and the other even. World-wide QSOs are possible with power levels of a few watts and compromise antennas. -Starting with version 1.1, {wsjtx} can display a bandpass as large as -5 kHz and provide dual-mode reception of both JT65 and JT9 signals. -If your receiver can be configured with at least 4 kHz bandwidth in -USB mode, you can set your dial frequency to one of the standard JT65 -frequencies — for example, 14.076 MHz for 20 meters — and have the -full JT65 and JT9 sub-bands displayed simultaneously on the waterfall. -You can make QSOs in both modes using nothing more than mouse clicks. +_WSJT-X_ can display a bandpass as large as 5 kHz and transparently +provides dual-mode reception of both JT65 and JT9 signals. If your +receiver can be configured with at least 4 kHz bandwidth in USB mode, +you can set the dial frequency to one of the standard JT65 frequencies +— for example, 14.076 MHz for the 20-meter band — and have the full +JT65 and JT9 sub-bands displayed simultaneously on the waterfall. You +can then make QSOs in both modes using nothing more than mouse clicks. -Plans for future program development call for {wsjtx} and WSJT to -merge together: {wsjtx} will gradually acquire the additional modes -JT4, FSK441, and ISCAT that are now supported in WSJT. The entire +Plans for future program development call for _WSJT-X_ and _WSJT_ to +merge together: _WSJT-X_ will gradually acquire the additional modes +JT4, FSK441, and ISCAT that are now supported in _WSJT_. The entire WSJT-related effort is an open-source project. If you have programming or documentation skills or would like to contribute to the project in other ways, please make your interests known to the diff --git a/doc/source/jt65-jt9-differences.txt b/doc/source/jt65-jt9-differences.txt index a19867429..9e9cf7970 100644 --- a/doc/source/jt65-jt9-differences.txt +++ b/doc/source/jt65-jt9-differences.txt @@ -9,21 +9,22 @@ modes are essentially the same length, and both modes use exactly 72 bits to carry message information. At the user level the two modes support nearly identical message structures. -JT65 signal reports are constrained to the range –1 to –30 dB — more -than adequate for EME purposes, but not enough dynamic range for ideal -use at HF and below. S/N values displayed by the JT65 decoder are -clamped at an upper limit –1 dB, because that’s all the original -protocol can handle. Moreover, the S/N scale in present JT65 decoders -becomes increasingly nonlinear above –10 dB. By comparison, JT9 -allows for signal reports in the range –50 to +49 dB. It manages this -by co-opting a small portion of ``message space'' that would otherwise -be used for grid locators within 1 degree of the south pole. The S/N -scale of the present JT9 decoder is reasonably linear (although it’s -not intended as a precision measurement tool). With clean signals and -a clean nose background, JT65 achieves nearly 100% probability of -correct decoding down to S/N = –22 dB and 50% at –24 dB. JT9 is about -2 dB better, achieving 50% decoding at about –26 dB. Both modes -produce extremely low false-decode rates. +JT65 signal reports are constrained to the range –1 to –30 dB. This +range is more than adequate for EME purposes, but not enough for +optimum use at HF and below. S/N values displayed by the JT65 decoder +are clamped at an upper limit –1 dB. Moreover, the S/N scale in +present JT65 decoders is nonlinear above –10 dB. + +By comparison, JT9 allows for signal reports in the range –50 to +49 +dB. It manages this by taking over a small portion of ``message +space'' that would otherwise be used for grid locators within 1 degree +of the south pole. The S/N scale of the present JT9 decoder is +reasonably linear (although it’s not intended to be a precision +measurement tool). With clean signals and a clean nose background, +JT65 achieves nearly 100% probability of correct decoding down to +S/N = –22 dB and about 50% at –24 dB. JT9 is about 2 dB better, +achieving 50% decoding at about –26 dB. Both modes produce extremely +low false-decode rates. Early experience suggests that under most HF propagation conditions the two modes have comparable reliability. The tone spacing of JT9 is diff --git a/doc/source/jt9-protocol.txt b/doc/source/jt9-protocol.txt index 5cbfc96ff..89b067304 100644 --- a/doc/source/jt9-protocol.txt +++ b/doc/source/jt9-protocol.txt @@ -1,26 +1,25 @@ // Status=review //Needs work! -.JT9 Protocol and Implementation JT9 is a mode designed for making minimal QSOs at LF, MF, and HF. It -uses 72-bit structured messages that are nearly identical (at the user -level) to those in JT65. Error control coding (ECC) uses a strong +uses 72-bit structured messages nearly identical (at the user level) +to those in JT65. Error control coding (ECC) uses a strong convolutional code with constraint length K=32, rate r=1/2, and a zero tail, leading to an encoded message length of (72+31) × 2 = 206 information-carrying bits. Modulation is 9-FSK: eight tones are used -for data, one for synchronization. Sixteen symbol intervals are -devoted to synchronization, so a transmission requires a total of 206 -/ 3 + 16 = 85 (rounded up) channel symbols. The sync symbols are -those numbered 1, 2, 5, 10, 16, 23, 33, 35, 51, 52, 55, 60, 66, 73, -83, and 85 in the transmitted sequence. +for data, one for synchronization. Thus, three data bits or one +synchronization bit are conveyed by each transmitted symbol. Sixteen +symbol intervals are devoted to synchronization, so a transmission +requires a total of 206 / 3 + 16 = 85 (rounded up) channel +symbols. The sync symbols are those numbered 1, 2, 5, 10, 16, 23, 33, +35, 51, 52, 55, 60, 66, 73, 83, and 85 in the transmitted sequence. Each symbol lasts for 6912 sample intervals at 12000 samples per second, or about 0.576 s. Tone spacing of the 9-FSK modulation is 12000/6912 = 1.736 Hz, the inverse of the symbol duration. The total -occupied bandwidth is therefore 9 × 1.736 = 15.6 Hz. The generated -JT9 signal has continuous phase and constant amplitude. There are no -key clicks, and the transmitter's power amplifier need not be highly -linear. +occupied bandwidth is 9 × 1.736 = 15.6 Hz. A generated JT9 signal has +continuous phase and constant amplitude. There are no key clicks, and +the transmitter's power amplifier need not be highly linear. .Transmitting @@ -28,18 +27,18 @@ Immediately before the start of a transmission WSJT-X encodes a user’s message and computes the sequence of tones to be sent. The transmitted audio waveform is computed on-the-fly, using 16-bit integer samples at a 48000 Hz rate. The digital samples are converted -to an analog waveform in the sound card (or equivalent D/A interface). +to an analog waveform in the sound card or equivalent D/A interface. .Receiving and Decoding WSJT-X acquires 16-bit integer samples from the sound card at a 48000 -Hz rate, and immediately downsamples the data stream to 12000 Hz. -Spectra from overlapping data segments are computed for the waterfall -display and saved at intervals of 0.188 s, half the JT9 symbol length. -As shown in screen shots earlier in this guide, a JT9 signal appears -in the *Cumulative* spectrum as a nearly rectangular shape about 16 Hz -wide. Although there is no clearly visible “sync tone” like the one -at the low-frequency edge of a JT65 signal, by convention the nominal +Hz rate, and immediately downsamples the stream to 12000 Hz. Spectra +from overlapping segments are computed for the waterfall display and +saved at intervals of 0.188 s, half the JT9 symbol length. As shown +in screen shots earlier in this guide, a JT9 signal appears in the +*Cumulative* spectrum as a nearly rectangular shape about 16 Hz wide. +Although there is no clearly visible “sync tone” like the one at the +low-frequency edge of a JT65 signal, by convention the nominal frequency of a JT9 signal is taken to be that of the lowest tone, at the left edge of the spectrum. @@ -49,13 +48,12 @@ operator convenience the decoder goes through its full procedure twice: first at the selected Rx frequency, and then in the full displayed frequency range (or in JT9+JT65 mode, the displayed range above the blue *JT65 nnnn JT9* marker). Decoding of clean JT9 signals -in a white-noise background starts to fail around signal-to-noise +in a white-noise background starts to fail below signal-to-noise ratio –25 dB and reaches 50% copy at -26 dB. Each decoding pass can be described as a sequence of discrete blocks. -For those wishing to study the program’s algorithms and source code, -perhaps with an eye toward future improvements, the blocks are labeled -here with the names of functional procedures in the code. +The blocks are labeled here with the names of functional procedures in +the code. sync9: Use sync symbols to find candidate JT9 signals in the specified frequency range @@ -87,10 +85,10 @@ Then, at the frequency of each plausible candidate: compressed format With marginal or unrecognizable signals the sequential Fano algorithm -can take exponentially long times. If the first step in the above +can take exponentially long times. If the +sync9+ step in the above sequence finds many seemingly worthy candidate signals, and if many of -them turn out to be undecodable, the decoding loop could take a very -long time. For this reason the decode9 step is programmed to “time -out” and report failure if it takes too long. The choices *Fast | -Normal | Deepest* on the Decode menu provide a three-step adjustment -of this timeout limit. +them turn out to be undecodable, the decoding loop can take a very +long time. For this reason the step labeled +decode9+ is programmed +to “time out” and report failure if it is taking too long. The +choices *Fast | Normal | Deepest* on the Decode menu provide a +three-step adjustment of this timeout limit. diff --git a/doc/source/make-qso.txt b/doc/source/make-qso.txt index 38dc4af10..ceb17a1d2 100644 --- a/doc/source/make-qso.txt +++ b/doc/source/make-qso.txt @@ -2,26 +2,26 @@ === Standard Exchange By longstanding tradition, a minimal valid QSO requires the exchange of callsigns, a signal report or some other information, and -acknowledgments. {wsjtx} is designed to facilitate making such +acknowledgments. _WSJT-X_ is designed to facilitate making such minimal QSOs using short, formatted messages. The process works best if you use these formats and follow standard operating practices. The recommended basic QSO goes something like this: -[width="90%",cols="3,^3,^3,^4,10",options="header"] +[width="90%",cols="3,7,12",options="header"] |======================================= -|UTC|To|From|Grid/Rpt|Comment -|0001|CQ|K1ABC|FN42|~ K1ABC calls CQ -|0002|K1ABC|G0XYZ|IO91|~ G0XYZ answers -|0003|G0XYZ|K1ABC|–19|~ K1ABC sends report -|0004|K1ABC|G0XYZ|R–22|~ G0XYZ sends acknowledgment and report -|0005|G0XYZ|K1ABC|RRR|~ K1ABC sends acknowledgment -|0006|K1ABC|G0XYZ|73|~ G0XYZ sends 73 +|UTC|Transmitted Message|Comment +|0001|CQ K1ABC FN42|K1ABC calls CQ +|0002|K1ABC G0XYZ IO91|G0XYZ answers +|0003|G0XYZ K1ABC –19|K1ABC sends report +|0004|K1ABC G0XYZ R–22|G0XYZ sends acknowledgment and report +|0005|G0XYZ K1ABC RRR|K1ABC sends acknowledgment +|0006|K1ABC G0XYZ 73|G0XYZ sends 73 |======================================= *Standard messages* consist of two callsigns (or CQ, QRZ, or DE and one callsign) followed by the transmitting station’s grid locator, a signal report, acknowledgement R plus a signal report, or the final -acknowledgements “RRR” or “73”. Messages are compressed and encoded +acknowledgements RRR or 73. Messages are compressed and encoded in a highly efficient and reliable way. *Signal reports* are specified as signal-to-noise ratio (S/N) in dB, @@ -32,19 +32,19 @@ that his signal is 19 dB below the noise power in bandwidth 2500 Hz. In message #0004, G0XYZ acknowledges receipt of that report and responds with a –22 dB signal report. -TIP: For operators with very good hearing, signals become audible -around S/N = –15 dB and visible on the waterfall to –26 dB. The JT65 -decoder begins to fail around –24 dB, JT9 around –26 dB. +TIP: Signals become visible on the waterfall around S/N = –26 dB and +audible around –15 dB. Thresholds for signal decodability are +approximately –24 dB for JT65, –26 dB for JT9. *Free Text Messages*: Users often add some friendly chit-chat as a -final transmission, in place of the formatted ``73'' message. -Free-format messages such as ``TNX JOE 73 GL'' or `5W VERT 73 GL'' are -supported, up to a maximum of 13 characters (including spaces). It -should be obvious that JT9 and JT65 are not suitable for extensive -conversations or rag-chewing. +final transmission, in place of the formatted 73 message. Free-format +messages such as TNX JOE 73 GL or 5W VERT 73 GL are supported, up to a +maximum of 13 characters (including spaces). It should be obvious +that JT9 and JT65 are not suitable for extensive conversations or +rag-chewing. === Compound Callsigns -//This section needs work! Must describe and give examples for both +//This section needs work!! Must describe and give examples for both //JT65v1 and JT65v2 formats. Compound call-signs such as PJ4/K1ABC or G0XYZ/P are handled in a slightly different way. The following formats are all valid: @@ -68,7 +68,7 @@ different way. The following formats are all valid: - ``grid'' is a 4-character Maidenhead locator - A signal report of the form “±nn” or “R±nn”, or the acknowledgment -or sign-off messages “RRR” or “73”. {wsjtx} generates messages in +or sign-off messages “RRR” or “73”. _WSJT-X_ generates messages in these forms automatically, as required. - A QSO between two stations using compound call-signs might look like this: @@ -100,10 +100,10 @@ through the <> above and the following checklist: - Your callsign and grid locator set to correct values - PTT and CAT control (if used) properly configured and tested -- Computer clock properly synchronized with UTC to within ±1 s +- Computer clock properly synchronized to UTC within ±1 s - Radio set to USB (upper sideband) mode -- Radio's Split mode selected or not, consistent with your choice on -*Station* tab of *Configuration* window. +- Radio's Split mode selected or not, consistent with your choice +on *Station* tab of the *Setup | Configuration* window. -- Remember that JT9 and J65 generally do not require high power. Under -most propagation conditions, [red]*QRP is the rule!* +IMPORTANT: Remember that JT9 and J65 generally do not require high +power. Under most propagation conditions, [red]*QRP is the rule!* diff --git a/doc/source/system-requirments.txt b/doc/source/system-requirments.txt index 24eeee40c..ed29b033f 100644 --- a/doc/source/system-requirments.txt +++ b/doc/source/system-requirments.txt @@ -7,4 +7,4 @@ control, or VOX. - Audio input and output devices supported by your operating system - Audio or equivalent USB connections between transceiver and computer -- A means for synchronizing your computer clock to UTC to within ±1 s. +- A means for synchronizing your computer clock to UTC within ±1 s. diff --git a/doc/source/transceiver-setup.txt b/doc/source/transceiver-setup.txt index 9d47c294c..7e03ae473 100644 --- a/doc/source/transceiver-setup.txt +++ b/doc/source/transceiver-setup.txt @@ -1,36 +1,39 @@ // Status=review .Receiver Noise Level -- Click the Monitor button to return to normal receive operation. + +- Click the *Monitor* button to return to normal receive operation +(button should be highlighted in [green]*GREEN*). + - Set your transceiver to USB (or USB Data) mode. -- Use the receiver gain control(s) and/or the Windows mixer controls -to set the background noise level to around 30 dB or mid-scale. If -necessary you can also use the slider next to the scale, but note that -the overall dynamic range will be best with this slider not too far -from its mid-point. + +- Use the receiver gain controls and/or Windows mixer controls to set +the background noise level (scale at lower left of main window) to +around 30 dB with no signals present. If necessary you can also use +the slider next to the scale, but note that the overall dynamic range +will be best with this slider not too far from its mid-point. .Bandwidth and Frequency Setting Taking full advantage of the wide-band, dual-mode capability of -{wsjtx} requires a receiver bandwidth of at least 4 kHz. For example, -on a Kenwood TS-2000 I set *Low Cut* to 200 and *High Cut* to 5000 -Hz. Note that most SSB transceivers have a fixed Tx filter that will -not pass audio frequencies higher than about 2700 Hz. {wsjtx} takes -care of this by using Split mode, receiving with *VFO A* and -transmitting with *VFO B*. The Tx dial frequency (*VFO B*) is offset -in 500 Hz steps, and the generated audio frequency is adjusted so that +_WSJT-X_ requires a receiver bandwidth of at least 4 kHz. Many SSB +transceivers have a fixed-width Tx filter that will not pass audio +frequencies higher than about 2700 Hz. _WSJT-X_ takes care of this by +using Split mode, receiving with *VFO A* and transmitting with *VFO +B*. Under CAT control _WSJT-X_ offsets the Tx dial frequency (*VFO +B*) in 500 Hz steps, adjusting the generated audio frequency so that it always falls in the range 1500 – 2000 Hz. With *CAT* and *Split Tx* -enabled on the configuration screen and your transceiver set to -*Tx Split* mode, frequency control will be handled automatically. +enabled on the configuration screen and your transceiver set to *Tx +Split* mode, this frequency control will be handled automatically. If your transceiver has only a standard SSB filter you won’t be able to use more than about 2.7 kHz bandwidth. You can still have all of -the JT9 sub-band and part of the JT65 sub-band available, however. On -20m, say, set dial frequency (*VFO A*) to 14.0774 and the *JT9 nnnn JT65* -dividing line at 1600 Hz. JT9 signals in their conventional sub-band -will then appear at 1600 – 2600 Hz, while JT65 signals will be below -1000 Hz. Of course, you might prefer to concentrate on one mode at a -time, setting your dial frequency to (say) 14.076 for JT65 and 14.078 -for JT9. Present conventions have the nominal JT9 dial frequency 2 -kHz higher than the JT65 dial frequency, and the check-box labeled +2 -kHz, just below the band selector, makes the appropriate settings -easy. +the JT9 sub-band and part of the JT65 sub-band available on screen, +however. On 20m, say, set dial frequency (*VFO A*) to 14.0774 and the +*JT9 nnnn JT65* dividing line at 1600 Hz. JT9 signals in their +conventional sub-band will then appear at 1600 – 2600 Hz, while JT65 +signals will be below 1000 Hz. Of course, you might prefer to +concentrate on one mode at a time, setting your dial frequency to +(say) 14.076 for JT65 and 14.078 for JT9. Present conventions have +the nominal JT9 dial frequency 2 kHz higher than the JT65 dial +frequency, and the checkbox labeled *+2 kHz*, just below the *Band* +selector, makes the appropriate settings easy. diff --git a/doc/source/tutorial-example1.txt b/doc/source/tutorial-example1.txt index de5f97e86..0e99c7c2e 100644 --- a/doc/source/tutorial-example1.txt +++ b/doc/source/tutorial-example1.txt @@ -1,11 +1,10 @@ // Status=review .Open a Wave File: -- Select File | Open and navigate to ...\save\samples\130418_1742.wav -under your program installation directory. - -When the file opens you should see something similar to the to the -following screen shot: +- Select *File | Open* and navigate to ++...\save\samples\130418_1742.wav+ under your _WSJT-X_ installation +directory. When the file opens you should see something similar to +the to the following screen shot: [[X12]] image::images/r3556-main-ui-80.png[align="center",alt="Main UI and Wide Graph"] @@ -16,47 +15,53 @@ Notice the [green]*GREEN* and [red]*RED* markers on the waterfall frequency scale. Decoding takes place at the end of a receive sequence and is organized in two stages. The first decodes take place at the selected Rx frequency, indicated by the green marker. Results -appear in both the left (“Band Activity”) and right (“Rx Frequency”) -text windows on the main screen. The decoder then finds and decodes -all signals in the selected mode(s) and the displayed frequency +appear in both the left (*Band Activity*) and right (*Rx Frequency*) +text windows on the main screen. The program then finds and decodes +all signals in the selected mode or modes over the displayed frequency range. The red marker indicates your Tx frequency. At least eight JT9 signals are present in the example file; all but one of them are decodable. When this file was recorded KF4RWA was finishing a QSO with K1JT. Since the green marker was placed at his audio frequency, 1224 Hz, his message “K1JT KF4RWA 73” appears in both -decoded text windows. The “Band Activity” window shows this message +decoded text windows. The *Band Activity* window shows this message as well as all the other decodes at nearby frequencies. The CQ lines -are highlighted in [green]*GREEN*, and lines containing “My Call”, in +are highlighted in [green]*GREEN*, and lines containing *My Call*, in this case K1JT, are highlighted in [red]*RED*. TIP: For this step and the next, you may want to pretend you are K1JT by -entering that call temporarily as “My Call” on the <>. Your results should then be identical to those shown in the <> above. [[X13]] .Decoding Controls -To gain some feeling for the controls you will use when making QSOs, try -clicking with the mouse on the decoded text lines and on the waterfall spectral -display. You should be able to confirm the following behavior: -- Double-click on either of the decoded lines highlighted in green. This action -should produce the following: +To gain some feeling for the controls used when making QSOs, try +clicking with the mouse on the decoded text lines and on the waterfall +spectral display. You should be able to confirm the following +behavior: -** Copies call-sign and locater of a station calling CQ to the “DX Call” -and “DX grid” entry fields. +- Double-click on either of the decoded lines highlighted in +green. This action should produce the following: -** Generates suitable messages for a minimal QSO and checks or clears the Tx -even box so that you will transmit in the proper (odd or even) minutes. +** Callsign and locator of a station calling CQ are copied to the *DX +Call* and *DX Grid* entry fields. -** Rx and Tx frequency markers will be moved to the CQ-ing station’s frequency, -and the Gen Msg (“generated message”) radio button at bottom right of the main -window will be selected. +** Messages for a minimal QSO are generated. -** If you had checked “Double-click on call sets Tx Enable” on the Setup menu, -Enable Tx would also be activated, and you would start to transmit automatically, -at the appropriate time. +** The *Tx even* box is checked or cleared appropriately, so that you +will transmit in the proper (odd or even) minutes. + +** The Rx and Tx frequency markers are moved to the CQ station’s +frequency. + +** The *Gen Msg* (“generated message”) radio button at bottom right +of the main window is selected. + +** If you have checked *Double-click on call sets Tx Enable* on the +*Setup* menu, *Enable Tx* is activated and a transmission starts +automatically at the appropriate time. - Double-click on the decoded line with the message “K1JT N5KDV EM41”, highlighted in [red]*RED*. Results will be similar to those in the @@ -75,15 +80,17 @@ want to send 73 to him, so the message “KF4RWA K1JT 73” is automatically generated and selected for your next transmission. (Alternatively, you might choose to send a free text message or to call CQ again.) -- Clicking on the waterfall moves the Rx frequency ([green]*GREEN* marker) to the -selected frequency. +- Click on the waterfall to set Rx frequency ([green]*GREEN* marker). -- Ctrl-click on waterfall moves both Rx and Tx frequencies. +- Ctrl-click on waterfall to set both Rx and Tx frequencies. -- Double-click on the waterfall moves the Rx frequency and causes a -narrow-band decode there at the new QSO frequency. Decoded text appears in the -right window only. Ctrl-double-click moves both Rx and Tx frequencies and -decodes at the new frequency. +- Double-click on the waterfall to set Rx frequency and start a +narrow-band decode there. Decoded text appears in the right window +only. -- Clicking Erase clears the right window. Double-click on Erase to clear both -text windows. +- Ctrl-double-click sets both Rx and Tx frequencies and decodes at the +new frequency. + +- Click *Erase* to clear the right window. + +- Double-click *Erase* to clear both text windows. diff --git a/doc/source/tutorial-example2.txt b/doc/source/tutorial-example2.txt index d890becc7..724bf7280 100644 --- a/doc/source/tutorial-example2.txt +++ b/doc/source/tutorial-example2.txt @@ -1,20 +1,20 @@ // Status=review .Wide Graph Settings: -- Bins/Pixel = 7 -- Zero = -3 -- If necessary, adjust the width of the Wide Graph Window so that its upper -frequency limit is 4000 Hz. +- *Bins/Pixel* = 7 +- *Zero* = -3 +- Adjust the width of the Wide Graph window so that its upper +frequency limit is approximately 4000 Hz. .Main Window: -- Select JT9+JT65 on the Mode menu -- Toggle the Tx mode button to read Tx JT65, and set the Tx and Rx +- Select *JT9+JT65* on the *Mode* menu +- Toggle the *Tx mode* button to read *Tx JT65*, and set the Tx and Rx frequencies to 1718 Hz. -- Double-click on Erase to clear both text windows +- Double-click on *Erase* to clear both text windows. .Open a Wave File: -- Select File | Open and navigate to ...\save\samples\130610_2343.wav. -The waterfall should look like the figure below. +- Select *File | Open* and navigate to +...\save\samples\130610_2343.wav+. +The waterfall should look like the following figure: //.130610_2343.wav Decode [[X14]] @@ -22,23 +22,23 @@ image::images/130610_2343-wav-80.png[align="left",alt="Wide Graph Decode 130610_ This sample file contains 17 decodable signals — nine in JT65 mode (flagged with the character # in the decoded text windows), and eight -in JT9 mode (flagged with @). Since the Tx mode was set to Tx JT65, -signals in that mode were decoded first. If you had selected Tx JT9, +in JT9 mode (flagged with @). Since the Tx mode was set to *Tx JT65*, +signals in that mode were decoded first. If you had selected *Tx JT9*, JT9 signals would have been decoded first. TIP: Notice the [blue]*BLUE* marker on the waterfall scale, by default set at 2500 Hz. Its position is set by the spinner control -JT65 nnnn JT9, where nnnn is a frequency in Hz. In JT9+JT65 mode the +*JT65 nnnn JT9*, where nnnn is a frequency in Hz. In *JT9+JT65* mode the program will decode JT65 signals below this frequency and JT9 signals above it. - Confirm that mouse-click behavior is similar to that described -<>. The program automatically determines the mode of each +<>. The program automatically determines the mode of each JT9 or JT65 signal. - Double-click on the waterfall near 815 Hz: a JT65 message -originating from W7VP will be decoded and appear in the Rx Frequency -Box: +originating from W7VP will be decoded and appear in the *Rx Frequency* +window. [width="70%",cols="3,^3,^3,^4,^4,30",options="header"] |================================= @@ -60,28 +60,27 @@ automatically switches to that of the decoded signal and the Rx and Tx frequency markers on the waterfall scale resize themselves accordingly. -- Scroll back in the Band Activity window and double-click on the +- Scroll back in the *Band Activity* window and double-click on the message CQ DL7ACA JO40. The program will set Tx mode to JT65 and Tx and Rx frequencies to that of DL7ACA, 975 Hz. If you had checked -*Double-click on call sets Tx Enable* on the Setup menu, the program +*Double-click on call sets Tx Enable* on the *Setup* menu, the program would configure itself to start a QSO with DL7ACA. - Double-click on the decoded JT65 message CQ TA4A KM37. The program will set Tx mode to JT9 and the Rx and Tx frequencies to 3567 Hz. The program is now configured properly for a JT9 QSO with TA4A. -IMPORTANT: Don’t forget to re-enter your own call-sign as “My Call”. +IMPORTANT: Don’t forget to re-enter your own call-sign as *My Call*. .Reopen the First Sample File: -- Select File | Open and navigate to ...\save\samples\130418_1742.wav. +- Select *File | Open* and navigate to +...\save\samples\130418_1742.wav+. These data were recorded with a much narrower Rx bandwidth, roughly 200 to 2600 Hz. If you have no Rx filter wider than about 2.7 kHz, you -will be using data like this. For best viewing of such data adjust -Bins/Pixel and the width of the Wide Graph so that only the active -part of the spectrum shows, say 0 to 2600 Hz. Re-open the example -file after any change of Bins/Pixel or Wide Graph width, to refresh -the waterfall. +will be using data like this. For best viewing, adjust *Bins/Pixel* +and the width of the Wide Graph so that only the active part of the +spectrum shows, say 0 to 2600 Hz. Re-open the example file after any +change of *Bins/Pixel* or Wide Graph width, to refresh the waterfall. The signals in this file are all JT9 signals. To decode them in JT9+JT65 mode you’ll need to move the JT65 nnnn JT9 delimiter down to diff --git a/doc/source/tutorial-main-window.txt b/doc/source/tutorial-main-window.txt index 708ffa1e8..78511d783 100644 --- a/doc/source/tutorial-main-window.txt +++ b/doc/source/tutorial-main-window.txt @@ -1,5 +1,5 @@ // Status=review - Click the *Stop* button on the main window to halt any data acquisition. -- Select JT9 from the *Mode* menu and Deepest from the *Decode* menu. +- Select JT9 from the *Mode* menu and *Deepest* from the *Decode* menu. - Set the audio Tx and Rx frequencies to 1224 Hz. //Maybe show small screen shots here? diff --git a/doc/source/tutorial-wide-graph-settings.txt b/doc/source/tutorial-wide-graph-settings.txt index 6709a3118..e1e2d51e7 100644 --- a/doc/source/tutorial-wide-graph-settings.txt +++ b/doc/source/tutorial-wide-graph-settings.txt @@ -1,10 +1,10 @@ // Status=review -* Bins/Pixel = 4 -* N Avg = 5 -* Gain = 0, -* Zero = –10 -* Flatten = checked -* Cumulative for data display. -* Select Tab 2 (below the Erase button on the main window) to +- *Bins/Pixel* = 4 +- *N Avg* = 5 +- *Gain* = 0, +- *Zero* = –10 +- *Flatten* = checked +- Select *Cumulative* for data display. +- Select *Tab 2* (below the *Erase* button on the main window) to choose the alternative set of controls for generating and selecting Tx messages. diff --git a/doc/source/wsjtx-main.txt b/doc/source/wsjtx-main.txt index 91cf4a88a..01f030850 100644 --- a/doc/source/wsjtx-main.txt +++ b/doc/source/wsjtx-main.txt @@ -11,8 +11,8 @@ // If the list of links gets too long, we can add a url-file that is pulled // in when and where needed with the following: // include:: for example: include::url-list.txt -:devsvn: http://developer.berlios.de/projects/wsjt/[Devel-SVN] -:devmail: mailto:wsjt-devel@lists.berlios.de[WSJT-Devel-List] +:devsvn: http://developer.berlios.de/projects/wsjt/[wsjt-svn] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] :download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ] :wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ] :homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ] @@ -46,8 +46,9 @@ include::system-requirments.txt[] [[X3]] == Installation -Download {wsjtx} from the {homepage}. Click on the {wsjtx} at the left -margin and then on the appropriate link(s) for your operating system. +- Download _WSJT-X_ from the {homepage}. +- Click on _WSJT-X_ at the left margin and then on the appropriate +link(s) for your operating system. === Windows include::install-windows.txt[] @@ -78,7 +79,7 @@ include::install-from-source.txt[] include::configuration-station.txt[] [[X42]] -=== TX Macros Tab +=== Tx Macros Tab include::configuration-txmacros.txt[] [[X43]] @@ -104,11 +105,11 @@ include::tutorial-main-window.txt[] include::tutorial-wide-graph-settings.txt[] [[X53]] -=== Ex 1: JT9 Signals +=== Sample File 1 include::tutorial-example1.txt[] [[X54]] -=== Ex 2: JT65 and JT9 Signals +=== Sample File 2 include::tutorial-example2.txt[] [[X55]]