w4kek
/
WSJT-X
mirror of https://github.com/saitohirga/WSJT-X.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

User Guide updates and new contributor acknowledgement

This commit is contained in:
Bill Somerville 2021-10-21 15:15:02 +01:00
parent 3de683c03b
commit 7c93215c50
No known key found for this signature in database
GPG Key ID: D864B06D1E81618F
7 changed files with 90 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/common/links.adoc
View File

@ -94,8 +94,8 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes.
:sourceforge-jtsdk: https://sourceforge.net/projects/jtsdk[SourceForge JTSDK] :sourceforge-jtsdk: https://sourceforge.net/projects/jtsdk[SourceForge JTSDK]
:ubuntu_sdk: https://launchpad.net/~ubuntu-sdk-team/+archive/ppa[Ubuntu SDK Notice] :ubuntu_sdk: https://launchpad.net/~ubuntu-sdk-team/+archive/ppa[Ubuntu SDK Notice]
:win_openssl_packages: https://slproweb.com/products/Win32OpenSSL.html[Windows OpenSSL Packages] :win_openssl_packages: https://slproweb.com/products/Win32OpenSSL.html[Windows OpenSSL Packages]
:win32_openssl: https://slproweb.com/download/Win32OpenSSL_Light-1_1_1k.msi[Win32 OpenSSL Light Package] :win32_openssl: https://slproweb.com/download/Win32OpenSSL_Light-1_1_1L.msi[Win32 OpenSSL Light Package]
:win64_openssl: https://slproweb.com/download/Win64OpenSSL_Light-1_1_1k.msi[Win64 OpenSSL Light Package] :win64_openssl: https://slproweb.com/download/Win64OpenSSL_Light-1_1_1L.msi[Win64 OpenSSL Light Package]
:writelog: https://writelog.com/[Writelog] :writelog: https://writelog.com/[Writelog]
:wsjtx_group: https://groups.io/g/WSJTX[WSJTX Group] :wsjtx_group: https://groups.io/g/WSJTX[WSJTX Group]
:wsjtx: https://physics.princeton.edu/pulsar/K1JT/wsjtx.html[WSJT-X] :wsjtx: https://physics.princeton.edu/pulsar/K1JT/wsjtx.html[WSJT-X]

6
doc/user_guide/en/acknowledgements.adoc
View File

@ -15,9 +15,9 @@ greatly aided the development of _WSJT_ and its sister programs. For
_WSJT-X_ in particular, we acknowledge contributions from *AC6SL, _WSJT-X_ in particular, we acknowledge contributions from *AC6SL,
AE4JY, DF2ET, DJ0OT, G3WDG, G4KLA, IW3RAB, K3WYC, KA1GT, KA6MAL, KA9Q, AE4JY, DF2ET, DJ0OT, G3WDG, G4KLA, IW3RAB, K3WYC, KA1GT, KA6MAL, KA9Q,
KB1ZMX, KD6EKQ, KI7MT, KK1D, ND0B, PY2SDR, VE1SKY, VK3ACF, VK4BDJ, KB1ZMX, KD6EKQ, KI7MT, KK1D, ND0B, PY2SDR, VE1SKY, VK3ACF, VK4BDJ,
VK7MO, W3DJS, W4TI, W4TV, and W9MDB*. Each of these amateurs has helped to VK7MO, W3DJS, W3SZ, W4TI, W4TV, and W9MDB*. Each of these amateurs
bring the program’s design, code, testing, and/or documentation to its has helped to bring the program’s design, code, testing, and/or
present state. documentation to its present state.
Most of the color palettes for the _WSJT-X_ 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* the excellent, well documented, open-source program _fldigi_, by *W1HKJ*

91
doc/user_guide/en/decoder_notes.adoc
View File

