From 7c93215c503774cf436327be1a9c1dc51b71730f Mon Sep 17 00:00:00 2001 From: Bill Somerville Date: Thu, 21 Oct 2021 15:15:02 +0100 Subject: [PATCH] User Guide updates and new contributor acknowledgement --- doc/common/links.adoc | 4 +- doc/user_guide/en/acknowledgements.adoc | 6 +- doc/user_guide/en/decoder_notes.adoc | 91 ++++++++++++------------ doc/user_guide/en/intro_subsections.adoc | 8 ++- doc/user_guide/en/new_features.adoc | 10 +-- doc/user_guide/en/protocols.adoc | 20 +++--- widgets/about.cpp | 35 ++++----- 7 files changed, 90 insertions(+), 84 deletions(-) diff --git a/doc/common/links.adoc b/doc/common/links.adoc index e3ca32930..fc4e38ed2 100644 --- a/doc/common/links.adoc +++ b/doc/common/links.adoc @@ -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] :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] -:win32_openssl: https://slproweb.com/download/Win32OpenSSL_Light-1_1_1k.msi[Win32 OpenSSL Light Package] -:win64_openssl: https://slproweb.com/download/Win64OpenSSL_Light-1_1_1k.msi[Win64 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_1L.msi[Win64 OpenSSL Light Package] :writelog: https://writelog.com/[Writelog] :wsjtx_group: https://groups.io/g/WSJTX[WSJTX Group] :wsjtx: https://physics.princeton.edu/pulsar/K1JT/wsjtx.html[WSJT-X] diff --git a/doc/user_guide/en/acknowledgements.adoc b/doc/user_guide/en/acknowledgements.adoc index 8aecb7879..6239717aa 100644 --- a/doc/user_guide/en/acknowledgements.adoc +++ b/doc/user_guide/en/acknowledgements.adoc @@ -15,9 +15,9 @@ greatly aided the development of _WSJT_ and its sister programs. For _WSJT-X_ in particular, we acknowledge contributions from *AC6SL, AE4JY, DF2ET, DJ0OT, G3WDG, G4KLA, IW3RAB, K3WYC, KA1GT, KA6MAL, KA9Q, KB1ZMX, KD6EKQ, KI7MT, KK1D, ND0B, PY2SDR, VE1SKY, VK3ACF, VK4BDJ, -VK7MO, W3DJS, W4TI, W4TV, and W9MDB*. Each of these amateurs has helped to -bring the program’s design, code, testing, and/or documentation to its -present state. +VK7MO, W3DJS, W3SZ, W4TI, W4TV, and W9MDB*. Each of these amateurs +has helped to bring the program’s design, code, testing, and/or +documentation to its present state. Most of the color palettes for the _WSJT-X_ waterfall were copied from the excellent, well documented, open-source program _fldigi_, by *W1HKJ* diff --git a/doc/user_guide/en/decoder_notes.adoc b/doc/user_guide/en/decoder_notes.adoc index 3780828c9..ff237c0e9 100644 --- a/doc/user_guide/en/decoder_notes.adoc +++ b/doc/user_guide/en/decoder_notes.adoc @@ -28,16 +28,16 @@ hypothetically known information. [[FT8_AP_INFO_TABLE]] .FST4, FT4, and FT8 AP information types -[width="35%",cols="h10, \| RRR \| RR73 \| 73] -|=============================================== +[width="50%",cols="1h,<10m",frame=topbot,options="header"] +|=== +|qP|Message components +|q0|?     ?     ? +|q1|CQ     ?     ? +|q2|MyCall     ?     ? +|q3|MyCall DxCall     ? +|q4|MyCall DxCall     [ \| RRR \| RR73 \| 73] +|q5|MyCall DxCall     ?         (*Max Drift* = 50) +|=== diff --git a/doc/user_guide/en/intro_subsections.adoc b/doc/user_guide/en/intro_subsections.adoc index b2fb527f0..168a9f87c 100644 --- a/doc/user_guide/en/intro_subsections.adoc +++ b/doc/user_guide/en/intro_subsections.adoc @@ -22,9 +22,11 @@ consequences. === User Interface in Other Languages -The _WSJT-X_ user interface is now available in many languages. When -a translated user interface is available for the computer's default -System Language, it will appear automatically on program startup. +The _WSJT-X_ user interface (UI) is now available in many languages. +When a translated UI is available for the computer's default System +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 diff --git a/doc/user_guide/en/new_features.adoc b/doc/user_guide/en/new_features.adoc index d5fa56193..cd30a4485 100644 --- a/doc/user_guide/en/new_features.adoc +++ b/doc/user_guide/en/new_features.adoc @@ -1,7 +1,7 @@ [[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 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 @@ -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 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 -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 suitable hardware that converts RF to baseband. The hardware/software combination implements a wideband, highly optimized receiver for the diff --git a/doc/user_guide/en/protocols.adoc b/doc/user_guide/en/protocols.adoc index 8eaaa1895..6da33176e 100644 --- a/doc/user_guide/en/protocols.adoc +++ b/doc/user_guide/en/protocols.adoc @@ -263,8 +263,8 @@ which the probability of decoding is 50% or higher. [[SLOW_TAB]] .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) |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 @@ -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-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 -|=============================================================================== +|=== LDPC = Low Density Parity Check RS = Reed Solomon @@ -304,7 +304,7 @@ comparable to tone spacing. [[SLOW_SUBMODES]] .Parameters of Slow Submodes JT4, JT9, and JT65 with Selectable Tone Spacings [width="50%",cols="h,3*^",frame=topbot,options="header"] -|===================================== +|=== |Mode |Tone Spacing |BW (Hz)|S/N (dB) |JT4A |4.375| 17.5 |-23 |JT4B |8.75 | 30.6 |-22 @@ -324,18 +324,18 @@ comparable to tone spacing. |JT65A |2.692| 177.6 |-25 |JT65B |5.383| 352.6 |-25 |JT65C |10.767| 702.5 |-25 -|===================================== +|=== .Parameters of Q65 Submodes [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) |15|6.67     4.33|13.33     867|26.67     1733|N/A|N/A |30|3.33     217|6.67     433|13.33     867| 26.67     1733| N/A |60|1.67     108|3.33     217|6.67     433|13.33     867|26.67     1733 |120|0.75     49|1.50     98|3.00     195|6.00     390| 12.00     780 |300|0.29     19|0.58     38|1.16     75|2.31     150|4.63     301 -|===================================== +|=== [[FAST_MODES]] === Fast Modes @@ -390,8 +390,8 @@ and your QSO partner ± 200 Hz. ==== Summary .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) |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 @@ -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 |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 -|===================================================================== +|=== diff --git a/widgets/about.cpp b/widgets/about.cpp index 7fc555447..8542a5158 100644 --- a/widgets/about.cpp +++ b/widgets/about.cpp @@ -14,23 +14,24 @@ CAboutDlg::CAboutDlg(QWidget *parent) : ui->setupUi(this); ui->labelTxt->setText ("

