Commit Graph

56 Commits

Author SHA1 Message Date
Joe Taylor
a3d57024d5 Edits and additions to User Guide. 2022-06-02 13:15:20 -04:00
Steven Franke
01990baa58 First cut at User Guide changes to section 6 to replace JT9 with FT8. 2021-07-27 09:25:18 -05:00
Joe Taylor
f74ad900ab Remove vestiges of JT9+JT65 mode from the User Guide. 2021-07-19 08:59:05 -04:00
Bill Somerville
d4c4cd0e05 Tagging the WSJT-X v2.3.1 release
-----BEGIN PGP SIGNATURE-----
 
 iQEzBAABCAAdFiEEUELwYiy7vDRM+hTD2GSwbR6BYY8FAmBMAVMACgkQ2GSwbR6B
 YY9zhQf+K8DgRh0q5bYBSQOaECDOYt3OY2DSRHAzOKLJIX25DJ1oKkj4BSiBcczG
 GNnNGefHWwDtDPJl5Vhu3mE8JsgVquEpl0r/V7Y7Zf+6dv+q/p6HCdwbBGHPQxJ7
 VVdH/Q643aMIK2nb25hwSt4Z3aZSvABmqN636D5tL8nqyBCF58La/AlncvF7+Xc4
 KOg7ll0RInkJh+2D11cTXtZn23+awtOSC2x5pkqSzQM6zCJ3yEb4OxzrjWmZKV5r
 8I0pe5G1hNl/Ecy0Hm8GEQQIW7DooF/MFHkK4Z9x7R7lzG71R0AeuFc4QjbO1NS+
 YeHeRaHvr2Fq2eFi7pZHqfc/O5WyiQ==
 =I/Tu
 -----END PGP SIGNATURE-----
gpgsig -----BEGIN PGP SIGNATURE-----
 
 iQEzBAABCAAdFiEEUELwYiy7vDRM+hTD2GSwbR6BYY8FAmBMp94ACgkQ2GSwbR6B
 YY/ycggAt7rjgs+32eO2fofGhyt4oBUs17oR6bKx34jSsOMqLrw+vJELsPphs3zi
 bhm5rIK0Fzrt/BVZMI8iSTawe32rqSw+YdJT9YPrHf8dyngYjxje/Rbhyv34cetH
 RLv89Ph8KNvFt7/NWZ2CfMPDmWnrFVFKb+Pu6CS0TKd2EA4ENyWyOLmZmSZvjjWQ
 hYcOWtIxf07Del2OucCZnuXpv9gW5RjobwM8jtGiaIwBLE+mkgBmcgTwPGiUCmUS
 D63L/5SspIkZcTjHU0sE2B0u40zOljJ7VTLShcY+BEtjTlPxLOVM8orzB3njryAc
 anM0IWb7UChalnVTOnLksnCvAcXKSg==
 =1ZRU
 -----END PGP SIGNATURE-----

Merge tag 'wsjtx-2.3.1' into release-2.4.0

