mirror of https://github.com/saitohirga/WSJT-X.git
1. Add "Utility Programs" section to User's Guide.
2. Change "Appendix x" section headings to useful descriptions. 3. Add KB1ZMX and W4TI to the WSJT-X "About" screen and Acknowledgments in the User's Guide. (Hope I didn't forget anyone -- please advise if I did!) 4. A few more minor tweaks to User's Guide git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3672 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This commit is contained in:
Joe Taylor
parent
6ef06bc16f
commit
f7e39a2009
|
|
@ -11,10 +11,10 @@ CAboutDlg::CAboutDlg(QWidget *parent, QString Revision) :
|
|||
m_Str = "<html><h2>" + m_Revision + "</h2>\n\n";
|
||||
m_Str += "WSJT-X implements digital modes JT9 and JT65 for <br>";
|
||||
m_Str += "Amateur Radio communication. <br><br>";
|
||||
m_Str += "Copyright 2001-2013 by Joe Taylor, K1JT -- with grateful <br>";
|
||||
m_Str += "Copyright 2001-2014 by Joe Taylor, K1JT, with grateful <br>";
|
||||
m_Str += "acknowledgment for contributions from AC6SL, AE4JY, <br>";
|
||||
m_Str += "DJ0OT, G4KLA, G4WJS, K3WYC, KA6MAL, KA9Q, KK1D, <br>";
|
||||
m_Str += "PY2SDR, VK3ACF, VK4BDJ, and W4TV.<br>";
|
||||
m_Str += "DJ0OT, G4KLA, G4WJS, K3WYC, KA6MAL, KA9Q, KB1ZMX, <br>";
|
||||
m_Str += "KK1D, PY2SDR, VK3ACF, VK4BDJ, W4TI, and W4TV.<br>";
|
||||
ui->labelTxt->setText(m_Str);
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ base_dir=$(pwd)
|
|||
src_dir="$base_dir/source"
|
||||
c_asciidoc="asciidoc -b xhtml11 -a max-width=1024px"
|
||||
script_name=$(basename $0)
|
||||
doc_version="1.2.2"
|
||||
doc_version="1.3"
|
||||
|
||||
# build functions
|
||||
function build_no_toc() { # no toc
|
||||
|
|
|
|||
129
doc/go
129
doc/go
|
|
@ -1,129 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# Title : build-doc.sh
|
||||
# Description : WSJT-X Documentation build script
|
||||
# Author : KI7MT
|
||||
# Email : ki7mt@yahoo.com
|
||||
# Date : JAN-24-2014
|
||||
# Version : 0.3
|
||||
# Usage : ./build-doc.sh [ option ]
|
||||
# Notes : requires asciidoc, source-highlight
|
||||
#==============================================================================
|
||||
|
||||
# exit on error
|
||||
set -e
|
||||
|
||||
#add some color
|
||||
red='\033[01;31m'
|
||||
green='\033[01;32m'
|
||||
yellow='\033[01;33m'
|
||||
cyan='\033[01;36m'
|
||||
no_col='\033[01;37m'
|
||||
|
||||
# misc var's
|
||||
base_dir=$(pwd)
|
||||
src_dir="$base_dir/source"
|
||||
c_asciidoc="python /c/users/joe/asciidoc-8.6.9/asciidoc.py -b xhtml11 -a max-width=1024px"
|
||||
|
||||
script_name=$(basename $0)
|
||||
doc_version="1.2.2"
|
||||
|
||||
# build functions
|
||||
function build_no_toc() { # no toc
|
||||
echo -e ${yellow}'Building Main With No TOC'${no_col}
|
||||
$c_asciidoc -o wsjtx-main.html $src_dir/wsjtx-main.adoc
|
||||
echo -e ${green}'.. wsjtx-main.html'${no_col}
|
||||
}
|
||||
|
||||
function build_toc1() { # top toc
|
||||
echo -e ${yellow}'Building Main with Top TOC'${no_col}
|
||||
$c_asciidoc -a toc -o wsjtx-main-toc1.html $src_dir/wsjtx-main.adoc
|
||||
echo -e ${green}'.. wsjtx-main-toc1.html'${no_col}
|
||||
}
|
||||
|
||||
function build_toc2() { # left toc
|
||||
echo -e ${yellow}'Building Main with Left TOC'${no_col}
|
||||
$c_asciidoc -a toc2 -o wsjtx-main-toc2.html $src_dir/wsjtx-main.adoc
|
||||
echo -e ${green}'.. wsjtx-main-toc2.html'${no_col}
|
||||
}
|
||||
|
||||
function build_support_pages() { # build all remaining pages
|
||||
echo
|
||||
echo -e ${yellow}'Building Support Pages'${no_col}
|
||||
$c_asciidoc -o rig-config-main.html $src_dir/rig-config-main.adoc
|
||||
echo -e ${green}'.. rig-config-main.html'${no_col}
|
||||
|
||||
# setup rig file array
|
||||
declare -a subpage=('adat' 'alinco' 'aor' 'drake' 'electro' 'flexrad' 'icom' \
|
||||
'kenwood' 'softrock' 'tentec' 'yaesu')
|
||||
|
||||
# loop through rig-config pages
|
||||
for rig in "${subpage[@]}"
|
||||
do
|
||||
$c_asciidoc -a toc2 -o rig-config-$rig.html $src_dir/rig-config-$rig.adoc
|
||||
echo -e ${green}".. rig-config-$rig.html"${no_col}
|
||||
done
|
||||
|
||||
$c_asciidoc -o rig-config-template.html $src_dir/rig-config-template.adoc
|
||||
echo -e ${green}'.. rig-config-template.html'${no_col}
|
||||
|
||||
$c_asciidoc -a toc2 -o quick-reference.html $src_dir/quick-reference.adoc
|
||||
echo -e ${green}'.. quick-reference.html'${no_col}
|
||||
}
|
||||
|
||||
# start the main script
|
||||
clear
|
||||
echo -e ${yellow}"*** Building WSJT-X User Guide for:" ${cyan}$doc_version\
|
||||
${no_col}${yellow}" ***\n" ${no_col}
|
||||
|
||||
# without TOC
|
||||
if [[ $1 = "" ]]
|
||||
then
|
||||
build_no_toc
|
||||
build_support_pages
|
||||
|
||||
# top TOC
|
||||
elif [[ $1 = "toc1" ]]
|
||||
then
|
||||
build_toc1
|
||||
build_support_pages
|
||||
|
||||
# left TOC
|
||||
elif [[ $1 = "toc2" ]]
|
||||
then
|
||||
build_toc2
|
||||
build_support_pages
|
||||
|
||||
# all toc versions
|
||||
elif [[ $1 = "all" ]]
|
||||
then
|
||||
build_no_toc
|
||||
build_toc1
|
||||
build_toc2
|
||||
build_support_pages
|
||||
|
||||
# Usage: if something other than "", toc1, toc2 or all is entered as $1 display usage
|
||||
# message and exit.
|
||||
#
|
||||
# To-Do: this should be re-written to redirect the user to select
|
||||
# 1 of 4 proper options v.s. exiting. Future version should provide
|
||||
# a terminal GUI, Whiptail, Dialog, Zenity etc.
|
||||
else
|
||||
clear
|
||||
echo -e ${red}" * INPUT ERROR *\n"${no_col}
|
||||
echo 'Script Usage: build-doc.sh [ option ]'
|
||||
echo
|
||||
echo 'For with No TOC: ' ./$script_name
|
||||
echo 'For with Top TOC: './$script_name 'toc1'
|
||||
echo 'For with Left TOC: './$script_name 'toc2'
|
||||
echo 'For All Versions: ' ./$script_name 'all'
|
||||
echo
|
||||
echo Please re-enter using the examples above.
|
||||
echo
|
||||
exit 1
|
||||
fi
|
||||
echo
|
||||
echo -e ${yellow}'All HTML files have been saved to:'${no_col}${cyan} "$base_dir" ${no_col}
|
||||
echo
|
||||
|
||||
exit 0
|
||||
|
||||
|
|
@ -1,17 +1,17 @@
|
|||
// Status=review
|
||||
|
||||
Many users of WSJT, too numerous to mention here individually, have
|
||||
contributed suggestions and advice that have greatly aided the
|
||||
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).
|
||||
Since 2005 the _WSJT_ project (including programs _WSJT_, _MAP65_,
|
||||
_WSPR_, _WSJT-X_, and _WSPR-X_) has been ``open source'', with all
|
||||
code licensed under the GNU Public License (GPL). Many users of these
|
||||
programs, too numerous to mention here individually, have contributed
|
||||
suggestions and advice that have greatly aided the development of
|
||||
_WSJT_ and its sister programs.
|
||||
|
||||
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.
|
||||
AE4JY, DJ0OT, G4KLA, G4WJS, K3WYC, KA6MAL, KA9Q, KB1ZMX, KI7MT, KK1D,
|
||||
PY2SDR, VK3ACF, VK4BDJ, W4TI, 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 _WSJT-X_ waterfall were copied from
|
||||
the excellent, well documented, open-source program _fldigi_, by *W1HKJ*
|
||||
|
|
|
|||
|
|
@ -21,14 +21,14 @@ screen. The program then finds and decodes all signals in the selected
|
|||
mode(s) over the displayed frequency range. The [red]*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'' is decoded
|
||||
first and appears in the *Rx Frequency* window. The *Band Activity*
|
||||
window shows this message plus all decodes at other frequencies.
|
||||
Lines containing CQ are highlighted in [green]*GREEN*, and lines
|
||||
with *My Call* (in this case K1JT) in [red]*RED*.
|
||||
Seven JT9 signals are present in the example file, all 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'' is decoded first and appears in the *Rx
|
||||
Frequency* window. The *Band Activity* window shows this message plus
|
||||
all decodes at other frequencies. Lines containing CQ are highlighted
|
||||
in [green]*GREEN*, and lines with *My Call* (in this case K1JT) in
|
||||
[red]*RED*.
|
||||
|
||||
TIP: For this step and the next, you may want to pretend you are K1JT
|
||||
by entering that callsign temporarily as *My Call* on the <<X11,*Setup
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
// Status=review
|
||||
// This is a comment line, anything with // is ignored at process time.
|
||||
= WSJT-X User Guide
|
||||
= WSJT-X User's Guide
|
||||
:Author: Joe Taylor, K1JT
|
||||
:Date: January 29, 2014, Copyright © 2012-2014
|
||||
:Revision: 1.2.2
|
||||
:Date: January 30, 2014, Copyright © 2012-2014
|
||||
:Revision: 1.3
|
||||
:badges:
|
||||
:icons:
|
||||
:numbered:
|
||||
|
|
@ -191,22 +191,24 @@ To be added ...
|
|||
== Frequently Asked Questions
|
||||
To be added ...
|
||||
|
||||
[[APPA]]
|
||||
== Appendix A
|
||||
[[FILES]]
|
||||
== File Names
|
||||
|
||||
// Note to Dev-Team, this list of files needs to be updated.
|
||||
[[APPA1]]
|
||||
[[FILES1]]
|
||||
=== Installed Files
|
||||
include::installed-files.adoc[]
|
||||
|
||||
[[APPA2]]
|
||||
[[FILES2]]
|
||||
=== Runtime Files
|
||||
include::runtime-files.adoc[]
|
||||
|
||||
[[APPB]]
|
||||
== Appendix B
|
||||
[[APPB1]]
|
||||
=== Rig Configuration
|
||||
[[UTIL]]
|
||||
== Utility Programs
|
||||
include::utilities.adoc[]
|
||||
|
||||
[[RIG_CONFIG]]
|
||||
== Rig Configuration
|
||||
include::rig-config-main.adoc[]
|
||||
|
||||
[[ACK]]
|
||||
|
|
|
|||
|
|
@ -23,9 +23,9 @@ subroutine chkmsg(message,cok,nspecial,flip)
|
|||
endif
|
||||
endif
|
||||
|
||||
if(message(1:2).eq.'RO') nspecial=2
|
||||
if(message(1:3).eq.'RRR') nspecial=3
|
||||
if(message(1:2).eq.'73') nspecial=4
|
||||
if(message(1:3).eq.'RO ') nspecial=2
|
||||
if(message(1:4).eq.'RRR ') nspecial=3
|
||||
if(message(1:3).eq.'73 ') nspecial=4
|
||||
|
||||
return
|
||||
end subroutine chkmsg
|
||||
|
|
|
|||
|
|
@ -0,0 +1,49 @@
|
|||
program JT65code
|
||||
|
||||
! Provides examples of message packing, bit and symbol ordering,
|
||||
! Reed Solomon encoding, and other necessary details of the JT65
|
||||
! protocol.
|
||||
|
||||
character*22 msg0,msg,decoded,cok*3
|
||||
integer dgen(12),sent(63),recd(12),era(51)
|
||||
logical text
|
||||
|
||||
nargs=iargc()
|
||||
if(nargs.ne.1) then
|
||||
print*,'Usage: JT65code "message"'
|
||||
go to 999
|
||||
endif
|
||||
|
||||
call getarg(1,msg0) !Get message from command line
|
||||
msg=msg0
|
||||
|
||||
call chkmsg(msg,cok,nspecial,flip) !See if it includes "OOO" report
|
||||
|
||||
if(nspecial.gt.0) then !or is a shorthand message
|
||||
write(*,1010)
|
||||
1010 format('Shorthand message.')
|
||||
go to 999
|
||||
endif
|
||||
|
||||
call packmsg(msg,dgen,text) !Pack message into 12 six-bit bytes
|
||||
write(*,1020) msg0
|
||||
1020 format('Message: ',a22) !Echo input message
|
||||
if(iand(dgen(10),8).ne.0) write(*,1030) !Is plain text bit set?
|
||||
1030 format('Plain text.')
|
||||
write(*,1040) dgen
|
||||
1040 format('Packed message, 6-bit symbols: ',12i3) !Display packed symbols
|
||||
|
||||
call rs_encode(dgen,sent) !RS encode
|
||||
call interleave63(sent,1) !Interleave channel symbols
|
||||
call graycode(sent,63,1,sent) !Apply Gray code
|
||||
write(*,1050) sent
|
||||
1050 format('Information-carrying channel symbols:'/(i5,20i3))
|
||||
|
||||
call graycode(sent,63,-1,sent)
|
||||
call interleave63(sent,-1)
|
||||
call rs_decode(sent,era,0,recd,nerr)
|
||||
call unpackmsg(recd,decoded) !Unpack the user message
|
||||
write(*,1060) decoded,cok
|
||||
1060 format('Decoded message: ',a22,2x,a3)
|
||||
|
||||
999 end program JT65code
|
||||
|
|
@ -35,7 +35,7 @@ QTextEdit* pPrefixes;
|
|||
QTcpSocket* commanderSocket = new QTcpSocket(0);
|
||||
|
||||
QString rev="$Rev$";
|
||||
QString Program_Title_Version=" WSJT-X v1.2.2, r" + rev.mid(6,4) +
|
||||
QString Program_Title_Version=" WSJT-X v1.3, r" + rev.mid(6,4) +
|
||||
" by K1JT";
|
||||
|
||||
//-------------------------------------------------- MainWindow constructor
|
||||
|
|
@ -1150,7 +1150,6 @@ void MainWindow::msgBox(QString t) //msgBox
|
|||
void MainWindow::on_actionOnline_Users_Guide_triggered() //Display manual
|
||||
{
|
||||
QDesktopServices::openUrl(QUrl(
|
||||
// "http://www.physics.princeton.edu/pulsar/K1JT/WSJT-X_Users_Guide_v1.2.pdf",
|
||||
"http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjtx-main-toc2.html",
|
||||
QUrl::TolerantMode));
|
||||
}
|
||||
|
|
@ -2797,6 +2796,11 @@ void MainWindow::on_freeTextMsg_editingFinished()
|
|||
void MainWindow::on_actionDouble_click_on_call_sets_Tx_Enable_triggered(bool checked)
|
||||
{
|
||||
m_quickCall=checked;
|
||||
if(checked) {
|
||||
lab3->setText("Tx-Enable Armed");
|
||||
} else {
|
||||
lab3->setText("Tx-Enable Disarmed");
|
||||
}
|
||||
}
|
||||
|
||||
void MainWindow::on_rptSpinBox_valueChanged(int n)
|
||||
|
|
|
|||
|
|
@ -2602,6 +2602,9 @@ p, li { white-space: pre-wrap; }
|
|||
<property name="text">
|
||||
<string>Double-click on call sets Tx Enable</string>
|
||||
</property>
|
||||
<property name="shortcut">
|
||||
<string>F7</string>
|
||||
</property>
|
||||
</action>
|
||||
<action name="action_73TxDisable">
|
||||
<property name="checkable">
|
||||
|
|
|
|||
Loading…
Reference in New Issue