@ -28,16 +28,16 @@ hypothetically known information.
[[FT8_AP_INFO_TABLE]] [[FT8_AP_INFO_TABLE]]
.FST4, FT4, and FT8 AP information types .FST4, FT4, and FT8 AP information types
[width="35%",cols="h10,<m20",frame=topbot,options="header"] [width="35%",cols="1h,<10m",frame=topbot,options="header"]
|=============================================== |===
|aP | Message components |aP|Message components
|a1 | CQ &#160; &#160; ? &#160; &#160; ? |a1|CQ &#160; &#160; ? &#160; &#160; ?
|a2 | MyCall &#160; &#160; ? &#160; &#160; ? |a2|MyCall &#160; &#160; ? &#160; &#160; ?
|a3 | MyCall DxCall &#160; &#160; ? |a3|MyCall DxCall &#160; &#160; ?
|a4 | MyCall DxCall RRR |a4|MyCall DxCall RRR
|a5 | MyCall DxCall 73 |a5|MyCall DxCall 73
|a6 | MyCall DxCall RR73 |a6|MyCall DxCall RR73
|=============================================== |===
If a codeword is found that is judged to have high (but not If a codeword is found that is judged to have high (but not
overwhelmingly high) probability of being correct, a `?` character is overwhelmingly high) probability of being correct, a `?` character is
@ -53,8 +53,8 @@ is the same except that it omits the decoding attempts for AP types
[[FT8_AP_DECODING_TYPES_TABLE]] [[FT8_AP_DECODING_TYPES_TABLE]]
.FT4 and FT8 AP decoding types for each QSO state .FT4 and FT8 AP decoding types for each QSO state
[width="35%",cols="h10,<m20",frame=topbot,options="header"] [width="35%",cols="10h,<20m",frame=topbot,options="header"]
|=========================================== |===
|State |AP type |State |AP type
|CALLING STN | 2, 3 |CALLING STN | 2, 3
|REPORT | 2, 3 |REPORT | 2, 3
@ -62,15 +62,15 @@ is the same except that it omits the decoding attempts for AP types
|ROGERS | 3, 4, 5, 6 |ROGERS | 3, 4, 5, 6
|SIGNOFF | 3, 1, 2 |SIGNOFF | 3, 1, 2
|CALLING CQ | 1, 2 |CALLING CQ | 1, 2
|=========================================== |===
Decoding with _a priori_ information behaves slightly differently Decoding with _a priori_ information behaves slightly differently
in JT65. Some details are provided in Tables 3 and 4. in JT65. Some details are provided in Tables 3 and 4.
[[JT65_AP_INFO_TABLE]] [[JT65_AP_INFO_TABLE]]
.JT65 AP information types .JT65 AP information types
[width="35%",cols="h10,<m20",frame=topbot,options="header"] [width="35%",cols="1h,<10m",frame=topbot,options="header"]
|=============================================== |===
|aP | Message components |aP | Message components
|a1 | CQ &#160; &#160; ? &#160; &#160; ? |a1 | CQ &#160; &#160; ? &#160; &#160; ?
|a2 | MyCall &#160; &#160; ? &#160; &#160; ? |a2 | MyCall &#160; &#160; ? &#160; &#160; ?
@ -79,20 +79,20 @@ in JT65. Some details are provided in Tables 3 and 4.
|a5 | MyCall DxCall 73 |a5 | MyCall DxCall 73
|a6 | MyCall DxCall DxGrid |a6 | MyCall DxCall DxGrid
|a7 | CQ DxCall DxGrid |a7 | CQ DxCall DxGrid
|=============================================== |===
[[JT65_AP_DECODING_TYPES_TABLE]] [[JT65_AP_DECODING_TYPES_TABLE]]
.JT65 AP decoding types for each QSO state .JT65 AP decoding types for each QSO state
[width="35%",cols="h10,<m20",frame=topbot,options="header"] [width="35%",cols="10h,<20m",frame=topbot,options="header"]
|=========================================== |===
|State |AP type |State |AP type
|CALLING STN | 2, 3, 6, 7 |CALLING STN |2, 3, 6, 7
|REPORT | 2, 3 |REPORT |2, 3
|ROGER_REPORT | 3, 4, 5 |ROGER_REPORT |3, 4, 5
|ROGERS | 3, 4, 5 |ROGERS |3, 4, 5
|SIGNOFF | 2, 3, 4, 5 |SIGNOFF |2, 3, 4, 5
|CALLING CQ | 1, 2, 6 |CALLING CQ |1, 2, 6
|=========================================== |===
=== Decoded Lines === Decoded Lines
@ -109,18 +109,18 @@ summarized in the following Table:
[[DECODED_LINES_TABLE]] [[DECODED_LINES_TABLE]]
.Notations used on decoded text lines .Notations used on decoded text lines
[width="50%",cols="h,3*^",frame=topbot,options="header"] [width="50%",cols="h,3*^",frame=topbot,options="header"]
|=========================================== |===
|Mode |Mode character|Sync character|End of line information |Mode |Mode character|Sync character|End of line information
|FST4 | ` | | ? &#160; aP |FST4 | ` | | ? &#160; aP
|FT4 | + | | ? &#160; aP |FT4 | + | | ? &#160; aP
|FT8 | ~ | | ? &#160; aP |FT8 | ~ | | ? &#160; aP
|JT4 | $ | *, # | f, fN, dCN |JT4 | $ | *, # | f, fN, dCN
|JT9 | @ | | |JT9 | @ | |
|JT65 | # | | |JT65 | # | |
|JT65 VHF| # | *, # | f, fN, dCN |JT65 VHF| # | *, # | f, fN, dCN
|Q65 | : | | qP |Q65 | : | | qP
|MSK144 | & | | |MSK144 | & | |
|=========================================== |===
Sync character:: Sync character::
`*` - Normal sync + `*` - Normal sync +
`#` - Alternate sync `#` - Alternate sync
@ -136,12 +136,13 @@ End of line information::
[[Q65_AP_INFO_TABLE]] [[Q65_AP_INFO_TABLE]]
.Q65 end-of-line codes .Q65 end-of-line codes
[width="45%",cols="h10,<m20",frame=topbot,options="header"] [width="50%",cols="1h,<10m",frame=topbot,options="header"]
|=============================================== |===
| | Message components |qP|Message components
|q0 | ? &#160; &#160; ? &#160; &#160; ? |q0|? &#160; &#160; ? &#160; &#160; ?
|q1 | CQ &#160; &#160; ? &#160; &#160; ? |q1|CQ &#160; &#160; ? &#160; &#160; ?
|q2 | MyCall &#160; &#160; ? &#160; &#160; ? |q2|MyCall &#160; &#160; ? &#160; &#160; ?
|q3 | MyCall DxCall &#160; &#160; ? |q3|MyCall DxCall &#160; &#160; ?
|q4 | MyCall DxCall &#160; &#160; [<blank> \| RRR \| RR73 \| 73] |q4|MyCall DxCall &#160; &#160; [<blank> \| RRR \| RR73 \| 73]
|=============================================== |q5|MyCall DxCall &#160; &#160; ? &#160; &#160; &#160; &#160; (*Max Drift* = 50)
|===