Tagging the WSJT-X v2.3.1 release
2021-03-13 11:53:57 +00:00
Bill Somerville
ec61291cb0
Updates for latest Acsiidoctor version and default style sheet 2021-03-06 18:12:40 +00:00
Joe Taylor
7d69a41f9f Fix several User Guide omissiions related to Q65. 2021-03-05 09:29:21 -05:00
Bill Somerville
54a99c7c22
Repair User Guide version variable assignments 2021-02-26 16:22:16 +00:00
Bill Somerville
46a6b75944
Repair User Guide file name, asciidoctor macros, web fetch URL 2020-11-16 03:07:35 +00:00
Joe Taylor
598835d9c9 First cut at adding FST4, FST4W to the User Guide. 2020-09-23 15:03:33 -04:00
Joe Taylor
43e02116bf Updates to User Guide: Dark Style, translated UIs, ... 2020-05-19 15:18:13 -04:00
Joe Taylor
3a7eda58ea Add a section on EME Tips to the User Guide. 2020-05-08 10:02:05 -04:00
Bill Somerville
c2f63637ee
Removed confusing and inaccurate HTML user Guide document footer 2019-11-27 19:18:45 +00:00
Joe Taylor
f13ed57eef Document "Best S+P" in the User Guide. 2019-07-18 15:14:59 -04:00
Joe Taylor
3b777860ca Add a User Guide tutorial section for FT4. 2019-06-06 14:15:12 -04:00
Joe Taylor
70b531fc44 Updates to User Guide; replace FT8 and MSK144 sample files with ones using new protocols. 2018-12-11 11:24:04 -05:00
Joe Taylor
94a4e90290 Several additions/tweaks to User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@8521 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2018-02-22 13:55:42 +00:00
Joe Taylor
c988a35019 Update the list of keyboard shortcuts.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@8157 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2017-10-02 18:33:17 +00:00
Joe Taylor
616d8d83da Update User Guide and "mouse_commands".
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@8154 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2017-10-02 13:49:37 +00:00
Joe Taylor
7dfc11b786 Add some FreqCal info to User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@8134 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2017-09-28 19:51:04 +00:00
Joe Taylor
fdc3d2d4d8 More User Guide updates.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7997 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2017-08-03 18:18:34 +00:00
Joe Taylor
ed26d6a249 Updates to the WSJT-X User Guide for Version 1.8.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7987 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2017-08-02 19:23:42 +00:00
Joe Taylor
253020f3f0 Update the WSJT-X User Guide to v1.8
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7859 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2017-07-12 19:32:17 +00:00
Bill Somerville
0e214efb9c Rework install locations for better flexibility
Using the  CMake module  GNUInstallDirs to  set up  standard locations
which allows  better customisation for packagers  building for various
distributions.

The change does change some internal package file paths and will leave
some  files  in  old   locations  in  Windows  installations.  Running
uninstall  is probably  wise  on Windows  before  installing this  new
package layout if future clean uninstalls are desired.

Linux and other  *nix package maintainers can use  the CMake variables
CMAKE_INSTALL_xxx to vary the install paths of various components. See
the  CMake GNUInstallDirs  module documentation  for more  details. An
example might be for Slackware where package documents are expected to
be                            installed                           into
<install-prefix>/doc/<package-name>-<package-version>/ whereas the GNU
default         is         to        install         them         into
<install-prefix>/share/doc/<package-name>/.  To achieve  this set  the
CMake variable CMAKE_INSTALL_DOCDIR as follows when configuring:

cmake -D CMAKE_INSTALL_DOCDIR:PATH=doc/wsjtx-1.7.1 -D CMAKE_INSTALL_PREFIX= ...

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7623 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2017-03-28 13:03:48 +00:00
Joe Taylor
4d0c6c4466 Edit and add to User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7284 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-11-03 19:14:07 +00:00
Joe Taylor
eed5bc0be5 Add description of information accompanying decoded text to User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7281 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-11-02 20:25:51 +00:00
Joe Taylor
bf7c903318 Update the CMakeLists.txt for docs.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7239 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-10-26 16:47:59 +00:00
Joe Taylor
ddeb1bab4e Many editorial changes to User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7235 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-10-26 15:36:22 +00:00
Joe Taylor
40cf903db5 Many more additions to the WSJT-X User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7228 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-10-25 18:04:33 +00:00
Joe Taylor
a251c045e3 Rationalize several VHF-oriented features of the JT4 and JT64 decoders. More additions to the User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7227 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-10-24 20:48:24 +00:00
Joe Taylor
e4d10d4f19 Clarify what VHF-enabled JT65 messages get sent to the right window.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7226 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-10-24 17:01:47 +00:00
Joe Taylor
149f9b4e38 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
2016-10-14 20:36:34 +00:00
Joe Taylor
e7c42fc9a2 Update the CMakeLists.txt for User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7066 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-09-08 19:15:17 +00:00
Bill Somerville
59e59087bd Only generate USLetter size PDFs for languages that might need it
Only en-US, fr-CA, es-MX and es-CO use the USLetter paper size.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6646 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-04-24 19:05:03 +00:00
Bill Somerville
0ba0977aa2 User Guide localization
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6341 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-01-02 22:30:12 +00:00
Bill Somerville
c5ea6938d3 Another attempt to get installed locations right
That is, right for all platforms with both local and package installs.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6248 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-12-08 20:39:50 +00:00
Bill Somerville
859a5ef416 Make install locations configuration variables
Locations  of various  components  to be  determined at  configuration
time.   This  allows   various   "Standard"  system   layouts  to   be
accomodated. For example on FreeBSD the manpages are usually installed
in the man directory i.e. /usr/local/man whereas the WSJT-X default is
to install them in share/man i.e. /usr/share/man. By setting the CMake
variable  WSJT_MANPAGE_DESTINATION to  either a  relative or  absolute
path the install location can be set:

  $ cmake -D WSJT_MANPAGE_DESTINATION=. ...