" + QString {"WSJT-X v" - + QCoreApplication::applicationVersion () - + " " + revision ()}.simplified () + "


" - "WSJT-X implements a number of digital modes designed for
" - "weak-signal Amateur Radio communication.

" - "© 2001-2021 by Joe Taylor, K1JT, Bill Somerville, G4WJS,
" - "Steve Franke, K9AN, and Nico Palermo, IV3NWV.

" - "We gratefully acknowledge contributions from AC6SL, AE4JY,
" - "DF2ET, DJ0OT, G3WDG, G4KLA, IW3RAB, K3WYC, KA1GT,
" - "KA6MAL, KA9Q, KB1ZMX, KD6EKQ, KI7MT, KK1D, ND0B, PY2SDR,
" - "VE1SKY, VK3ACF, VK4BDJ, VK7MO, W3DJS, W4TI, W4TV, and W9MDB.

" - "WSJT-X is licensed under the terms of Version 3
" - "of the GNU General Public License (GPL)

" - "" - "" - "" - "
" - "https://www.gnu.org/licenses/gpl-3.0.txt
"); + + QCoreApplication::applicationVersion () + + " " + revision ()}.simplified () + "
" + "WSJT-X implements a number of digital modes designed for
" + "weak-signal Amateur Radio communication.

" + "© 2001-2021 by Joe Taylor, K1JT, Bill Somerville, G4WJS,
" + "Steve Franke, K9AN, and Nico Palermo, IV3NWV.

" + "We gratefully acknowledge contributions from AC6SL, AE4JY,
" + "DF2ET, DJ0OT, G3WDG, G4KLA, IW3RAB, K3WYC, KA1GT,
" + "KA6MAL, KA9Q, KB1ZMX, KD6EKQ, KI7MT, KK1D, ND0B, PY2SDR,
" + "VE1SKY, VK3ACF, VK4BDJ, VK7MO, W3DJS, W3SZ, W4TI, W4TV,
" + "and W9MDB.

" + "WSJT-X is licensed under the terms of Version 3
" + "of the GNU General Public License (GPL)

" + "" + "" + "" + "
" + "https://www.gnu.org/licenses/gpl-3.0.txt
"); } CAboutDlg::~CAboutDlg()