8
doc/user_guide/en/intro_subsections.adoc
View File

@ -22,9 +22,11 @@ consequences.
=== User Interface in Other Languages === User Interface in Other Languages
The _WSJT-X_ user interface is now available in many languages. When The _WSJT-X_ user interface (UI) is now available in many languages.
a translated user interface is available for the computer's default When a translated UI is available for the computer's default System
System Language, it will appear automatically on program startup. Language, it will appear automatically on program startup. The UI
language may be overriden if desired by starting _WSJT-X_ with a
command line option.
=== How You Can Contribute === How You Can Contribute

10
doc/user_guide/en/new_features.adoc
View File

@ -1,7 +1,7 @@
[[NEW_FEATURES]] [[NEW_FEATURES]]
=== New in Version {VERSION} === New in Version {VERSION_MAJOR}.{VERSION_MINOR}
_WSJT-X 2.5.0_ introduces an enhanced Q65 decoder that measures and _WSJT-X 2.5_ introduces an enhanced Q65 decoder that measures and
compensates for linear frequency drifts of Q65 signals. Activate this compensates for linear frequency drifts of Q65 signals. Activate this
feature by setting a spinner control *Max Drift* on the _WSJT-X_ main feature by setting a spinner control *Max Drift* on the _WSJT-X_ main
window to a number greater than 0. We suggest a setting of 10 for window to a number greater than 0. We suggest a setting of 10 for
@ -9,9 +9,11 @@ submode Q65-60A, the recommended submode for EME on 50 and 144 MHz,
which will accommodate drift rates up to 20 Hz/minute. Similarly, we which will accommodate drift rates up to 20 Hz/minute. Similarly, we
suggest *Max Drift* = 40 for submode Q65-15C, used for for 10 GHz QSOs suggest *Max Drift* = 40 for submode Q65-15C, used for for 10 GHz QSOs
(up to 900 km) via aircraft scatter and drift rates up to about 20 (up to 900 km) via aircraft scatter and drift rates up to about 20
Hz/s. Hz/s. When *Max Drift* = 50 the decoder will use an enhanced algorithm
to compensate for larger aircraft scatter drift rates, successful
decodes with this algorithm are tagged with a `q5` indicator.
On the Windows platform only, _WSJT-X 2.5.0_ installations now include On the Windows platform only, _WSJT-X 2.5_ installations now include
an early version of _MAP65 3.0_. This program works together with an early version of _MAP65 3.0_. This program works together with
suitable hardware that converts RF to baseband. The hardware/software suitable hardware that converts RF to baseband. The hardware/software
combination implements a wideband, highly optimized receiver for the combination implements a wideband, highly optimized receiver for the

