mirror of https://github.com/saitohirga/WSJT-X.git
User Guide Updates
** Updated Quick Reference Guide - updated AsciiDoc install for Linux - added AsciiDoc install for Windows - changed topics around. need input for topic ideas ** Added empty compiling.adoc & dev-guide.adoc - holding pages to prevent build script errors ** Build Script Updates - added help menu = ./build-doc.sh --help - added options to build dev-guide.adoc or quick-reference.adoc Only - added direct entry ./build-doc.sh [optoin] or menu selection - USAGE: ./build-doc.sh [ option ] - OPTIONS: "" toc1 toc2 all dev-guide quick-ref help ** HELP MENU: -- [1] No Table of Contents -- [2] Top Table of Contents -- [3] Left Table of Contents -- [4] Build All Guides -- [5] Development Guide Only -- [6] Quick Reference Guide Only : Actions from @QX9770-SRV1/Win64 ==> Cygwin terminal git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3683 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This commit is contained in:
Greg Beam
parent
717cf2c55b
commit
0a39f4626f
212
doc/build-doc.sh
212
doc/build-doc.sh
|
|
@ -3,15 +3,20 @@
|
||||||
# Description : WSJT-X Documentation build script
|
# Description : WSJT-X Documentation build script
|
||||||
# Author : KI7MT
|
# Author : KI7MT
|
||||||
# Email : ki7mt@yahoo.com
|
# Email : ki7mt@yahoo.com
|
||||||
# Date : JAN-30-2014
|
# Date : FEB-02-2014
|
||||||
# Version : 0.4
|
# Version : 0.5
|
||||||
# Usage : ./build-doc.sh [ option ]
|
# Usage : ./build-doc.sh [ option ]
|
||||||
# Notes : requires asciidoc, source-highlight
|
# Notes : requires asciidoc, source-highlight
|
||||||
#==============================================================================
|
#==============================================================================
|
||||||
|
|
||||||
# exit on error
|
# exit on error
|
||||||
|
# AsciiDoc "not found warnings" will not force the script to exit
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
|
# Trap Ctril+C, Ctrl+Z and quit signals
|
||||||
|
# TO-DO: Add additional clean-exit function
|
||||||
|
trap '' SIGINT SIGQUIT SIGTSTP
|
||||||
|
|
||||||
#add some color
|
#add some color
|
||||||
red='\033[01;31m'
|
red='\033[01;31m'
|
||||||
green='\033[01;32m'
|
green='\033[01;32m'
|
||||||
|
|
@ -26,116 +31,179 @@ c_asciidoc="asciidoc -b xhtml11 -a max-width=1024px"
|
||||||
script_name=$(basename $0)
|
script_name=$(basename $0)
|
||||||
doc_version="1.3"
|
doc_version="1.3"
|
||||||
|
|
||||||
# build functions
|
#######################
|
||||||
|
# set-up functions
|
||||||
|
#######################
|
||||||
|
|
||||||
|
# build with no table of contents
|
||||||
function build_no_toc() { # no toc
|
function build_no_toc() { # no toc
|
||||||
echo -e ${yellow}'Building Main With No TOC'${no_col}
|
echo -e ${yellow}'Building Main With No TOC'${no_col}
|
||||||
$c_asciidoc -o wsjtx-main.html $src_dir/wsjtx-main.adoc
|
$c_asciidoc -o wsjtx-main.html $src_dir/wsjtx-main.adoc
|
||||||
echo -e ${green}'.. wsjtx-main.html'${no_col}
|
echo -e ${green}'.. wsjtx-main.html'${no_col}
|
||||||
}
|
}
|
||||||
|
|
||||||
function build_toc1() { # top toc
|
# build with top table of contents
|
||||||
|
function build_toc1() {
|
||||||
echo -e ${yellow}'Building Main with Top TOC'${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
|
$c_asciidoc -a toc -o wsjtx-main-toc1.html $src_dir/wsjtx-main.adoc
|
||||||
echo -e ${green}'.. wsjtx-main-toc1.html'${no_col}
|
echo -e ${green}'.. wsjtx-main-toc1.html'${no_col}
|
||||||
}
|
}
|
||||||
|
|
||||||
function build_toc2() { # left toc
|
# build with left table of contents
|
||||||
|
function build_toc2() {
|
||||||
echo -e ${yellow}'Building Main with Left TOC'${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
|
$c_asciidoc -a toc2 -o wsjtx-main-toc2.html $src_dir/wsjtx-main.adoc
|
||||||
echo -e ${green}'.. wsjtx-main-toc2.html'${no_col}
|
echo -e ${green}'.. wsjtx-main-toc2.html'${no_col}
|
||||||
}
|
} # end left toc
|
||||||
|
|
||||||
function build_support_pages() { # build all remaining pages
|
# build all table of content versions
|
||||||
echo
|
function build_support_pages() {
|
||||||
echo -e ${yellow}'Building Support Pages'${no_col}
|
echo
|
||||||
$c_asciidoc -o rig-config-main.html $src_dir/rig-config-main.adoc
|
echo -e ${yellow}'Building Rig Pages'${no_col}
|
||||||
echo -e ${green}'.. rig-config-main.html'${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
|
# setup rig file array
|
||||||
declare -a subpage=('adat' 'alinco' 'aor' 'drake' 'elecraft' 'flexrad' 'icom' \
|
declare -a rig_page_ary=('adat' 'alinco' 'aor' 'drake' 'elecraft' 'flexrad' 'icom' \
|
||||||
'kenwood' 'softrock' 'tentec' 'yaesu')
|
'kenwood' 'softrock' 'tentec' 'yaesu')
|
||||||
|
|
||||||
# loop through rig-config pages
|
# loop through rig-config pages
|
||||||
for rig in "${subpage[@]}"
|
for rig in "${rig_page_ary[@]}"
|
||||||
do
|
do
|
||||||
$c_asciidoc -a toc2 -o rig-config-$rig.html $src_dir/rig-config-$rig.adoc
|
$c_asciidoc -a toc2 -o rig-config-$rig.html $src_dir/rig-config-$rig.adoc
|
||||||
echo -e ${green}".. rig-config-$rig.html"${no_col}
|
echo -e ${green}".. rig-config-$rig.html"${no_col}
|
||||||
done
|
done
|
||||||
|
|
||||||
$c_asciidoc -o rig-config-template.html $src_dir/rig-config-template.adoc
|
$c_asciidoc -o rig-config-template.html $src_dir/rig-config-template.adoc
|
||||||
echo -e ${green}'.. rig-config-template.html'${no_col}
|
echo -e ${green}'.. rig-config-template.html'${no_col}
|
||||||
}
|
} # end all toc version
|
||||||
|
|
||||||
function build_quick_ref() { # build quick-reference guide
|
# build quick-reference guide
|
||||||
|
function build_quick_ref() {
|
||||||
echo -e ${yellow}'Building Quick Reference Guide'${no_col}
|
echo -e ${yellow}'Building Quick Reference Guide'${no_col}
|
||||||
$c_asciidoc -a toc2 -o quick-reference.html $src_dir/quick-reference.adoc
|
$c_asciidoc -a toc2 -o quick-reference.html $src_dir/quick-reference.adoc
|
||||||
echo -e ${green}'.. quick-reference.html'${no_col}
|
echo -e ${green}'.. quick-reference.html'${no_col}
|
||||||
|
} # end quick-ref
|
||||||
|
|
||||||
|
# build dev-guide
|
||||||
|
function build_dev_guide() {
|
||||||
|
echo -e ${yellow}'Building Development Guide'${no_col}
|
||||||
|
$c_asciidoc -a toc2 -o dev-guide.html $src_dir/dev-guide.adoc
|
||||||
|
echo -e ${green}'.. dev-guide.html'${no_col}
|
||||||
|
} # end dev-guide
|
||||||
|
|
||||||
|
# help menu options
|
||||||
|
function help_menu() {
|
||||||
|
clear
|
||||||
|
echo -e ${green}"BUILD SCRIPT HELP NMENU\n"${no_col}
|
||||||
|
echo 'USAGE: build-doc.sh [ option ]'
|
||||||
|
echo
|
||||||
|
echo 'OPTIONS: toc1 toc2 all dev-guide quick-ref help'
|
||||||
|
echo
|
||||||
|
echo -e ${yellow}'WSJT-X User Guide Options:'${no_col}
|
||||||
|
echo ' [1] No Table of Contents'
|
||||||
|
echo ' [2] Top Table of Contents '
|
||||||
|
echo ' [3] Left Table of Contents'
|
||||||
|
echo ' [4] Build All Guide Versions'
|
||||||
|
echo -e ${yellow}"\nSingle Guide Builds"${no_col}
|
||||||
|
echo ' [5] Development Guide'
|
||||||
|
echo ' [6] Quick Reference Guide'
|
||||||
|
echo ' [0] Exit'
|
||||||
|
echo
|
||||||
|
}
|
||||||
|
function custom_wording() {
|
||||||
|
clear
|
||||||
|
echo -e ${yellow}"WSJT-X Documentation "${cyan}'v'$doc_version"\n" ${no_col}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#######################
|
||||||
# start the main script
|
# start the main script
|
||||||
|
#######################
|
||||||
|
|
||||||
|
# declare build array's
|
||||||
|
declare -a no_toc_ary=('custom_wording' 'build_no_toc' 'build_support_pages')
|
||||||
|
declare -a top_toc_ary=('custom_wording' 'build_toc1' 'build_support_pages')
|
||||||
|
declare -a left_toc_ary=('custom_wording' 'build_toc2' 'build_support_pages')
|
||||||
|
declare -a all_docs_ary=('custom_wording' 'build_no_toc' 'build_toc1' 'build_toc2' \
|
||||||
|
'build_quick_ref' 'build_dev_guide' 'build_support_pages')
|
||||||
|
|
||||||
|
# start builds
|
||||||
clear
|
clear
|
||||||
echo -e ${yellow}"*** Building WSJT-X User Guide for:" ${cyan}$doc_version\
|
echo -e ${yellow}"WSJT-X Documentation "${cyan}'v'$doc_version"\n"${no_col}
|
||||||
${no_col}${yellow}" ***\n" ${no_col}
|
|
||||||
|
|
||||||
# without TOC
|
# build options for direct command line entry: ./build-doc.sh [ option ]
|
||||||
|
# build without table of contents
|
||||||
if [[ $1 = "" ]]
|
if [[ $1 = "" ]]
|
||||||
then
|
then
|
||||||
build_no_toc
|
for f in "${no_toc_ary[@]}"; do $f; done
|
||||||
build_quick_ref
|
|
||||||
build_support_pages
|
|
||||||
|
|
||||||
|
# build top table of contents
|
||||||
# top TOC
|
|
||||||
elif [[ $1 = "toc1" ]]
|
elif [[ $1 = "toc1" ]]
|
||||||
then
|
then
|
||||||
build_toc1
|
for f in "${top_toc_ary[@]}"; do $f; done
|
||||||
build_quick_ref
|
|
||||||
build_support_pages
|
|
||||||
|
|
||||||
# left TOC
|
# build left table of contents
|
||||||
elif [[ $1 = "toc2" ]]
|
elif [[ $1 = "toc2" ]]
|
||||||
then
|
then
|
||||||
build_toc2
|
for f in "${left_toc_ary[@]}"; do $f; done
|
||||||
build_quick_ref
|
|
||||||
build_support_pages
|
|
||||||
|
|
||||||
# all toc versions
|
# build all table of content versions
|
||||||
elif [[ $1 = "all" ]]
|
elif [[ $1 = "all" ]]
|
||||||
then
|
then
|
||||||
build_no_toc
|
for f in "${all_docs_ary[@]}"; do $f; done
|
||||||
build_toc1
|
|
||||||
build_toc2
|
|
||||||
build_quick_ref
|
|
||||||
build_support_pages
|
|
||||||
|
|
||||||
# quick-reference.html only
|
# build quick-reference only
|
||||||
elif [[ $1 = "quick-ref" ]]
|
elif [[ $1 = "quick-ref" ]]
|
||||||
then
|
then
|
||||||
build_quick_ref
|
build_quick_ref
|
||||||
|
|
||||||
# Usage: if something other than "", toc1, toc2 or all is entered as $1 display usage
|
# build dev-guide only
|
||||||
# message and exit.
|
elif [[ $1 = "dev-guide" ]]
|
||||||
#
|
then
|
||||||
# To-Do: this should be re-written to redirect the user to select
|
build_dev_guide
|
||||||
# 1 of 4 proper options v.s. exiting. Future version should provide
|
|
||||||
# a terminal GUI, Whiptail, Dialog, Zenity etc.
|
# For HELP and undefined option entries
|
||||||
|
# NOTE: The case $SELECTIOIN should mirror the if [ .. ] statements
|
||||||
|
# to allow for menu and direct call builds
|
||||||
else
|
else
|
||||||
clear
|
while [ 1 ]
|
||||||
echo -e ${red}" * INPUT ERROR *\n"${no_col}
|
do
|
||||||
echo 'Script Usage: build-doc.sh [ option ]'
|
help_menu
|
||||||
echo
|
read -p "Enter Selection [ 1-6 or 0 to Exit ]: " SELECTION
|
||||||
echo 'For with No TOC: ' ./$script_name
|
case "$SELECTION" in
|
||||||
echo 'For with Top TOC: './$script_name 'toc1'
|
"1") # no table of contents build
|
||||||
echo 'For with Left TOC: './$script_name 'toc2'
|
clear
|
||||||
echo 'For All Versions: ' ./$script_name 'all'
|
for f in "${no_toc_ary[@]}"; do $f; done
|
||||||
echo
|
exit 0
|
||||||
echo Please re-enter using the examples above.
|
;;
|
||||||
echo
|
"2") # top table of contents build
|
||||||
exit 1
|
for f in "${top_toc_ary[@]}"; do $f; done
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
"3")
|
||||||
|
for f in "${left_toc_ary[@]}"; do $f; done
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
"4")
|
||||||
|
for f in "${all_docs_ary[@]}"; do $f; done
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
"5")
|
||||||
|
build_dev_guide
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
"6")
|
||||||
|
build_quick_ref
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
"0")
|
||||||
|
trap - SIGINT SIGQUIT SIGTSTP
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
fi
|
fi
|
||||||
echo
|
echo
|
||||||
echo -e ${yellow}'All HTML files have been saved to:'${no_col}${cyan} "$base_dir" ${no_col}
|
echo -e ${yellow}'All HTML files saved to:'${no_col}${cyan} "$base_dir" ${no_col}
|
||||||
echo
|
echo
|
||||||
|
|
||||||
exit 0
|
exit 0
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,12 +3,11 @@
|
||||||
// users to browse the Page Source
|
// users to browse the Page Source
|
||||||
= AsciiDoc Quick Reference
|
= AsciiDoc Quick Reference
|
||||||
:Author: WSJT-X Documetation Team
|
:Author: WSJT-X Documetation Team
|
||||||
:Date: January 22, 2014, Copyright (C) CC-BY-SA 3.0 Unported
|
:Date: January 22, 2014, (C) copyright, CC-BY-SA 3.0 Unported
|
||||||
:Revision: 0.0.1
|
:Revision: 0.0.1
|
||||||
:badges:
|
:badges:
|
||||||
:icons:
|
:icons:
|
||||||
:numbered:
|
:numbered:
|
||||||
:image_dir:
|
|
||||||
|
|
||||||
// WEB links - List is getting pretty long, time to use include::file-name ??
|
// WEB links - List is getting pretty long, time to use include::file-name ??
|
||||||
:asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[ AsciiDoc User Guide ]
|
:asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[ AsciiDoc User Guide ]
|
||||||
|
|
@ -32,133 +31,236 @@
|
||||||
|
|
||||||
// DOWNLOAD links
|
// DOWNLOAD links
|
||||||
:cty_dat: http://www.country-files.com/cty/[here].
|
:cty_dat: http://www.country-files.com/cty/[here].
|
||||||
|
:cygwin: http://cygwin.com/install.html[here]
|
||||||
:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd]
|
:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd]
|
||||||
:osx_108: http://physics.princeton.edu/pulsar/K1JT/wsjtx_3nov13.tar.gz[ OS X 10.6, 10.7, and 10.8 ]
|
: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 ]
|
:osx_109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[ OS X 10.9 ]
|
||||||
|
|
||||||
// MAIL-TO links
|
// MAIL-TO links
|
||||||
:alex_efros: mailto:powerman@powerman.name[ Alex Efros ]
|
:alex_efros: mailto:powerman@powerman.name[ Alex Efros ]
|
||||||
:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel]
|
:devmail: mailto:wsjt-devel@lists.berlios.de[ wsjt-devel ]
|
||||||
:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ]
|
:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ]
|
||||||
|
|
||||||
|
|
||||||
[[X1]]
|
[[X1]]
|
||||||
== Introduction
|
== Introduction
|
||||||
The purpose of this guide is to provide a quick reference to commonly used
|
The purpose of this guide is to provide a quick reference to commonly used items
|
||||||
markup-up items for writing the {wsjtx} User Guide. Additional resources and
|
while working with the _WSJT-X Documentation_ project.
|
||||||
examples can be found at:
|
|
||||||
|
|
||||||
|
=== AsciiDoc Examples
|
||||||
* {asciidoc_help} by {stuart_rackman}
|
* {asciidoc_help} by {stuart_rackman}
|
||||||
* {asciidoc_questions} by {stuart_rackman}
|
* {asciidoc_questions} by {stuart_rackman}
|
||||||
* {asciidoc_cheatsheet} by {alex_efros}
|
* {asciidoc_cheatsheet} by {alex_efros}
|
||||||
|
|
||||||
[[X2]]
|
[[X2]]
|
||||||
== Asciidoc Installation
|
== AsciiDoc installation
|
||||||
|
|
||||||
For most packages, the normal method of installation is through their
|
For most packages, the normal method of installation is through their
|
||||||
respective package manager. There are several reasons why we do not
|
respective package manager. There are several reasons why we do not
|
||||||
want this for the _WSJT-X User Guide_:
|
want this for the _WSJT-X User Guide_:
|
||||||
|
|
||||||
* Most packaged applications are installed system-wide, which means standard
|
* Most package applications are installed system-wide, which means standard
|
||||||
pivilaged (non Root / RootSudo) users update their binaries.
|
privileged (non Root / RootSudo) users update their binaries.
|
||||||
* Often times, distro packages are (1) or more revisions behind.
|
* Often times, distro packages are (1) or more revisions behind.
|
||||||
* Updating to the latest stable _AsciiDoc_ version, using Mercurial, is a simple
|
* Updating to the latest stable _AsciiDoc_ version, using Mercurial, is a simple
|
||||||
one line command or simply clone the latest release.
|
one line command.
|
||||||
* Using $HOME makes working on the _WSJT-X User Guide_ portable, such as,
|
* Using $HOME makes working on the _WSJT-X User Guide_ portable, such as,
|
||||||
installing to a USB Key allows testing of your work on virtually any system
|
installing to a USB Key allows testing of your work on virtually any system
|
||||||
which has _Python_ {amp}{amp} _Bash Enviroment_ installed.
|
which has _Python_ {amp}{amp} _Bash Enviroment_ installed.
|
||||||
|
|
||||||
// Several more items pending addition
|
|
||||||
*Further Edit's Pending*
|
|
||||||
|
|
||||||
[[X21]]
|
[[X21]]
|
||||||
=== Windows
|
=== Windows
|
||||||
.WinXP thru Win8
|
.WinXP thru Win8
|
||||||
|
|
||||||
content
|
The preferred method of installing _AsciiDoc_ on Windows is through _Cygwin_.
|
||||||
|
|
||||||
[[X22]]
|
TIP: You can install _Cygwin_ anywhere you like, hard drive, internal, external
|
||||||
=== Linux
|
or to a USB Key.
|
||||||
.Debian, Ubuntu, Mint {amp} Relatives
|
|
||||||
// Rouch Draft, needs verified.
|
|
||||||
|
|
||||||
There are many relatives of Debian {amp} Ubuntu, and most shells are _Bash_. For
|
==== Download the _Cygwin_ Installer
|
||||||
all but the package-manager commands,you shoult be able to _Copy {amp} Paste_
|
* For a 32-bit system, download http://cygwin.com/setup-x86.exe[Setup-x86.exe]
|
||||||
the commands directly into the terminal.
|
* For a 64-bit system, download http://cygwin.com/setup-x86_64.exe[Setup-x86-64.exe]
|
||||||
|
* For additional information, see http://cygwin.com/install.html[Cygwin.com]
|
||||||
|
* Saving the installer to desktop makes updating quick {amp} easy
|
||||||
|
|
||||||
* It's a good idea to always start from a fresh repository list, and to have the
|
==== Running the installer
|
||||||
instll up to date before adding new packages.
|
* Double click the _Cygwin Installer_
|
||||||
|
* Select Install from Internet
|
||||||
[source,bash]
|
* Root Directory: C:\cygwin
|
||||||
-----
|
* Select for All Users
|
||||||
sudo apt-get update && sudo apt-get upgrade
|
* Package Download Directory: C:\cygdownloads
|
||||||
-----
|
* Select Direct Connection
|
||||||
|
* I use ftp://mirrors.kernel.org
|
||||||
* Install Dependencies
|
|
||||||
|
|
||||||
[source,bash]
|
|
||||||
-----
|
|
||||||
# on most distro's, python is already installed
|
|
||||||
sudo apt-get install mercurial source-highlight subversion
|
|
||||||
-----
|
|
||||||
|
|
||||||
* Check Python, hg, Subversion and Source Highlight are installed
|
|
||||||
|
|
||||||
|
==== Cygwin package selection
|
||||||
|
|
||||||
|
At the top left corner of the install GUI, you will find a search box. Enter the
|
||||||
|
package name, then select it from the areas indicated below. Only the primary
|
||||||
|
packages are needed, [red]#not# additional modules.
|
||||||
|
|
||||||
|
* Use *Search Box*:
|
||||||
|
** *python* => Interpreters => Python language interpreter
|
||||||
|
** *mercurical* => Devel => Python based DVCS
|
||||||
|
** *subversion* => Devel => A version control system
|
||||||
|
** *source-highlight* => Text => Syntax highlighting utilities
|
||||||
|
** *openssh* => Net => The OpenSSH server and client programs
|
||||||
|
** *nano* => Editors => Enhanced clone of Pico editor
|
||||||
|
** *ncurses* => Utils => Utilities for terminal handling
|
||||||
|
* Then, next to start installation
|
||||||
|
* At create icons and short-cuts, I select desktop only
|
||||||
|
|
||||||
|
==== Verify package installation
|
||||||
|
|
||||||
|
When _Cygwin_ finishes the installation, you will have a very capable base
|
||||||
|
system to work with. From this point onward, all actions are performed in the
|
||||||
|
_Cygwin Terminal_. To launch a terminal session, simply double click the
|
||||||
|
desktop icon as you would any other Windows application.
|
||||||
|
|
||||||
|
==== Package Verification
|
||||||
[source,bash]
|
[source,bash]
|
||||||
-----
|
-----
|
||||||
|
# one line per action
|
||||||
python -V
|
python -V
|
||||||
hg --version |head -n1
|
hg --version |head -n1
|
||||||
svn --version |head -n1
|
svn --version |head -n1
|
||||||
source-highlight --version |head -n1
|
source-highlight --version |head -n1
|
||||||
-----
|
|
||||||
|
|
||||||
* Should Return:
|
# Your versions may vary slightly
|
||||||
|
|
||||||
[source,bash]
|
|
||||||
-----
|
|
||||||
# your versions may vary slightly
|
|
||||||
Python 2.7.6
|
Python 2.7.6
|
||||||
svn, version 1.7.14
|
svn, version 1.7.14
|
||||||
Mercurial Distributed SCM (version 2.8.2)
|
Mercurial Distributed SCM (version 2.8.2)
|
||||||
GNU Source-highlight 3.1.6
|
GNU Source-highlight 3.1.6
|
||||||
-----
|
-----
|
||||||
|
|
||||||
IMPORTANT: If any package check returns with an error, resolve before
|
CAUTION: If any package check returns with an error, resolve before
|
||||||
continuing !!
|
continuing !!
|
||||||
|
|
||||||
* Check for Previous AsciiDoc Installation
|
==== Configure _Bash Environment_
|
||||||
|
[source,bash]
|
||||||
|
-----
|
||||||
|
# Edit ./.bash_profile, uncomment if statement:
|
||||||
|
nano ./.bash_profile
|
||||||
|
|
||||||
|
# Find and Change too: (remove # sign for all 3 lines)
|
||||||
|
if [ -d "$HOME/bin" ] ; then
|
||||||
|
PATH="$HOME/bin:$PATH"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Ctrl+X to exit, Y to confirm, then Enter to save
|
||||||
|
# Create directories, source .bash_profile, check $PATH:
|
||||||
|
mkdir -p $HOME/bin $HOME/Projects/documentation/wsjtx
|
||||||
|
source ./.bash_profile
|
||||||
|
echo $PATH
|
||||||
|
|
||||||
|
# You should see /home/$USER/bin at the beginning of the string.
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
==== Download and Configure _AsciiDoc_
|
||||||
|
|
||||||
[source,bash]
|
[source,bash]
|
||||||
-----
|
-----
|
||||||
# ckeck if AsciiDoc is already installed:
|
# one action per line
|
||||||
|
cd ~/bin
|
||||||
|
|
||||||
|
# get latest AsciiDoc build
|
||||||
|
hg clone -r 8.6.9 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.9
|
||||||
|
|
||||||
|
# pull updates and upgrade packages
|
||||||
|
cd asciidoc-8.6.9 && hg pull && hg update && hg upgrade && cd ..
|
||||||
|
|
||||||
|
# link binaries to $HOME/bin
|
||||||
|
ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc
|
||||||
|
|
||||||
|
# check AsciiDoc runs properly
|
||||||
|
asciidoc --version
|
||||||
|
|
||||||
|
# Should return: asciidoc 8.6.9
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
==== Test build _WSJT-X User Guide_
|
||||||
|
[source,bash]
|
||||||
|
-----
|
||||||
|
cd ~/Projects/documentation/wsjtx
|
||||||
|
|
||||||
|
# then;
|
||||||
|
|
||||||
|
cd ~/Projects/documentation/wsjtx && ./build-doc.sh toc2
|
||||||
|
-----
|
||||||
|
|
||||||
|
==== Open _WSJT-X User Guide_ in a browser
|
||||||
|
[source,bash]
|
||||||
|
-----
|
||||||
|
# for chromium
|
||||||
|
cygstart chrope wsjtx-main-toc2.html
|
||||||
|
|
||||||
|
# for FireFox
|
||||||
|
cygstart firefox wsjtx-main-toc2.html
|
||||||
|
-----
|
||||||
|
|
||||||
|
[[X22]]
|
||||||
|
=== Linux
|
||||||
|
.Debian, Ubuntu, Mint {amp} Relatives
|
||||||
|
|
||||||
|
There are many relatives of Debian {amp} Ubuntu, and most shells are _Bash_. For
|
||||||
|
all but the package-manager commands, you should be able to _Copy {amp} Paste_
|
||||||
|
directly into the terminal.
|
||||||
|
|
||||||
|
It is a good idea to always start from a fresh repository list, and to have the
|
||||||
|
install up to date before adding new packages.
|
||||||
|
|
||||||
|
==== Install Dependencies
|
||||||
|
[source,bash]
|
||||||
|
-----
|
||||||
|
# For Debian and relatives, update && Upgrade first
|
||||||
|
sudo apt-get update && sudo apt-get upgrade
|
||||||
|
|
||||||
|
# Install Dependencies
|
||||||
|
sudo apt-get install mercurial source-highlight subversion
|
||||||
|
|
||||||
|
# Verify the packages installed properly
|
||||||
|
python -V
|
||||||
|
hg --version |head -n1
|
||||||
|
svn --version |head -n1
|
||||||
|
source-highlight --version |head -n1
|
||||||
|
|
||||||
|
# Your versions may vary slightly
|
||||||
|
Python 2.7.6
|
||||||
|
svn, version 1.7.14
|
||||||
|
Mercurial Distributed SCM (version 2.8.2)
|
||||||
|
GNU Source-highlight 3.1.6
|
||||||
|
-----
|
||||||
|
|
||||||
|
CAUTION: If any package check returns with an error, resolve before
|
||||||
|
continuing !!
|
||||||
|
|
||||||
|
==== Check for Previous AsciiDoc Installation
|
||||||
|
[source,bash]
|
||||||
|
-----
|
||||||
|
# check if AsciiDoc is already installed:
|
||||||
asciidoc --version
|
asciidoc --version
|
||||||
|
|
||||||
# If Bash returns any version, remove it:
|
# If Bash returns any version, remove it:
|
||||||
sudo apt-get purge asciidoc
|
sudo apt-get purge asciidoc
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
* Add Directories and source profiles
|
==== Add Directories and source profile
|
||||||
|
|
||||||
[source,bash]
|
[source,bash]
|
||||||
-----
|
-----
|
||||||
mkdir -p $HOME/bin $HOME/Projects/documentation/wsjtx
|
mkdir -p $HOME/bin $HOME/Projects/documentation/wsjtx
|
||||||
|
|
||||||
source ~/.bashrc && source ~/.profile
|
source ~/.bashrc && source ~/.profile
|
||||||
-----
|
|
||||||
|
|
||||||
* Check $HOME/bin is in your $PATH
|
|
||||||
|
|
||||||
[source,bash]
|
|
||||||
-----
|
|
||||||
echo $PATH
|
echo $PATH
|
||||||
|
|
||||||
#should return something like: /home/$USER/bin:/usr/local/sbin: .. .. ..
|
# should return something like: /home/$USER/bin:/usr/local/sbin: .. .. ..
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
TIP: You may have to log out and back in for the addition to take place.
|
TIP: You may have to log out and back in for the addition to take place.
|
||||||
If need be, add the following to your shell profile, then source or
|
If need be, add the following to your shell profile, then source or
|
||||||
log out / back in:
|
log out / back in:
|
||||||
|
|
||||||
|
==== Add conditional to ~/.bashrc
|
||||||
[source,bash]
|
[source,bash]
|
||||||
-----
|
-----
|
||||||
if [ -d "$HOME/bin" ]
|
if [ -d "$HOME/bin" ]
|
||||||
|
|
@ -167,51 +269,39 @@ then
|
||||||
fi
|
fi
|
||||||
-----
|
-----
|
||||||
|
|
||||||
* Download and Configure _AsciiDoc_ use _Copy {amp} Paste_
|
==== Download and Configure _AsciiDoc_
|
||||||
|
|
||||||
[source,bash]
|
[source,bash]
|
||||||
-----
|
-----
|
||||||
# one action per line
|
# one action per line
|
||||||
cd ~/bin
|
cd ~/bin
|
||||||
|
|
||||||
|
# get latest AsciiDoc build
|
||||||
hg clone -r 8.6.9 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.9
|
hg clone -r 8.6.9 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.9
|
||||||
|
|
||||||
|
# pull updates and upgrade packages
|
||||||
cd asciidoc-8.6.9 && hg pull && hg update && hg upgrade && cd ..
|
cd asciidoc-8.6.9 && hg pull && hg update && hg upgrade && cd ..
|
||||||
|
|
||||||
|
# link binaries to $HOME/bin
|
||||||
ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc
|
ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc
|
||||||
|
|
||||||
|
# check AsciiDoc runs properly
|
||||||
asciidoc --version
|
asciidoc --version
|
||||||
|
|
||||||
# Should return: asciidoc 8.6.9
|
# Should return: asciidoc 8.6.9
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
* Test build _WSJT-X User Guide_
|
==== Test build _WSJT-X User Guide_
|
||||||
|
|
||||||
[source,bash]
|
[source,bash]
|
||||||
-----
|
-----
|
||||||
cd ~/Projects/documentation/wsjtx
|
cd ~/Projects/documentation/wsjtx
|
||||||
-----
|
|
||||||
|
|
||||||
TIP: There are two commands generally used, _svn export_ and _svn checkout_.
|
# then;
|
||||||
_svn export_ does _[red]#not#_ pull history ( the .svn folders ), and you cannot
|
|
||||||
be updated later. _svn checkout_ does pull history and allows you to use _svn up_
|
|
||||||
to bring you local copy to the latest repo level.
|
|
||||||
|
|
||||||
[source,bash]
|
|
||||||
-----
|
|
||||||
svn export svn://svn.berlios.de/wsjt/branches/wsjtx/doc
|
|
||||||
|
|
||||||
# and / or
|
|
||||||
|
|
||||||
svn checkout svn://svn.berlios.de/wsjt/branches/wsjtx/doc
|
|
||||||
|
|
||||||
# then
|
|
||||||
|
|
||||||
cd ~/Projects/documentation/wsjtx && ./build-doc.sh toc2
|
cd ~/Projects/documentation/wsjtx && ./build-doc.sh toc2
|
||||||
-----
|
-----
|
||||||
|
|
||||||
* Now Open wsjtx-main-toc.html
|
==== Open _WSJT-X User Guide_ in a browser
|
||||||
|
|
||||||
[source,bash]
|
[source,bash]
|
||||||
-----
|
-----
|
||||||
# for chromium
|
# for chromium
|
||||||
|
|
@ -221,46 +311,61 @@ chromium-browser wsjtx-main-toc2.html
|
||||||
firefox wsjtx-main-toc2.html
|
firefox wsjtx-main-toc2.html
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
|
||||||
[[X23]]
|
|
||||||
=== OS X
|
=== OS X
|
||||||
.10.8 {amp} 10.9
|
.10.8 {amp} 10.9
|
||||||
|
|
||||||
content
|
content needed
|
||||||
|
|
||||||
[[X3]]
|
== Using the Terminal
|
||||||
== How To Contribute
|
.Tips {amp} Tricks to make things easier
|
||||||
.under contstruction
|
|
||||||
|
|
||||||
content
|
Add content
|
||||||
|
|
||||||
=== Dev List Email
|
=== Alias - Short cuts
|
||||||
.under contstruction
|
|
||||||
|
|
||||||
content
|
add content
|
||||||
|
|
||||||
=== Join {amp} Commit
|
=== Add Some Color
|
||||||
.under contstruction
|
|
||||||
|
|
||||||
content
|
add content
|
||||||
|
|
||||||
=== Submit Patch
|
=== Search Documents
|
||||||
.under contstruction
|
|
||||||
|
|
||||||
content
|
add content
|
||||||
|
|
||||||
=== Yahoo Group Post
|
=== Recursive Replace
|
||||||
.under contstruction
|
|
||||||
|
|
||||||
content
|
add content
|
||||||
|
|
||||||
[[X36]]
|
=== Document Status
|
||||||
=== Text
|
|
||||||
.Under Construction
|
|
||||||
|
|
||||||
content
|
add content
|
||||||
|
|
||||||
|
== SVN Basics
|
||||||
|
.Commonly used svn commands
|
||||||
|
|
||||||
|
Add content
|
||||||
|
|
||||||
|
=== Devel Accounts
|
||||||
|
.Developer and normal users
|
||||||
|
|
||||||
|
add content
|
||||||
|
|
||||||
|
=== Check-In/Out
|
||||||
|
.Commonly used commands
|
||||||
|
|
||||||
|
add content
|
||||||
|
|
||||||
|
=== Using Patches
|
||||||
|
.How to create and apply patches
|
||||||
|
|
||||||
|
add content
|
||||||
|
|
||||||
|
=== Log Usage
|
||||||
|
.How to get the most from svn logs
|
||||||
|
|
||||||
|
add content
|
||||||
|
|
||||||
[[XA1]]
|
|
||||||
== Appendix A: Credits
|
== Appendix A: Credits
|
||||||
.Authors, Editors, Commiters
|
.Authors, Editors, Commiters
|
||||||
If you worked on the documentation, add yourself to the list.
|
If you worked on the documentation, add yourself to the list.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue