From d20112fe9d2bbe8d3fbf584f99f68578d38185a8 Mon Sep 17 00:00:00 2001
From: Bill Somerville <g4wjs@classdesign.com>
Date: Thu, 28 May 2015 01:50:34 +0000
Subject: [PATCH] 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
---
doc/CMakeLists.txt | 10 +++++++---
doc/common/license.adoc | 1 -
doc/common/links.adoc | 17 ++++++++---------
doc/user_guide/cooperating-programs.adoc | 2 +-
doc/user_guide/install-from-source.adoc | 10 +++++++---
doc/user_guide/install-linux.adoc | 24 +++++++++++++-----------
doc/user_guide/install-mac.adoc | 4 ++--
doc/user_guide/wsjtx-main.adoc | 6 +++---
8 files changed, 41 insertions(+), 33 deletions(-)
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index e0067b931..f2a3fd9f9 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -56,13 +56,16 @@ set (UG_SRCS
user_guide/font-sizes.adoc
user_guide/rig-config-aor.adoc
user_guide/settings-general.adoc
+ user_guide/cooperating-programs.adoc
+ user_guide/logging.adoc
+ user_guide/settings-colors.adoc
)
set (UG_IMGS
user_guide/images/130610_2343-wav-80.png
user_guide/images/freemsg.png
user_guide/images/misc-main-ui.png
- user_guide/images/r4148-rpt-ui.png
+ user_guide/images/colors.png
user_guide/images/status-bar-a.png
user_guide/images/MacAppMenu.png
user_guide/images/help-menu.png
@@ -80,18 +83,19 @@ set (UG_IMGS
user_guide/images/settings-audio.png
user_guide/images/view-menu.png
user_guide/images/decode-menu.png
- user_guide/images/main-ui-1.4.png
+ user_guide/images/main-ui-1.5.png
user_guide/images/r3666-main-ui-80.png
user_guide/images/settings-ui.png
user_guide/images/wide-graph-controls.png
user_guide/images/decodes.png
user_guide/images/main-ui-controls.png
- user_guide/images/r4148-cat-ui.png
+ user_guide/images/reporting.png
user_guide/images/setup-menu.png
user_guide/images/file-menu.png
user_guide/images/misc-controls-center.png
user_guide/images/r4148-freq-ui.png
user_guide/images/special-mouse-commands.png
+ user_guide/images/psk-reporter.png
)
find_package (PythonInterp 2.4 REQUIRED)
diff --git a/doc/common/license.adoc b/doc/common/license.adoc
index 887e6682f..b540dfbf5 100755
--- a/doc/common/license.adoc
+++ b/doc/common/license.adoc
@@ -1,4 +1,3 @@
-// include links, but different path ./links.adoc v.s. ../../global/links.adoc
include::./links.adoc[]
_{prog}_ is free software: you can redistribute it and/or modify
under the terms of the GNU General Public License as published by
diff --git a/doc/common/links.adoc b/doc/common/links.adoc
index c7cdf0c37..2dc248df1 100644
--- a/doc/common/links.adoc
+++ b/doc/common/links.adoc
@@ -1,7 +1,7 @@
////
Link file to hold all links
-File Location: ./doc/global/links.adoc
-Usage example: include::../../global/links.adoc[]
+File Location: ./doc/common/links.adoc
+Usage example: include::../common/links.adoc[]
Syntax: [link-id] [link] [displayed test]
Example:
@@ -40,8 +40,8 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes.
:asciidoctor_style: http://asciidoctor.org/docs/asciidoc-writers-guide/#delimited-blocks[AsciiDoctor Styles Guide]
:asciidoctor_syntax: http://asciidoctor.org/docs/asciidoc-writers-guide/#delimited-blocks[AsciiDoctor Syntax Guide]
:cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[Commons Attribution-ShareAlike 3.0 Unported License]
-:debian32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.5.0_i386.deb[wsjtx-1.5.0_i386.deb]
-:debian64: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.5.0_amd64.deb[wsjtx-1.5.0_amd64.deb]
+:debian32: http://physics.princeton.edu/pulsar/K1JT/wsjtx_{VERSION}_i386.deb[wsjtx_{VERSION}_i386.deb]
+:debian64: http://physics.princeton.edu/pulsar/K1JT/wsjtx_{VERSION}_amd64.deb[wsjtx_{VERSION}_amd64.deb]
:debian: http://www.debian.org/[Debian]
:dev_guide: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjt-dev-guide.html[Dev-Guide]
:devsvn1: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[Devel-SVN]
@@ -51,8 +51,8 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes.
:dxatlas: http://www.dxatlas.com/[Afreet Software, Inc.]
:dxlcommander: http://www.dxlabsuite.com/commander/[Commander]
:dxlsuite: http://www.dxlabsuite.com/[DX Lab Suite]
-:fedora32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.5.0_i686.rpm[wsjtx-1.5.0_i686.rpm]
-:fedora64: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.5.0_x86_64.rpm[wsjtx-1.5.0_x86_64.rpm]
+:fedora32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-{VERSION}-i686.rpm[wsjtx-{VERSION}-i686.rpm]
+:fedora64: http://physics.princeton.edu/pulsar/K1JT/wsjtx-{VERSION}-x86_64.rpm[wsjtx-{VERSION}-x86_64.rpm]
:fmt_arrl: http://www.arrl.org/frequency-measuring-test[ARRL FMT Info]
:fmt_group: https://groups.yahoo.com/neo/groups/FMT-nuts/info[FMT Group]
:fmt_k5cm: http://www.k5cm.com/[FMT Event Info]
@@ -91,11 +91,10 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes.
:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd]
:nh6z: http://www.nh6z.net/Amatuer_Radio_Station_NH6Z/Other_Peoples_Software.html[here]
:omnirig: http://www.dxatlas.com/OmniRig/Files/OmniRig.zip[Download]
-:osx_107: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.5.0-Darwin.dmg[wsjtx-1.5.0-Darwin.dmg]
+:osx: http://physics.princeton.edu/pulsar/K1JT/wsjtx-{VERSION}-Darwin.dmg[wsjtx-{VERSION}-Darwin.dmg]
:svn: http://subversion.apache.org/packages.html#windows[Subversion]
-:win32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.5.0-win32.exe[wsjtx-1.5.0-win32.exe]
+:win32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-{VERSION}-win32.exe[wsjtx-{VERSION}-win32.exe]
:wsjt_svn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[here]
-:wsjtx_rc2_tag: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/tags/wsjtx-1.5.0/[Tag: WSJT-X v1.4 RC2]
:wspr_code: http://physics.princeton.edu/pulsar/K1JT/WSPRcode.exe[WSPRcode.exe]
:wspr_svn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/branches/wspr/[here]
diff --git a/doc/user_guide/cooperating-programs.adoc b/doc/user_guide/cooperating-programs.adoc
index 2c20165d7..51a099bc8 100644
--- a/doc/user_guide/cooperating-programs.adoc
+++ b/doc/user_guide/cooperating-programs.adoc
@@ -23,4 +23,4 @@ many operating aids including
- convenient direct access to various web services such as callsign lookup.
-image::images/jtalert.png[align="left",alt="JTAlert-X image"]
+//image::images/jtalert.png[align="left",alt="JTAlert-X image"]
diff --git a/doc/user_guide/install-from-source.adoc b/doc/user_guide/install-from-source.adoc
index 0bf85e269..466528f20 100644
--- a/doc/user_guide/install-from-source.adoc
+++ b/doc/user_guide/install-from-source.adoc
@@ -11,13 +11,17 @@ following packages:
- fftw3
- MinGW (for Windows only)
-Source code for _WSJT-X_ 1.5.0 can be downloaded with the command:
+Source code for _WSJT-X_ v{VERSION} can be downloaded with the command:
- svn co svn://svn.code.sf.net/p/wsjt/wsjt/tags/wsjtx-1.5.0
+=====
+svn co svn://svn.code.sf.net/p/wsjt/wsjt/tags/wsjtx-{VERSION}
+=====
and for the current development branch,
- svn co svn://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx
+=====
+svn co svn://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx
+=====
If you are interested in contributing to the development and
documentation of _WSJT_ and its sister programs, please join the
diff --git a/doc/user_guide/install-linux.adoc b/doc/user_guide/install-linux.adoc
index a5a1014b5..abf1c9145 100644
--- a/doc/user_guide/install-linux.adoc
+++ b/doc/user_guide/install-linux.adoc
@@ -2,31 +2,33 @@
* For Debian, Ubuntu, and other Debian-based systems:
** 32-bit: {debian32}
-- To install: +sudo dpkg -i wsjtx_1.5.0_i386.deb+
+- To install: +sudo dpkg -i wsjtx_{VERSION}_i386.deb+
- Uninstall: +sudo dpkg -P wsjtx+
** 64-bit: {debian64}
-- To install: +sudo dpkg -i wsjtx_1.5.0_amd64.deb+
+- To install: +sudo dpkg -i wsjtx_{VERSION}_amd64.deb+
- Uninstall: +sudo dpkg -P wsjtx+
** You may also need to execute the following commands in a terminal:
- sudo apt-get install libqt5multimedia5-plugins libqt5serialport5
- sudo apt-get install libfftw3-single3
-
* For Ubuntu 15.04 and similar systems:
++
+=====
+sudo apt-get install libqt5multimedia5-plugins libqt5serialport5
- sudo apt-get install libqt5multimedia5-plugins libqt5serialport5
- sudo apt-get install libfftw3-single3 libqt5opengl5
+sudo apt-get install libfftw3-single3 libqt5opengl5
+=====
* For Fedora, Red Hat, and other rpm-based systems:
** 32-bit: {fedora32}
-- To install: +sudo rpm -i wsjtx-1.5.0_i686.rpm+
+- To install: +sudo rpm -i wsjtx-{VERSION}-i686.rpm+
- Uninstall: +sudo rpm -e wsjtx+
** 64-bit: {fedora64}
-- To install: +sudo rpm -i wsjtx-1.5.0_x86_64.rpm+
+- To install: +sudo rpm -i wsjtx-{VERSION}-x86_64.rpm+
- Uninstall: +sudo rpm -e wsjtx+
** You may also need to execute the following commands in a terminal:
-
- sudo rpm install fftw-libs-single qt5-qtmultimedia qt5-qtserialport
++
+=====
+sudo yum install fftw-libs-single qt5-qtmultimedia qt5-qtserialport
+=====
* Linux users must install a companion program called *kvasd*.
Instructions for a simple, quick menu-driven installation may be
diff --git a/doc/user_guide/install-mac.adoc b/doc/user_guide/install-mac.adoc
index b82f8e4a8..94a2687ab 100644
--- a/doc/user_guide/install-mac.adoc
+++ b/doc/user_guide/install-mac.adoc
@@ -1,8 +1,8 @@
// These instructions are up-to-date for WSJT-X v1.4
-* OS X 10.7 and later: {osx_107}
+* OS X 10.7 and later: {osx}
-* After downloading it to your desktopo, double-click on the dmg file
+* After downloading it to your desktop, double-click on the dmg file
and consult its +ReadMe+ file for important installation notes.
* If you have already installed a previous version, you can retain it by
diff --git a/doc/user_guide/wsjtx-main.adoc b/doc/user_guide/wsjtx-main.adoc
index 57586d401..e2b31ca80 100644
--- a/doc/user_guide/wsjtx-main.adoc
+++ b/doc/user_guide/wsjtx-main.adoc
@@ -1,6 +1,6 @@
// This is a comment line, anything with // is ignored at process time.
= WSJT-X User Guide
-:Revision: 1.5
+:Revision: {VERSION}
// For web-pages, adding :badges: is ok, but is a security issue for
// package building .deb, .rpm, etc as it exposes the IP address and the images
// are non-free, so can't be included as part of the Debian package.
@@ -12,7 +12,7 @@
:prog: WSJT-X
// use global link file
-include::../../global/links.adoc[]
+include::../common/links.adoc[]
// These [[xxxx]] labels are HTML anchors, and can be used to
// navigate though the document easily: <<INTRO,See Introduction>> will
@@ -201,5 +201,5 @@ include::acknowledgements.adoc[]
[[LICENSE]]
== License
-include::../../global/license.adoc[]
+include::../common/license.adoc[]