20
doc/user_guide/en/protocols.adoc
View File

@ -263,8 +263,8 @@ which the probability of decoding is 50% or higher.
[[SLOW_TAB]] [[SLOW_TAB]]
.Parameters of Slow Modes .Parameters of Slow Modes
[width="100%",cols="3h,^3,^2,^1,^2,^2,^2,^2,^2,^2",frame=topbot,options="header"] [width="100%",cols="3h,^3,^2,^1,6*^2",frame=topbot,options="header"]
|=============================================================================== |===
|Mode |FEC Type |(n,k) | Q|Modulation type|Keying rate (Baud)|Bandwidth (Hz) |Mode |FEC Type |(n,k) | Q|Modulation type|Keying rate (Baud)|Bandwidth (Hz)
|Sync Energy|Tx Duration (s)|S/N Threshold (dB) |Sync Energy|Tx Duration (s)|S/N Threshold (dB)
|FST4-15 |LDPC | (240,101)| 4| 4-GFSK| 16.67 | 66.7 | 0.25| 9.6 | -20.7 |FST4-15 |LDPC | (240,101)| 4| 4-GFSK| 16.67 | 66.7 | 0.25| 9.6 | -20.7
@ -289,7 +289,7 @@ which the probability of decoding is 50% or higher.
|FST4W-300 |LDPC | (240,74)| 4| 4-GFSK| 0.558 | 2.2 | 0.25| 286.7 | -36.8 |FST4W-300 |LDPC | (240,74)| 4| 4-GFSK| 0.558 | 2.2 | 0.25| 286.7 | -36.8
|FST4W-900 |LDPC | (240,74)| 4| 4-GFSK| 0.180 | 0.72 | 0.25| 887.5 | -41.7 |FST4W-900 |LDPC | (240,74)| 4| 4-GFSK| 0.180 | 0.72 | 0.25| 887.5 | -41.7
|FST4W-1800 |LDPC | (240,74)| 4| 4-GFSK| 0.089 | 0.36 | 0.25| 1792.0| -44.8 |FST4W-1800 |LDPC | (240,74)| 4| 4-GFSK| 0.089 | 0.36 | 0.25| 1792.0| -44.8
|=============================================================================== |===
LDPC = Low Density Parity Check LDPC = Low Density Parity Check
RS = Reed Solomon RS = Reed Solomon
@ -304,7 +304,7 @@ comparable to tone spacing.
[[SLOW_SUBMODES]] [[SLOW_SUBMODES]]
.Parameters of Slow Submodes JT4, JT9, and JT65 with Selectable Tone Spacings .Parameters of Slow Submodes JT4, JT9, and JT65 with Selectable Tone Spacings
[width="50%",cols="h,3*^",frame=topbot,options="header"] [width="50%",cols="h,3*^",frame=topbot,options="header"]
|===================================== |===
|Mode |Tone Spacing |BW (Hz)|S/N (dB) |Mode |Tone Spacing |BW (Hz)|S/N (dB)
|JT4A |4.375| 17.5 |-23 |JT4A |4.375| 17.5 |-23
|JT4B |8.75 | 30.6 |-22 |JT4B |8.75 | 30.6 |-22
@ -324,18 +324,18 @@ comparable to tone spacing.
|JT65A |2.692| 177.6 |-25 |JT65A |2.692| 177.6 |-25
|JT65B |5.383| 352.6 |-25 |JT65B |5.383| 352.6 |-25
|JT65C |10.767| 702.5 |-25 |JT65C |10.767| 702.5 |-25
|===================================== |===
.Parameters of Q65 Submodes .Parameters of Q65 Submodes
[width="100%",cols="h,5*^",frame=topbot,options="header"] [width="100%",cols="h,5*^",frame=topbot,options="header"]
|===================================== |===
|T/R Period (s) |A Spacing Width (Hz)|B Spacing Width (Hz)|C Spacing Width (Hz)|D Spacing Width (Hz)|E Spacing Width (Hz) |T/R Period (s) |A Spacing Width (Hz)|B Spacing Width (Hz)|C Spacing Width (Hz)|D Spacing Width (Hz)|E Spacing Width (Hz)
|15|6.67 &#160; &#160; 4.33|13.33 &#160; &#160; 867|26.67 &#160; &#160; 1733|N/A|N/A |15|6.67 &#160; &#160; 4.33|13.33 &#160; &#160; 867|26.67 &#160; &#160; 1733|N/A|N/A
|30|3.33 &#160; &#160; 217|6.67 &#160; &#160; 433|13.33 &#160; &#160; 867| 26.67 &#160; &#160; 1733| N/A |30|3.33 &#160; &#160; 217|6.67 &#160; &#160; 433|13.33 &#160; &#160; 867| 26.67 &#160; &#160; 1733| N/A
|60|1.67 &#160; &#160; 108|3.33 &#160; &#160; 217|6.67 &#160; &#160; 433|13.33 &#160; &#160; 867|26.67 &#160; &#160; 1733 |60|1.67 &#160; &#160; 108|3.33 &#160; &#160; 217|6.67 &#160; &#160; 433|13.33 &#160; &#160; 867|26.67 &#160; &#160; 1733
|120|0.75 &#160; &#160; 49|1.50 &#160; &#160; 98|3.00 &#160; &#160; 195|6.00 &#160; &#160; 390| 12.00 &#160; &#160; 780 |120|0.75 &#160; &#160; 49|1.50 &#160; &#160; 98|3.00 &#160; &#160; 195|6.00 &#160; &#160; 390| 12.00 &#160; &#160; 780
|300|0.29 &#160; &#160; 19|0.58 &#160; &#160; 38|1.16 &#160; &#160; 75|2.31 &#160; &#160; 150|4.63 &#160; &#160; 301 |300|0.29 &#160; &#160; 19|0.58 &#160; &#160; 38|1.16 &#160; &#160; 75|2.31 &#160; &#160; 150|4.63 &#160; &#160; 301
|===================================== |===
[[FAST_MODES]] [[FAST_MODES]]
=== Fast Modes === Fast Modes
@ -390,8 +390,8 @@ and your QSO partner ± 200 Hz.
==== Summary ==== Summary
.Parameters of Fast Modes .Parameters of Fast Modes
[width="90%",cols="3h,^3,^2,^1,^2,^2,^2,^2,^2",frame="topbot",options="header"] [width="90%",cols="3h,^3,^2,^1,5*^2",frame="topbot",options="header"]
|===================================================================== |===
|Mode |FEC Type |(n,k) | Q|Modulation Type|Keying rate (Baud) |Mode |FEC Type |(n,k) | Q|Modulation Type|Keying rate (Baud)
|Bandwidth (Hz)|Sync Energy|Tx Duration (s) |Bandwidth (Hz)|Sync Energy|Tx Duration (s)
|JT9E |K=32, r=1/2|(206,72)| 8| 9-FSK| 25.0 | 225 | 0.19| 3.400 |JT9E |K=32, r=1/2|(206,72)| 8| 9-FSK| 25.0 | 225 | 0.19| 3.400
@ -400,4 +400,4 @@ and your QSO partner ± 200 Hz.
|JT9H |K=32, r=1/2|(206,72)| 8| 9-FSK|200.0 | 1800 | 0.19| 0.425 |JT9H |K=32, r=1/2|(206,72)| 8| 9-FSK|200.0 | 1800 | 0.19| 0.425
|MSK144 |LDPC |(128,90)| 2| OQPSK| 2000 | 2400 | 0.11| 0.072 |MSK144 |LDPC |(128,90)| 2| OQPSK| 2000 | 2400 | 0.11| 0.072
|MSK144 Sh|LDPC |(32,16) | 2| OQPSK| 2000 | 2400 | 0.20| 0.020 |MSK144 Sh|LDPC |(32,16) | 2| OQPSK| 2000 | 2400 | 0.20| 0.020
|===================================================================== |===

