From 7f913b9ea5d9fc7a7f7b81b528c9990fd80a95f3 Mon Sep 17 00:00:00 2001 From: Greg Beam Date: Thu, 30 Jan 2014 10:09:18 +0000 Subject: [PATCH] User Guide Updates * mainwindow.cpp - bumped ver# * Updated build-doc.sh: - name changes - array var for electaft - added Build Quick Reference Only option ./build-doc.sh quick-ref * Corrected file ext typo: .ado to .adoc * Started adding material to Quick Reference Guide. ** Tested all (4) build methods, no failures. git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3671 ab8295b8-cf94-4d9e-aec4-7959e3be5d79 --- doc/build-doc.sh | 23 ++++++++--- doc/source/quick-reference.adoc | 38 +++++++++++-------- ...-elecraft.ado => rig-config-elecraft.adoc} | 0 3 files changed, 41 insertions(+), 20 deletions(-) rename doc/source/{rig-config-elecraft.ado => rig-config-elecraft.adoc} (100%) diff --git a/doc/build-doc.sh b/doc/build-doc.sh index 0f21393c3..98e2d8b43 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-24-2014 -# Version : 0.3 +# Date : JAN-30-2014 +# Version : 0.4 # Usage : ./build-doc.sh [ option ] # Notes : requires asciidoc, source-highlight #============================================================================== @@ -52,7 +52,7 @@ function build_support_pages() { # build all remaining pages echo -e ${green}'.. rig-config-main.html'${no_col} # setup rig file array - declare -a subpage=('adat' 'alinco' 'aor' 'drake' 'electro' 'flexrad' 'icom' \ + declare -a subpage=('adat' 'alinco' 'aor' 'drake' 'elecraft' 'flexrad' 'icom' \ 'kenwood' 'softrock' 'tentec' 'yaesu') # loop through rig-config pages @@ -64,7 +64,10 @@ function build_support_pages() { # build all remaining pages $c_asciidoc -o rig-config-template.html $src_dir/rig-config-template.adoc echo -e ${green}'.. rig-config-template.html'${no_col} +} +function build_quick_ref() { # build quick-reference guide + echo -e ${yellow}'Building Quick Reference Guide'${no_col} $c_asciidoc -a toc2 -o quick-reference.html $src_dir/quick-reference.adoc echo -e ${green}'.. quick-reference.html'${no_col} } @@ -78,19 +81,23 @@ ${no_col}${yellow}" ***\n" ${no_col} if [[ $1 = "" ]] then build_no_toc + build_quick_ref build_support_pages + # top TOC elif [[ $1 = "toc1" ]] then build_toc1 + build_quick_ref build_support_pages # left TOC elif [[ $1 = "toc2" ]] then - build_toc2 - build_support_pages + build_toc2 + build_quick_ref + build_support_pages # all toc versions elif [[ $1 = "all" ]] @@ -98,8 +105,14 @@ elif [[ $1 = "all" ]] build_no_toc build_toc1 build_toc2 + build_quick_ref build_support_pages +# quick-reference.html only +elif [[ $1 = "quick-ref" ]] + then + build_quick_ref + # Usage: if something other than "", toc1, toc2 or all is entered as $1 display usage # message and exit. # diff --git a/doc/source/quick-reference.adoc b/doc/source/quick-reference.adoc index a66e3fcc1..fc8fad60f 100644 --- a/doc/source/quick-reference.adoc +++ b/doc/source/quick-reference.adoc @@ -14,13 +14,13 @@ :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 ] +:cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[ Commons Attribution-ShareAlike 3.0 Unported License ] :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 ] @@ -40,20 +40,35 @@ examples can be found at: [[X2]] == Asciidoc Install -For WSJT-X documentation, only (2) dependencies are generally required: +For _WSJT-X_ documentation purposes, only (2) dependencies are generally +required: -* Python v2.7+ -* Gnu source-highlight +* Python +* Source highlight + +For most packages, the normal method of installation is through their +respective package manager. There are several reasons why we do not +want this for the _WSJT-X User Guide_: + +** Most packaged applications are installed system-wide, which means standard +pivilaged (non Root / RootSudo) users update their binaries. +** Often times, distro packages are (1) or more revisions behind. +** Updating to the latest stable _AscciDoc_ version, using Mercurial, is a simple +one line command: _hg pull ; hg update ; hg upgrade_, or clone a new binary +set with _hg clone -r 8.6._ then re-link the new binary. +** Using $HOME makes working on the _WSJT-X User Guide_ portable, such as, +installing to a USB Key and allowing you to test build your work on virtually +any system that has _Python_ {amp}{amp} _Bash Enviroment_ installed. + +// Several more items pending addition +_Further Edited Pending_ -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: @@ -83,36 +98,29 @@ Install Instructions: Install Instructions: [[X3]] -== Code Examples +== How To Contribute .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 diff --git a/doc/source/rig-config-elecraft.ado b/doc/source/rig-config-elecraft.adoc similarity index 100% rename from doc/source/rig-config-elecraft.ado rename to doc/source/rig-config-elecraft.adoc