WSJT-X/doc/source/wsjtx-main.txt
Joe Taylor d6cf422315 Split the asciidoc source for WSJT-X User's Guide into many
smaller files, by section and sub-section.  

Also extensive editing up through section 7.  Sections 6.2, 8, and
beyond definitely need work.  Other polishing is also desirable, and
maybe also some additions and/or changes.



git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3656 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-23 20:12:12 +00:00

210 lines
5.0 KiB
Plaintext

// Status=review
// This is a comment line, anything with // is ignored at process time.
= WSJT-X User Guide
:Author: Joe Taylor, K1JT
:Date: January 21, 2014, Copyright © 2012-2014
:Revision: 1.2.2
:badges:
:icons:
:numbered:
// If the list of links gets too long, we can add a url-file that is pulled
// in when and where needed with the following:
// include::<file-name> for example: include::url-list.txt
:devsvn: http://developer.berlios.de/projects/wsjt/[Devel-SVN]
:devmail: mailto:wsjt-devel@lists.berlios.de[WSJT-Devel-List]
:download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ]
:wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ]
:homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ]
:ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup]
:dxlcommander: http://www.dxlabsuite.com/commander/[ Commander ]
:hrd: http://www.hrdsoftwarellc.com/[ Ham Radio Deluxe ]
:image_dir:
:launchpadurl: https://launchpad.net/~jnogatch/+archive/wsjtx[ WSJT-X Linux Packages ]
:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd]
:osx-instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[here]
:osx-108: http://physics.princeton.edu/pulsar/K1JT/wsjtx_3nov13.tar.gz[ OS X 10.6, 10.7, and 10.8 ]
:osx-109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[OS X 10.9]
:pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter]
// These [[X?]] numbers are HTML anchors, and can be used to
// navigate though the document easily: <<[X1],See Introduction]>> will
// place a hyper-link in your text to take you too the anchored section.
// All major sections or points of interest should have one.
// == is level (2), section 1.0, === would mean section 1.1, === would
// be section 1.1.1. This method is used throughout the document.
[[X1]]
== Introduction
include::introduction.txt[]
[[X2]]
== System Requirements
include::system-requirments.txt[]
[[X3]]
== Installation
Download {wsjtx} from the {homepage}. Click on the {wsjtx} at the left
margin and then on the appropriate link(s) for your operating system.
=== Windows
include::install-windows.txt[]
[[X31]]
=== Linux
include::install-ubuntu.txt[]
// The Mac Section need to be written. The file is a placeholder only.
[[X32]]
=== OS X
include::install-mac.txt[]
// Note to developers. The URL http://developer.berlios.de/projects/wsjt/. is
// to a very old src version of WSJT 5.7 or so. WSJTX is not listed at all.
// Also, all the Qt4 stuff is now obsolete, and needs to be updated.
// Instructions for source builds Win, *Nix & Mac all need to be written /
// Rreviewd.
[[X33]]
=== Source Code
include::install-from-source.txt[]
[[X4]]
== Setup and Configuration
[[X41]]
=== Station Tab
include::configuration-station.txt[]
[[X42]]
=== TX Macros Tab
include::configuration-txmacros.txt[]
[[X43]]
=== Band Settings Tab
include::configuration-band-settings.txt[]
[[X44]]
=== Main Window
include::configuration-main-window.txt[]
[[X45]]
=== Font Sizes
include::font-sizes.txt[]
[[X5]]
== Basic Operating Tutorial
[[X51]]
=== Main Window Settings
include::tutorial-main-window.txt[]
[[X52]]
=== Wide Graph Settings
include::tutorial-wide-graph-settings.txt[]
[[X53]]
=== Ex 1: JT9 Signals
include::tutorial-example1.txt[]
[[X54]]
=== Ex 2: JT65 and JT9 Signals
include::tutorial-example2.txt[]
[[X55]]
=== Transceiver Setup
include::transceiver-setup.txt[]
[[X6]]
== Making QSOs
include::make-qso.txt[]
[[X7]]
== Controls & Functions
include::controls-functions.txt[]
[[X71]]
=== Wide Graph Controls
include::controls-functions-wide-graph.txt[]
[[X72]]
=== Main Window
include::controls-functions-main-window.txt[]
[[X73]]
=== Misc Controls Left
include::controls-functions-left.txt[]
[[X74]]
=== Misc Controls Center
include::controls-functions-center.txt[]
[[X75]]
=== Tx Messages
include::controls-functions-messages.txt[]
[[X76]]
=== Status Bar
include::controls-functions-status-bar.txt[]
[[X77]]
=== Menus
include::controls-functions-menus.txt[]
[[X78]]
=== Keyboard Shortcuts
include::controls-functions-kb-shortcuts.txt[]
[[X79]]
=== Mouse Commands
include::controls-functions-special-mouse-cmds.txt[]
[[X9]]
== JT65 & JT9 Differences
include::jt65-jt9-differences.txt[]
[[XA10]]
== Appendix A
include::app-a.txt[]
[[XA11]]
=== JT9 Mode Table
include::app-a-jt9-mode-table.txt[]
[[XA12]]
=== Transmitting
include::app-a-transmitting.txt[]
[[XA13]]
=== Receiving & Decoding
include::app-a-rcv-decode.txt[]
[[XA14]]
=== Functional Procedures
include::app-a-functional-procedures.txt[]
[[XB10]]
== Appendix B
.Installed Files
- After installing {wsjtx} as described in <<X3, Installation>>, the
following files will be present in the installation directory:
// Note to Dev-Team, this list of files needs to be updated.
[[XB11]]
=== Installed Files
include::app-b-installed-files.txt[]
[[XB12]]
=== Runtime Files
include::app-b-runtime-files.txt[]
[[XC10]]
== Appendix C
include::app-c.txt[]
[[XACK10]]
== Acknowledgments
include::acknowledgements.txt[]