35
widgets/about.cpp
View File

@ -14,23 +14,24 @@ CAboutDlg::CAboutDlg(QWidget *parent) :
ui->setupUi(this); ui->setupUi(this);
ui->labelTxt->setText ("<h2>" + QString {"WSJT-X v" ui->labelTxt->setText ("<h2>" + QString {"WSJT-X v"
+ QCoreApplication::applicationVersion () + QCoreApplication::applicationVersion ()
+ " " + revision ()}.simplified () + "</h2><br />" + " " + revision ()}.simplified () + "</h2><br />"
"WSJT-X implements a number of digital modes designed for <br />" "WSJT-X implements a number of digital modes designed for <br />"
"weak-signal Amateur Radio communication. <br /><br />" "weak-signal Amateur Radio communication. <br /><br />"
"&copy; 2001-2021 by Joe Taylor, K1JT, Bill Somerville, G4WJS, <br />" "&copy; 2001-2021 by Joe Taylor, K1JT, Bill Somerville, G4WJS, <br />"
"Steve Franke, K9AN, and Nico Palermo, IV3NWV. <br /><br />" "Steve Franke, K9AN, and Nico Palermo, IV3NWV. <br /><br />"
"We gratefully acknowledge contributions from AC6SL, AE4JY,<br />" "We gratefully acknowledge contributions from AC6SL, AE4JY,<br />"
"DF2ET, DJ0OT, G3WDG, G4KLA, IW3RAB, K3WYC, KA1GT,<br />" "DF2ET, DJ0OT, G3WDG, G4KLA, IW3RAB, K3WYC, KA1GT,<br />"
"KA6MAL, KA9Q, KB1ZMX, KD6EKQ, KI7MT, KK1D, ND0B, PY2SDR,<br />" "KA6MAL, KA9Q, KB1ZMX, KD6EKQ, KI7MT, KK1D, ND0B, PY2SDR,<br />"
"VE1SKY, VK3ACF, VK4BDJ, VK7MO, W3DJS, W4TI, W4TV, and W9MDB.<br /><br />" "VE1SKY, VK3ACF, VK4BDJ, VK7MO, W3DJS, W3SZ, W4TI, W4TV,<br />"
"WSJT-X is licensed under the terms of Version 3 <br />" "and W9MDB.<br /><br />"
"of the GNU General Public License (GPL) <br /><br />" "WSJT-X is licensed under the terms of Version 3 <br />"
"<a href=" TO_STRING__ (PROJECT_HOMEPAGE) ">" "of the GNU General Public License (GPL) <br /><br />"
"<img src=\":/icon_128x128.png\" /></a>" "<a href=" TO_STRING__ (PROJECT_HOMEPAGE) ">"
"<a href=\"https://www.gnu.org/licenses/gpl-3.0.txt\">" "<img src=\":/icon_128x128.png\" /></a>"
"<img src=\":/gpl-v3-logo.svg\" height=\"80\" /><br />" "<a href=\"https://www.gnu.org/licenses/gpl-3.0.txt\">"
"https://www.gnu.org/licenses/gpl-3.0.txt</a>"); "<img src=\":/gpl-v3-logo.svg\" height=\"80\" /><br />"
"https://www.gnu.org/licenses/gpl-3.0.txt</a>");
} }
CAboutDlg::~CAboutDlg() CAboutDlg::~CAboutDlg()