From 44543d385dfa50882061d9f3ada906abf4068707 Mon Sep 17 00:00:00 2001 From: Greg Beam Date: Sat, 25 Jan 2014 22:26:21 +0000 Subject: [PATCH] User Guide Docs Update * Moved doc/source/*.txt to AsciiDoc ext source/*.adoc - Correctly identifies AsciiDoc files * wsjtx-main.adoc - Updated links and include:: for *.adoc name change * Added and updated rig-config-* files. * Added inital draft of quick-reference.adoc * build-doc.sh - Updated the script to build new files and .adoc name change * Removed: - yaesu.txt rigtemplate.txt rig-configuration.txt git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3662 ab8295b8-cf94-4d9e-aec4-7959e3be5d79 --- doc/build-doc.sh | 83 +++++----- ...owledgements.txt => acknowledgements.adoc} | 0 ...s.txt => configuration-band-settings.adoc} | 0 ...dow.txt => configuration-main-window.adoc} | 0 ...station.txt => configuration-station.adoc} | 0 ...macros.txt => configuration-txmacros.adoc} | 0 ...ter.txt => controls-functions-center.adoc} | 0 ...t => controls-functions-kb-shortcuts.adoc} | 0 ...-left.txt => controls-functions-left.adoc} | 0 ...xt => controls-functions-main-window.adoc} | 0 ...enus.txt => controls-functions-menus.adoc} | 0 ...s.txt => controls-functions-messages.adoc} | 0 ...ontrols-functions-special-mouse-cmds.adoc} | 0 ...txt => controls-functions-status-bar.adoc} | 0 ...txt => controls-functions-wide-graph.adoc} | 0 ...-functions.txt => controls-functions.adoc} | 0 ...ls.txt => example1-decoding-controls.adoc} | 0 ...ew.txt => example1-decoding-overview.adoc} | 0 ...ecodes.txt => example2-check-decodes.adoc} | 0 ...n-window.txt => example2-main-window.adoc} | 0 ...-wave-1742.txt => example2-wave-1742.adoc} | 0 ...-wave-2343.txt => example2-wave-2343.adoc} | 0 ....txt => example2-wide-graph-settings.adoc} | 0 .../{font-sizes.txt => font-sizes.adoc} | 0 ...om-source.txt => install-from-source.adoc} | 0 .../{install-mac.txt => install-mac.adoc} | 0 ...install-ubuntu.txt => install-ubuntu.adoc} | 0 ...stall-windows.txt => install-windows.adoc} | 0 ...stalled-files.txt => installed-files.adoc} | 0 .../{introduction.txt => introduction.adoc} | 0 ...ferences.txt => jt65-jt9-differences.adoc} | 0 .../{jt9-protocol.txt => jt9-protocol.adoc} | 0 doc/source/{make-qso.txt => make-qso.adoc} | 0 doc/source/quick-reference.adoc | 142 ++++++++++++++++++ doc/source/rig-config-adat.adoc | 104 +++++++++++++ doc/source/rig-config-alinco.adoc | 104 +++++++++++++ doc/source/rig-config-aor.adoc | 103 +++++++++++++ doc/source/rig-config-drake.adoc | 104 +++++++++++++ doc/source/rig-config-electro.adoc | 104 +++++++++++++ doc/source/rig-config-flexrad.adoc | 104 +++++++++++++ doc/source/rig-config-icom.adoc | 104 +++++++++++++ doc/source/rig-config-kenwood.adoc | 104 +++++++++++++ doc/source/rig-config-main.adoc | 33 ++++ doc/source/rig-config-softrock.adoc | 104 +++++++++++++ doc/source/rig-config-template.adoc | 60 ++++++++ doc/source/rig-config-tentec.adoc | 104 +++++++++++++ doc/source/rig-config-yaesu.adoc | 102 +++++++++++++ doc/source/rig-configuration.txt | 33 ---- doc/source/rigtemplate.txt | 58 ------- .../{runtime-files.txt => runtime-files.adoc} | 0 ...equirments.txt => system-requirments.adoc} | 0 ...eiver-setup.txt => transceiver-setup.adoc} | 0 ...al-example1.txt => tutorial-example1.adoc} | 0 ...al-example2.txt => tutorial-example2.adoc} | 0 ...n-window.txt => tutorial-main-window.adoc} | 0 ....txt => tutorial-wide-graph-settings.adoc} | 0 .../{wsjtx-main.txt => wsjtx-main.adoc} | 68 +++++---- doc/source/yaesu.txt | 99 ------------ 58 files changed, 1459 insertions(+), 258 deletions(-) rename doc/source/{acknowledgements.txt => acknowledgements.adoc} (100%) rename doc/source/{configuration-band-settings.txt => configuration-band-settings.adoc} (100%) rename doc/source/{configuration-main-window.txt => configuration-main-window.adoc} (100%) rename doc/source/{configuration-station.txt => configuration-station.adoc} (100%) rename doc/source/{configuration-txmacros.txt => configuration-txmacros.adoc} (100%) rename doc/source/{controls-functions-center.txt => controls-functions-center.adoc} (100%) rename doc/source/{controls-functions-kb-shortcuts.txt => controls-functions-kb-shortcuts.adoc} (100%) rename doc/source/{controls-functions-left.txt => controls-functions-left.adoc} (100%) rename doc/source/{controls-functions-main-window.txt => controls-functions-main-window.adoc} (100%) rename doc/source/{controls-functions-menus.txt => controls-functions-menus.adoc} (100%) rename doc/source/{controls-functions-messages.txt => controls-functions-messages.adoc} (100%) rename doc/source/{controls-functions-special-mouse-cmds.txt => controls-functions-special-mouse-cmds.adoc} (100%) rename doc/source/{controls-functions-status-bar.txt => controls-functions-status-bar.adoc} (100%) rename doc/source/{controls-functions-wide-graph.txt => controls-functions-wide-graph.adoc} (100%) rename doc/source/{controls-functions.txt => controls-functions.adoc} (100%) rename doc/source/{example1-decoding-controls.txt => example1-decoding-controls.adoc} (100%) rename doc/source/{example1-decoding-overview.txt => example1-decoding-overview.adoc} (100%) rename doc/source/{example2-check-decodes.txt => example2-check-decodes.adoc} (100%) rename doc/source/{example2-main-window.txt => example2-main-window.adoc} (100%) rename doc/source/{example2-wave-1742.txt => example2-wave-1742.adoc} (100%) rename doc/source/{example2-wave-2343.txt => example2-wave-2343.adoc} (100%) rename doc/source/{example2-wide-graph-settings.txt => example2-wide-graph-settings.adoc} (100%) rename doc/source/{font-sizes.txt => font-sizes.adoc} (100%) rename doc/source/{install-from-source.txt => install-from-source.adoc} (100%) rename doc/source/{install-mac.txt => install-mac.adoc} (100%) rename doc/source/{install-ubuntu.txt => install-ubuntu.adoc} (100%) rename doc/source/{install-windows.txt => install-windows.adoc} (100%) rename doc/source/{installed-files.txt => installed-files.adoc} (100%) rename doc/source/{introduction.txt => introduction.adoc} (100%) rename doc/source/{jt65-jt9-differences.txt => jt65-jt9-differences.adoc} (100%) rename doc/source/{jt9-protocol.txt => jt9-protocol.adoc} (100%) rename doc/source/{make-qso.txt => make-qso.adoc} (100%) create mode 100644 doc/source/quick-reference.adoc create mode 100644 doc/source/rig-config-adat.adoc create mode 100644 doc/source/rig-config-alinco.adoc create mode 100644 doc/source/rig-config-aor.adoc create mode 100644 doc/source/rig-config-drake.adoc create mode 100644 doc/source/rig-config-electro.adoc create mode 100644 doc/source/rig-config-flexrad.adoc create mode 100644 doc/source/rig-config-icom.adoc create mode 100644 doc/source/rig-config-kenwood.adoc create mode 100644 doc/source/rig-config-main.adoc create mode 100644 doc/source/rig-config-softrock.adoc create mode 100644 doc/source/rig-config-template.adoc create mode 100644 doc/source/rig-config-tentec.adoc create mode 100644 doc/source/rig-config-yaesu.adoc delete mode 100644 doc/source/rig-configuration.txt delete mode 100644 doc/source/rigtemplate.txt rename doc/source/{runtime-files.txt => runtime-files.adoc} (100%) rename doc/source/{system-requirments.txt => system-requirments.adoc} (100%) rename doc/source/{transceiver-setup.txt => transceiver-setup.adoc} (100%) rename doc/source/{tutorial-example1.txt => tutorial-example1.adoc} (100%) rename doc/source/{tutorial-example2.txt => tutorial-example2.adoc} (100%) rename doc/source/{tutorial-main-window.txt => tutorial-main-window.adoc} (100%) rename doc/source/{tutorial-wide-graph-settings.txt => tutorial-wide-graph-settings.adoc} (100%) rename doc/source/{wsjtx-main.txt => wsjtx-main.adoc} (73%) delete mode 100644 doc/source/yaesu.txt diff --git a/doc/build-doc.sh b/doc/build-doc.sh index d52eecff7..0f21393c3 100755 --- a/doc/build-doc.sh +++ b/doc/build-doc.sh @@ -3,8 +3,8 @@ # Description : WSJT-X Documentation build script # Author : KI7MT # Email : ki7mt@yahoo.com -# Date : JAN-21-2014 -# Version : 0.2 +# Date : JAN-24-2014 +# Version : 0.3 # Usage : ./build-doc.sh [ option ] # Notes : requires asciidoc, source-highlight #============================================================================== @@ -26,60 +26,86 @@ c_asciidoc="asciidoc -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 Without TOC'${no_col} - $c_asciidoc -o wsjtx-main.html $src_dir/wsjtx-main.txt - echo -e ${green}'. Finished wsjtx-main.html'${no_col} + 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 with Top TOC'${no_col} - $c_asciidoc -a toc -o wsjtx-main-toc1.html $src_dir/wsjtx-main.txt - echo -e ${green}'. Finished wsjtx-main-toc1.html'${no_col} + 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 with Left TOC'${no_col} - $c_asciidoc -a toc2 -o wsjtx-main-toc2.html $src_dir/wsjtx-main.txt - echo -e ${green}'. Finished wsjtx-main-toc2.html'${no_col} + 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 -# Hard coded version info to build outside of source tree. -echo -e ${yellow}"*** Building WSJT-X User Guide for:" ${cyan}$doc_version${no_col}${yellow}" ***\n" ${no_col} +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 - echo -e ${yellow}'Building all TOC versions'${no_col} - echo build_no_toc - echo build_toc1 - echo build_toc2 + build_support_pages -# if something other than "", toc1, toc2 or all is entered as $1 display usage -# message and exit. this should be re-written to redirect the user to select -# 1 of 4 proper options v.s. exiting. +# 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} @@ -94,22 +120,9 @@ else echo exit 1 fi - -# build the rig template page - echo - echo -e ${yellow}'Building Rig Template'${no_col} - $c_asciidoc -o rigtemplate.html $src_dir/rigtemplate.txt - echo -e ${green}'. Finished'${no_col} - -# build the rig sheets -# this section will should be modified to loop through rig template(s) either by -# name or directory ./rig/rig_* could be used. - echo - echo -e ${yellow}'Building Rig Configuration Sheets'${no_col} - $c_asciidoc -o yaesu.html $src_dir/yaesu.txt - echo -e ${green}'. Finished'${no_col} echo echo -e ${yellow}'All HTML files have been saved to:'${no_col}${cyan} "$base_dir" ${no_col} echo + exit 0 diff --git a/doc/source/acknowledgements.txt b/doc/source/acknowledgements.adoc similarity index 100% rename from doc/source/acknowledgements.txt rename to doc/source/acknowledgements.adoc diff --git a/doc/source/configuration-band-settings.txt b/doc/source/configuration-band-settings.adoc similarity index 100% rename from doc/source/configuration-band-settings.txt rename to doc/source/configuration-band-settings.adoc diff --git a/doc/source/configuration-main-window.txt b/doc/source/configuration-main-window.adoc similarity index 100% rename from doc/source/configuration-main-window.txt rename to doc/source/configuration-main-window.adoc diff --git a/doc/source/configuration-station.txt b/doc/source/configuration-station.adoc similarity index 100% rename from doc/source/configuration-station.txt rename to doc/source/configuration-station.adoc diff --git a/doc/source/configuration-txmacros.txt b/doc/source/configuration-txmacros.adoc similarity index 100% rename from doc/source/configuration-txmacros.txt rename to doc/source/configuration-txmacros.adoc diff --git a/doc/source/controls-functions-center.txt b/doc/source/controls-functions-center.adoc similarity index 100% rename from doc/source/controls-functions-center.txt rename to doc/source/controls-functions-center.adoc diff --git a/doc/source/controls-functions-kb-shortcuts.txt b/doc/source/controls-functions-kb-shortcuts.adoc similarity index 100% rename from doc/source/controls-functions-kb-shortcuts.txt rename to doc/source/controls-functions-kb-shortcuts.adoc diff --git a/doc/source/controls-functions-left.txt b/doc/source/controls-functions-left.adoc similarity index 100% rename from doc/source/controls-functions-left.txt rename to doc/source/controls-functions-left.adoc diff --git a/doc/source/controls-functions-main-window.txt b/doc/source/controls-functions-main-window.adoc similarity index 100% rename from doc/source/controls-functions-main-window.txt rename to doc/source/controls-functions-main-window.adoc diff --git a/doc/source/controls-functions-menus.txt b/doc/source/controls-functions-menus.adoc similarity index 100% rename from doc/source/controls-functions-menus.txt rename to doc/source/controls-functions-menus.adoc diff --git a/doc/source/controls-functions-messages.txt b/doc/source/controls-functions-messages.adoc similarity index 100% rename from doc/source/controls-functions-messages.txt rename to doc/source/controls-functions-messages.adoc diff --git a/doc/source/controls-functions-special-mouse-cmds.txt b/doc/source/controls-functions-special-mouse-cmds.adoc similarity index 100% rename from doc/source/controls-functions-special-mouse-cmds.txt rename to doc/source/controls-functions-special-mouse-cmds.adoc diff --git a/doc/source/controls-functions-status-bar.txt b/doc/source/controls-functions-status-bar.adoc similarity index 100% rename from doc/source/controls-functions-status-bar.txt rename to doc/source/controls-functions-status-bar.adoc diff --git a/doc/source/controls-functions-wide-graph.txt b/doc/source/controls-functions-wide-graph.adoc similarity index 100% rename from doc/source/controls-functions-wide-graph.txt rename to doc/source/controls-functions-wide-graph.adoc diff --git a/doc/source/controls-functions.txt b/doc/source/controls-functions.adoc similarity index 100% rename from doc/source/controls-functions.txt rename to doc/source/controls-functions.adoc diff --git a/doc/source/example1-decoding-controls.txt b/doc/source/example1-decoding-controls.adoc similarity index 100% rename from doc/source/example1-decoding-controls.txt rename to doc/source/example1-decoding-controls.adoc diff --git a/doc/source/example1-decoding-overview.txt b/doc/source/example1-decoding-overview.adoc similarity index 100% rename from doc/source/example1-decoding-overview.txt rename to doc/source/example1-decoding-overview.adoc diff --git a/doc/source/example2-check-decodes.txt b/doc/source/example2-check-decodes.adoc similarity index 100% rename from doc/source/example2-check-decodes.txt rename to doc/source/example2-check-decodes.adoc diff --git a/doc/source/example2-main-window.txt b/doc/source/example2-main-window.adoc similarity index 100% rename from doc/source/example2-main-window.txt rename to doc/source/example2-main-window.adoc diff --git a/doc/source/example2-wave-1742.txt b/doc/source/example2-wave-1742.adoc similarity index 100% rename from doc/source/example2-wave-1742.txt rename to doc/source/example2-wave-1742.adoc diff --git a/doc/source/example2-wave-2343.txt b/doc/source/example2-wave-2343.adoc similarity index 100% rename from doc/source/example2-wave-2343.txt rename to doc/source/example2-wave-2343.adoc diff --git a/doc/source/example2-wide-graph-settings.txt b/doc/source/example2-wide-graph-settings.adoc similarity index 100% rename from doc/source/example2-wide-graph-settings.txt rename to doc/source/example2-wide-graph-settings.adoc diff --git a/doc/source/font-sizes.txt b/doc/source/font-sizes.adoc similarity index 100% rename from doc/source/font-sizes.txt rename to doc/source/font-sizes.adoc diff --git a/doc/source/install-from-source.txt b/doc/source/install-from-source.adoc similarity index 100% rename from doc/source/install-from-source.txt rename to doc/source/install-from-source.adoc diff --git a/doc/source/install-mac.txt b/doc/source/install-mac.adoc similarity index 100% rename from doc/source/install-mac.txt rename to doc/source/install-mac.adoc diff --git a/doc/source/install-ubuntu.txt b/doc/source/install-ubuntu.adoc similarity index 100% rename from doc/source/install-ubuntu.txt rename to doc/source/install-ubuntu.adoc diff --git a/doc/source/install-windows.txt b/doc/source/install-windows.adoc similarity index 100% rename from doc/source/install-windows.txt rename to doc/source/install-windows.adoc diff --git a/doc/source/installed-files.txt b/doc/source/installed-files.adoc similarity index 100% rename from doc/source/installed-files.txt rename to doc/source/installed-files.adoc diff --git a/doc/source/introduction.txt b/doc/source/introduction.adoc similarity index 100% rename from doc/source/introduction.txt rename to doc/source/introduction.adoc diff --git a/doc/source/jt65-jt9-differences.txt b/doc/source/jt65-jt9-differences.adoc similarity index 100% rename from doc/source/jt65-jt9-differences.txt rename to doc/source/jt65-jt9-differences.adoc diff --git a/doc/source/jt9-protocol.txt b/doc/source/jt9-protocol.adoc similarity index 100% rename from doc/source/jt9-protocol.txt rename to doc/source/jt9-protocol.adoc diff --git a/doc/source/make-qso.txt b/doc/source/make-qso.adoc similarity index 100% rename from doc/source/make-qso.txt rename to doc/source/make-qso.adoc diff --git a/doc/source/quick-reference.adoc b/doc/source/quick-reference.adoc new file mode 100644 index 000000000..3e42e6f01 --- /dev/null +++ b/doc/source/quick-reference.adoc @@ -0,0 +1,142 @@ +// Status=DRAFT +// this is intentionally left as a single file v.s. multiple sections to allow +// users to brows the Page Source += AsciiDoc Quick Reference +:Author: WSJT-X Documetation Team +:Date: January 22, 2014, Copyright © CC-BY-SA 3.0 Unported +:Revision: 0.0.1 +:badges: +:icons: +:numbered: +:image_dir: + +// web-links +:asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[ AsciiDoc User Guide ] +:asciidoc_cheatsheet: http://powerman.name/doc/asciidoc[ AsciiDoc Cheatsheet ] +:asciidoc_questions: http://www.methods.co.nz/asciidoc/faq.html[ AsciiDoc FAQ ] +:devsvn: http://developer.berlios.de/projects/wsjt/[Devel-SVN] +:download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ] +:homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ] +:ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup] +:wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ] +:page_source: ./source/quick-reference.txt[ Page Source ] +:cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[ Commons Attribution-ShareAlike 3.0 Unported License ] + +// mail-to links +:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ] +:alex_efros: mailto:powerman@powerman.name[ Alex Efros ] +:devmail: mailto:wsjt-devel@lists.berlios.de[WSJT-Devel-List] + +[[X1]] +== Introduction +The purpose of this guide is to provide a quick reference to commonly used +markup-up items for writing the {wsjtx} User Guide. Additional resources and +examples can be found at: + +* {asciidoc_help} by {stuart_rackman} +* {asciidoc_questions} by {stuart_rackman} +* {asciidoc_cheatsheet} by {alex_efros} + +[[X2]] +== Asciidoc Install + +For WSJT-X documentation, only (2) dependencies are generally required: + +* Python v2.7+ +* Gnu source-highlight + +Each OS has its own unique method of solving the dependencies. The following +sub-sections will assist in the basic installation and setup. + +[[X21]] +=== Windows + +Install Instructions: + + +==== Vista, Win7, Win8 + +Install Instructions: + +[[X22]] +=== Linux + +==== Ubuntu, Debian, Mint and relatives + +Install Instructions: + +==== RedHat, Fedora, CentOS, and relatives + +Install Instructions: + +==== Slackware + +Install Instructions: + +==== Linux Other + +Install Instructions: + +[[X23]] +=== OS X + +Install Instructions: + +[[X3]] +== Code Examples +.Under Construction + +Code examples for frequently used itmes in WSJT-X Documentaion. + +[[X31]] +=== Blocks +.Under Construction + +Content needed. + +[[X32]] +=== Headers +.Under Construction + +Content needed. + +[[X33]] +=== Links +.Under Construction + +Content needed. + +[[X34]] +=== Lists +.Under Construction + +Content needed. + +[[X35]] +=== Notes +.Under Construction + +Content needed. + +[[X36]] +=== Text +.Under Construction + +Content needed. + +[[XA1]] +== Appendix A: Credits +.Authors, Editors, Commiters +If you worked on the documentation, add yourself to the list. + +* Authors: , + +* Editors: , + +* Commiters: , + + +== Appendix B: License + +This work is licensed under {cc_by_sa}. + diff --git a/doc/source/rig-config-adat.adoc b/doc/source/rig-config-adat.adoc new file mode 100644 index 000000000..a556a60ac --- /dev/null +++ b/doc/source/rig-config-adat.adoc @@ -0,0 +1,104 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += ADAT Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|ADAT3|ADAT4|ADAT5 +|======== + +[[X1]] +== ADAT-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== ADAT-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-config-alinco.adoc b/doc/source/rig-config-alinco.adoc new file mode 100644 index 000000000..bf42e3d10 --- /dev/null +++ b/doc/source/rig-config-alinco.adoc @@ -0,0 +1,104 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += Alinco Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|Alinco3|Alinco4|Alinco5 +|======== + +[[X1]] +== Alinco-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== Alinco-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-config-aor.adoc b/doc/source/rig-config-aor.adoc new file mode 100644 index 000000000..11cb9436f --- /dev/null +++ b/doc/source/rig-config-aor.adoc @@ -0,0 +1,103 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += AOR Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|AOR3|AOR4|AOR5 +|======== + +[[X1]] +== AOR-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== AOR-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew diff --git a/doc/source/rig-config-drake.adoc b/doc/source/rig-config-drake.adoc new file mode 100644 index 000000000..5310ff59b --- /dev/null +++ b/doc/source/rig-config-drake.adoc @@ -0,0 +1,104 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += Drake Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|Drake3|Drake4|Drake5 +|======== + +[[X1]] +== Drake-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== Drake-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-config-electro.adoc b/doc/source/rig-config-electro.adoc new file mode 100644 index 000000000..34a05f253 --- /dev/null +++ b/doc/source/rig-config-electro.adoc @@ -0,0 +1,104 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += ElectroCraft Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|ElectroCraft3|ElectroCraft4|ElectroCraft5 +|======== + +[[X1]] +== ElectroCraft-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== ElectroCraft-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-config-flexrad.adoc b/doc/source/rig-config-flexrad.adoc new file mode 100644 index 000000000..dd17de563 --- /dev/null +++ b/doc/source/rig-config-flexrad.adoc @@ -0,0 +1,104 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += Flex Radio Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|Flex3|Flex4|Flex5 +|======== + +[[X1]] +== Flex-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== Flex-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-config-icom.adoc b/doc/source/rig-config-icom.adoc new file mode 100644 index 000000000..2e626adee --- /dev/null +++ b/doc/source/rig-config-icom.adoc @@ -0,0 +1,104 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += Icom Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|Icom3|Icom4|Icom5 +|======== + +[[X1]] +== Icom-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== Icom-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-config-kenwood.adoc b/doc/source/rig-config-kenwood.adoc new file mode 100644 index 000000000..708d2695f --- /dev/null +++ b/doc/source/rig-config-kenwood.adoc @@ -0,0 +1,104 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += Kenwood Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|Kenwood3|Kenwood4|Kenwood5 +|======== + +[[X1]] +== Kenwood-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== Kenwood-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-config-main.adoc b/doc/source/rig-config-main.adoc new file mode 100644 index 000000000..e4cf077b9 --- /dev/null +++ b/doc/source/rig-config-main.adoc @@ -0,0 +1,33 @@ +// Status=review +:adat: link:rig-config-adat.html[ ADAT] +:alinco: link:rig-config-alinco.html[ Alinco ] +:aor: link:rig-config-aor.html[ AOR ] +:drake: link:rig-config-drake.html[ Drake ] +:electro: link:rig-config-electro.html[ ElectroCraft ] +:flexrad: link:rig-config-flexrad.html[ Flex Radio ] +:kenwood: link:rig-config-kenwood.html[ Kenwood ] +:icom: link:rig-config-icom.html[ Icom ] +:rig_template: link:rig-config-template.html[Template] +:softrock: link:rig-config-softrock.html[ Soft Rock ] +:tentec: link:rig-config-tentec.html[ Ten Tec ] +:yaesu: link:rig-config-yaesu.html[Yaesu] + +Some rigs work with DTR, RTS, Polling, CAT, and PTT while others do +not. The number of possible combinations is virtually endless. The +purpose of this section is to provide configuration information for +specific rig models, e.g. Icom 756 Pro-III, Kenwood TS-2000, Yaesu +FT-1000MP, Flex-5000, etc. This is a work-in-progress, and some rigs +may never be covered. + +NOTE: If you have configuration data for a rig that is not listed, or comments +about a particular rig configuration, please use the {rig_template} and send it +to {devmail}. + +.Select Manufacturer +[align="center",valign="middle",halign="center"] +|======== +|{adat}|{aor}|{alinco}|{drake}|{electro} +|{flexrad}|{kenwood}|{icom}|{softrock}|{tentec} +|{yaesu}|{rig_template}||| +|======== + diff --git a/doc/source/rig-config-softrock.adoc b/doc/source/rig-config-softrock.adoc new file mode 100644 index 000000000..a2319d8b5 --- /dev/null +++ b/doc/source/rig-config-softrock.adoc @@ -0,0 +1,104 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += SoftRock Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|SR3|SR4|SR5 +|======== + +[[X1]] +== SR-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== SR-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-config-template.adoc b/doc/source/rig-config-template.adoc new file mode 100644 index 000000000..474dc1a93 --- /dev/null +++ b/doc/source/rig-config-template.adoc @@ -0,0 +1,60 @@ +// Status=review +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] += Rig Template + +This is a simple guide for providing rig configuration data for the WSJT-X +User Guide. Try to fill out as much as possible, but do not worry if you cannot +fill in all the fields. OS Specific & Interface Notes are a bonus. + +* Copy and paste the template into a text file. +* Save as the rig's model.txt: rig-confg-ic756p3.txt +* Email the file to {devmail} for inclusion. +* Alternatively, join the team and submit the updates directly. + +.Copy & Paste the following: +---------- +Manufacturer: +Model: +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew +---------- + diff --git a/doc/source/rig-config-tentec.adoc b/doc/source/rig-config-tentec.adoc new file mode 100644 index 000000000..7d4f14e57 --- /dev/null +++ b/doc/source/rig-config-tentec.adoc @@ -0,0 +1,104 @@ +// Status=needsupdate +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += Ten Tec Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|TenTec3|TenTec4|TenTec5 +|======== + +[[X1]] +== TenTec-1 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== TenTec-2 +.Configuration Covers: + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +- Note-1/2/3 +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio +-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-config-yaesu.adoc b/doc/source/rig-config-yaesu.adoc new file mode 100644 index 000000000..e71d4909a --- /dev/null +++ b/doc/source/rig-config-yaesu.adoc @@ -0,0 +1,102 @@ +// Status=review +// This is a comment line, anything with // is ignored at process time. +// because the page is not a main page include, we need to add +// ref-links again, as they are not global. +:icons: +:badges: +:rig_template: link:rig-config-template.html[Template] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] + += Yaesu Configuration Guide +Available Configurations + +If you have configuration data for a rig that is not listed, or comments about a +particular rig configuration, please use the {rig_template} and send it to +{devmail}. + +[align="center",valign="middle",halign="center"] +// 5 Models per line please +|======== +|<>|<>|FT-3000|FT-5000|FT-9000 +|======== + +[[X1]] +== FT-1000 +.Configuration Covers FT-1000, FT-1000MP, FT-1000D + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + +[[X2]] +== FT-2000 +.Configuration Covers FT-2000, FT-2000D + +* MyCall: +* MyGrid: +* PTT Method: +* Pskreporter: +* CW Id After 73: +* CW Interval: +* CAT NOTES: +* DTR: +* RTS: +* CAT Port: +* CAT Port Settings: +* Split: +* Polling: +* Audio-In: +* Audio-In Mono: +* Audio-Out: +* Audio-Out: + +=== OS Specific Notes +.Notes Relating To Operating System + +* Windows: XP, Vista, Win7, Win8, etc. +* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc +* Mac OSx: + +=== Interface Notes +.Notes Relating To Rig Interface + +* Navigator +* SignaLink +* ShackLan +* Kam +* DX-Doubler +* Array Solutions +* Home-Brew + diff --git a/doc/source/rig-configuration.txt b/doc/source/rig-configuration.txt deleted file mode 100644 index 3b2813a2b..000000000 --- a/doc/source/rig-configuration.txt +++ /dev/null @@ -1,33 +0,0 @@ -// Status=review -.Rig Specific Configuration - -Some rigs work with DTR, RTS, Polling, CAT, and PTT while others do -not. The number of possible combinations is virtually endless. The -intent of this Appendix is to provide configuration information for -specific rig models, e.g. Icom 756 Pro-III, Kenwood TS-2000, Yaesu -FT-1000MP, Flex-5000, etc., in order to make installation and -configuration easier. This is a work-in-progress, and some rigs may -never be covered. - -The table below will link manufacturer names (Icom, Kenwood, Yaesu, -etc.) to specific models within each brand. If a model is not -available, please consider drafting a configuration file (a simple -text file), using the template provided, and submit it to the -development team for inclusion in future documentation releases. - -:yaesu: link:yaesu.html[Yaesu] -:rigtemplate: link:rigtemplate.html[Template] - -NOTE: If your manufacturer is not listed, it means we do not have -configuration files for any of the models for that particular -manufacturer. Please consider using the Rig Template and submit to -the development team at: {devmail} - -.Select Manufacturer -[align="center",valign="middle",halign="center"] -|======== -|ADAT|AOR|Alinco|Drake|Electro Craft -|Kenwood|Icom|SoftRock|Ten-Tec|{YAESU} -|{rigtemplate}|||| -|======== - diff --git a/doc/source/rigtemplate.txt b/doc/source/rigtemplate.txt deleted file mode 100644 index 2a101a12b..000000000 --- a/doc/source/rigtemplate.txt +++ /dev/null @@ -1,58 +0,0 @@ -// Status=review -= Rig Template -:Author: Greg Beam, KI7MT -:Date: September 22, 2013, Copyleft © 2013 -:Revision: 0.1 -:icons: -:badges: - -- This is a simple guide / template for including configuration data to the -WSJT-X Documentation Try to fill out as much as possible, but do not stress over -having empty fields. OS Specific & Interface Notes are a Bonus, if you coud -provide what you have, that would be much appreciated. - -- Just copy and paste the following into a text file, saving it as the rig's -model.txt, then email email it to the dev/doc team for inclusion. - -- Alternatively, join the team and submit the update directly. - -.Copy & Paste the following: ----------- -== Manufacture: -== Model: -- MyCall: -- MyGrid: -- PTT Method: -- Pskreporter: -- CW Id After 73: -- CW Interval: -- CAT NOTES: -** Note-1/2/3 -- DTR: -- RTS: -- CAT Port Settings: -- Split: -- CAT Port: -- Polling: -- Audio-In: -- Audio-In Mono: -- Audio-Out: -- Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating Systems -- Windows: -- Linux: -- Mac OSx: - -=== Interface Notes -.Notes Relating To Rig-To-Computer Interfaces -- Navigator -- SignaLink -- ShackLan -- Kam -- DX-Doubler -- Array Solutions (6-Pack) -- Home-Brew ----------- - diff --git a/doc/source/runtime-files.txt b/doc/source/runtime-files.adoc similarity index 100% rename from doc/source/runtime-files.txt rename to doc/source/runtime-files.adoc diff --git a/doc/source/system-requirments.txt b/doc/source/system-requirments.adoc similarity index 100% rename from doc/source/system-requirments.txt rename to doc/source/system-requirments.adoc diff --git a/doc/source/transceiver-setup.txt b/doc/source/transceiver-setup.adoc similarity index 100% rename from doc/source/transceiver-setup.txt rename to doc/source/transceiver-setup.adoc diff --git a/doc/source/tutorial-example1.txt b/doc/source/tutorial-example1.adoc similarity index 100% rename from doc/source/tutorial-example1.txt rename to doc/source/tutorial-example1.adoc diff --git a/doc/source/tutorial-example2.txt b/doc/source/tutorial-example2.adoc similarity index 100% rename from doc/source/tutorial-example2.txt rename to doc/source/tutorial-example2.adoc diff --git a/doc/source/tutorial-main-window.txt b/doc/source/tutorial-main-window.adoc similarity index 100% rename from doc/source/tutorial-main-window.txt rename to doc/source/tutorial-main-window.adoc diff --git a/doc/source/tutorial-wide-graph-settings.txt b/doc/source/tutorial-wide-graph-settings.adoc similarity index 100% rename from doc/source/tutorial-wide-graph-settings.txt rename to doc/source/tutorial-wide-graph-settings.adoc diff --git a/doc/source/wsjtx-main.txt b/doc/source/wsjtx-main.adoc similarity index 73% rename from doc/source/wsjtx-main.txt rename to doc/source/wsjtx-main.adoc index 01f030850..74a05a4c9 100644 --- a/doc/source/wsjtx-main.txt +++ b/doc/source/wsjtx-main.adoc @@ -37,11 +37,11 @@ // be section 1.1.1. This method is used throughout the document. [[X1]] == Introduction -include::introduction.txt[] +include::introduction.adoc[] [[X2]] == System Requirements -include::system-requirments.txt[] +include::system-requirments.adoc[] [[X3]] == Installation @@ -51,16 +51,16 @@ include::system-requirments.txt[] link(s) for your operating system. === Windows -include::install-windows.txt[] +include::install-windows.adoc[] [[X31]] === Linux -include::install-ubuntu.txt[] +include::install-ubuntu.adoc[] // The Mac Section need to be written. The file is a placeholder only. [[X32]] === OS X -include::install-mac.txt[] +include::install-mac.adoc[] // 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. @@ -69,104 +69,104 @@ include::install-mac.txt[] // Rreviewd. [[X33]] === Source Code -include::install-from-source.txt[] +include::install-from-source.adoc[] [[X4]] == Setup and Configuration [[X41]] === Station Tab -include::configuration-station.txt[] +include::configuration-station.adoc[] [[X42]] === Tx Macros Tab -include::configuration-txmacros.txt[] +include::configuration-txmacros.adoc[] [[X43]] === Band Settings Tab -include::configuration-band-settings.txt[] +include::configuration-band-settings.adoc[] [[X44]] === Main Window -include::configuration-main-window.txt[] +include::configuration-main-window.adoc[] [[X45]] === Font Sizes -include::font-sizes.txt[] +include::font-sizes.adoc[] [[X5]] == Basic Operating Tutorial [[X51]] === Main Window Settings -include::tutorial-main-window.txt[] +include::tutorial-main-window.adoc[] [[X52]] === Wide Graph Settings -include::tutorial-wide-graph-settings.txt[] +include::tutorial-wide-graph-settings.adoc[] [[X53]] === Sample File 1 -include::tutorial-example1.txt[] +include::tutorial-example1.adoc[] [[X54]] === Sample File 2 -include::tutorial-example2.txt[] +include::tutorial-example2.adoc[] [[X55]] === Transceiver Setup -include::transceiver-setup.txt[] +include::transceiver-setup.adoc[] [[X6]] == Making QSOs -include::make-qso.txt[] +include::make-qso.adoc[] [[X7]] == Controls & Functions -include::controls-functions.txt[] +include::controls-functions.adoc[] [[X71]] === Wide Graph Controls -include::controls-functions-wide-graph.txt[] +include::controls-functions-wide-graph.adoc[] [[X72]] === Main Window -include::controls-functions-main-window.txt[] +include::controls-functions-main-window.adoc[] [[X73]] === Misc Controls Left -include::controls-functions-left.txt[] +include::controls-functions-left.adoc[] [[X74]] === Misc Controls Center -include::controls-functions-center.txt[] +include::controls-functions-center.adoc[] [[X75]] === Tx Messages -include::controls-functions-messages.txt[] +include::controls-functions-messages.adoc[] [[X76]] === Status Bar -include::controls-functions-status-bar.txt[] +include::controls-functions-status-bar.adoc[] [[X77]] === Menus -include::controls-functions-menus.txt[] +include::controls-functions-menus.adoc[] [[X78]] === Keyboard Shortcuts -include::controls-functions-kb-shortcuts.txt[] +include::controls-functions-kb-shortcuts.adoc[] [[X79]] === Mouse Commands -include::controls-functions-special-mouse-cmds.txt[] +include::controls-functions-special-mouse-cmds.adoc[] [[X8]] == JT65 & JT9 Differences -include::jt65-jt9-differences.txt[] +include::jt65-jt9-differences.adoc[] [[X9]] == The JT9 Protocol -include::jt9-protocol.txt[] +include::jt9-protocol.adoc[] [[XA10]] == Appendix A @@ -174,17 +174,19 @@ include::jt9-protocol.txt[] // Note to Dev-Team, this list of files needs to be updated. [[XA11]] === Installed Files -include::installed-files.txt[] +include::installed-files.adoc[] [[XA12]] === Runtime Files -include::runtime-files.txt[] +include::runtime-files.adoc[] [[XB10]] == Appendix B -include::rig-configuration.txt[] +[[XB11]] +=== Rig Configuration +include::rig-config-main.adoc[] [[XACK10]] == Acknowledgments -include::acknowledgements.txt[] +include::acknowledgements.adoc[] diff --git a/doc/source/yaesu.txt b/doc/source/yaesu.txt deleted file mode 100644 index 179280658..000000000 --- a/doc/source/yaesu.txt +++ /dev/null @@ -1,99 +0,0 @@ -// Status=review -// This is a comment line, anything with // is ignored at process time. -= Yaesu Configuration Guide -:Author: Greg Beam, KI7MT -:Date: September 22, 2013, Copyleft © 2013 -:Revision: 0.1 -:icons: -:badges: - -.Available Configurations -[align="center",valign="middle",halign="center"] - -// 5 Models per line please -|======== -|<>|<>|FT-5000|FT-9000 -|======== - -[[X1]] -== FT-1000 -.Configuration Covers FT-1000, FT-1000MP, FT-1000D -- MyCall: -- MyGrid: -- PTT Method: ( CAT, DTR, RTS, VOX ) -- Pskreporter (optional): Check to Enable, default is off -- CW Id After 73 (optional): Check to Enable, Default is off -- CW Interval: Set if ID after 73 is evanbled -- CAT NOTES (recommended method): -** Note-1/2/3 -- DTR: Unchecked -- RTS: Unchecked -- CAT Port Settings: 4800, 8, none, 2 -- Split: Unchecked -- CAT Port: Select which port CAT is located on -- Polling: 3 -- Audio-In: Select Desirted Input Device -- Audio-In Mono: Mono, Left, Right -- Audio-Out: Select Output Device -- Audio-Out: Select Output Device - -=== OS Specific Notes -.Notes Relating To Operating Systems -- Windows: XP, Vista, 7,9, etc. -- Linux / *Nix: Slackaware, Fedora, FreeBSD, Ubuntu/Debian, etc -- Mac OSx: - -=== Interface Notes -.Notes Relating To Rig-To-Computer Interfaces -- Navigator -- SignaLink -- ShackLan -- Kam -- DX-Doubler -- Array Solutions (6-Pack) -- Home-Brew - -[[X2]] -== FT-2000 -.Configuration Covers FT-2000, FT-2000D -- MyCall: -- MyGrid: -- PTT Method: ( CAT, DTR, RTS, VOX ) -- Pskreporter (optional): Check to Enable, default is off -- CW Id After 73 (optional): Check to Enable, Default is off -- CW Interval: Set if ID after 73 is evanbled -- CAT NOTES (recommended method): -** Note-1/2/3 -- DTR: Unchecked -- RTS: Unchecked -- CAT Port Settings: 4800, 8, none, 2 -- Split: Unchecked -- CAT Port: Select which port CAT is located on -- Polling: 3 -- Audio-In: Select Desirted Input Device -- Audio-In Mono: Mono, Left, Right -- Audio-Out: Select Output Device -- Audio-Out: Select Output Device - -=== OS Specific Notes -.Notes Relating To Operating Systems -- Windows: XP, Vista, 7,9, etc. -- Linux / *Nix: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -- Mac OSx: - -=== Interface Notes -.Notes Relating To Rig-To-Computer Interfaces -- Navigator -- SignaLink -- ShackLan -- Kam -- DX-Doubler -- Array Solutions (6-Pack) -- Home-Brew - - - - - - -