will install the manpages at ${CMAKE_INSTALL_PREFIX}/man

The new configuration variables are:

 WSJT_BIN_DESTINATION
 WSJT_LIB_DESTINATION
 WSJT_SHARE_DESTINATION
 WSJT_DOC_DESTINATION
 WSJT_DATA_DESTINATION
 WSJT_MANPAGE_DESTINATION
 WSJT_PLUGIN_DESTINATION
 WSJT_QT_CONF_DESTINATION

NB: changes to the above may break WSJT-X at present where the install
    locations of files used directly by WSJT-X are moved.

Warning: using absolute  paths for these variables  is not recommended
as files may be installed  in unexpected places, particularly when run
with  root  privileges.  All  relative   paths  with  be  relative  to
CMAKE_INSTALL_PREFIX.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6192 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-26 19:45:10 +00:00
Bill Somerville
6c6a758b8b Add PDF generation to docs target
Cleaned  up   some  syntax   anomolies  because   of  the   switch  to
asciidoctor. Minor text tweaks to improve PDF pagination. Reduced HTML
master font size to 80% for better web rendering.

Removed references to KVASD from User Guide.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6142 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-21 02:34:20 +00:00
Bill Somerville
dc672c4bb1 Switch to ascidoctor for User Guide generation
Requires Ruby and asciidoctor to be installed.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6131 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-19 00:08:30 +00:00
Joe Taylor
c3ded3d418 Many more edits of the User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6105 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-16 20:13:47 +00:00
Joe Taylor
4b07fa7cb1 More editing of User Guide. Bring some images up to Version 1.6.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6102 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-16 00:11:40 +00:00
Joe Taylor
8609450974 Final (?) additions to WSJT-X User Guide for v1.6.0. Close reading
is now strongly encouraged!  We "go to press" soon!


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6090 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-13 20:26:41 +00:00
Joe Taylor
581577c421 Add Tool Tips for WSPR controls.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6066 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-10 14:19:22 +00:00
Joe Taylor
36d7d7b484 Add a brief "Support" section to the WSJT-X User Guide. (Section 16.)
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5602 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-06-12 19:52:29 +00:00
Joe Taylor
fad969b9e0 More additions to User Guide for v1.6.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5480 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-31 15:58:33 +00:00
Joe Taylor
ebc2cb2ffb Starting to update the User Guide to describe features new to v1.6.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5479 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-31 15:29:59 +00:00
Bill Somerville
0aa1e6605b Added graphic for JTAlert to user guide
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5438 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-28 02:07:15 +00:00
Bill Somerville
f41b03344e Fix up user guide sources for use in WSJT-X build
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5437 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-28 01:50:34 +00:00
Bill Somerville
aae320a3fe Clarify that documentation building is optional
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5428 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-27 22:06:59 +00:00
Bill Somerville
873579fecb Add an asciidoc theme so that project specific CSS can be used
The file doc/theme/wsjt.css is the theme  CSS file and it contains the
contents of the  standard asciidoc.css file followed  by WSJT specific
CSS overrides. If required a file  doc/theme/wsjt.js may be added at a
later date.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5369 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-12 21:32:18 +00:00
Bill Somerville
ec0c0786a9 Make CMake variable for asciidoc script less likely to be overridden
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5327 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-29 23:56:48 +00:00