First commit of the KI7MT documentation directory and contents.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3655 ab8295b8-cf94-4d9e-aec4-7959e3be5d79

doc/build-doc.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+#
+# Part of the wsjtx-doc project
+# Builds all *.txt files found in $(PWD)/source
+
+# exit on any error
+set -e
+
+# set script path's
+base_dir=$(pwd)
+src_dir="$base_dir/source"
+style_dir="$base_dir/style"
+log_dir="$base_dir/logs"
+
+# style sheet selection
+main_style=asciidoc.css
+toc2_style=toc2.css
+
+# This is temporary. Final version will loop through a directory of files
+c_asciidoc="asciidoc -b xhtml11 -a max-width=1024px"
+clear
+echo Building Main Page HTML
+echo .. Main Page Without TOC
+$c_asciidoc -o wsjtx-main.html ${src_dir}/wsjtx-main.txt
+echo .. Done
+
+echo .. Main Page With TOC
+$c_asciidoc -a toc -o wsjtx-main-toc.html ${src_dir}/wsjtx-main.txt
+echo .. Done
+
+echo .. Main Page With TOC2
+$c_asciidoc -a toc2 -o wsjtx-main-toc2.html ${src_dir}/wsjtx-main.txt
+echo .. Done
+
+echo Building Rig Configuration Sheets
+echo Building Yaesu
+$c_asciidoc -o yaesu.html ${src_dir}/yaesu.txt
+echo .. Done
+
+echo Building regtemplate
+$c_asciidoc -o rigtemplate.html ${src_dir}/rigtemplate.txt
+echo Done
+echo
+echo All HTML docs have been saved to "$base_dir"
+
+exit 0
+
+

doc/go

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+#
+# Part of the wsjtx-doc project
+# Builds all *.txt files found in $(PWD)/source
+
+# exit on any error
+set -e
+
+# set script path's
+base_dir=$(pwd)
+src_dir="$base_dir/source"
+style_dir="$base_dir/style"
+log_dir="$base_dir/logs"
+
+# style sheet selection
+main_style=asciidoc.css
+toc2_style=toc2.css
+
+# This is temporary. Final version will loop through a directory of files
+c_asciidoc="asciidoc -b xhtml11 -a max-width=1024px"
+clear
+#echo Building Main Page HTML
+#echo .. Main Page Without TOC
+#$c_asciidoc -o wsjtx-main.html ${src_dir}/wsjtx-main.txt
+#echo .. Done
+
+echo .. Main Page With TOC
+$c_asciidoc -a toc -o wsjtx-main-toc.html ${src_dir}/wsjtx-main.txt
+echo .. Done
+
+#echo .. Main Page With TOC2
+#$c_asciidoc -a toc2 -o wsjtx-main-toc2.html ${src_dir}/wsjtx-main.txt
+#echo .. Done
+
+echo Building Rig Configuration Sheets
+echo Building Yaesu
+$c_asciidoc -o yaesu.html ${src_dir}/yaesu.txt
+echo .. Done
+echo Building regtemplate
+$c_asciidoc -o rigtemplate.html ${src_dir}/rigtemplate.txt
+echo Done
+echo
+echo All HTML docs have been saved to "$base_dir"
+
+exit 0
+
+

doc/source/rigtemplate.txt

@@ -0,0 +1,57 @@
+= 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
+----------
+

doc/source/yaesu.txt

@@ -0,0 +1,98 @@
+// 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
+|========
+|<<X1,FT-1000>>|<<X2,FT-2000>>|FT-5000|FT-9000
+|========
+
+[[X1]]
+== FT-1000
+.Configuration Covers FT-1000, FT-1000MP, FT-1000D
+- MyCall: <Enter Your Call-Sign>
+- MyGrid: <Enter Grid Locator>
+- 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: <Enter Your Call-Sign>
+- MyGrid: <Enter Grid Locator>
+- 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
+
+
+
+
+
+
+