diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index c31066af3..e97b194b7 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,3 +1,9 @@ +set (common_SRCS + common/communication.adoc + common/license.adoc + common/links.adoc + ) + set (UG_SRCS user_guide/acknowledgements.adoc user_guide/install-from-source.adoc @@ -109,18 +115,19 @@ function (html_document) add_custom_command ( OUTPUT ${_doc_file} WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${path} - COMMAND ${ASCIIDOC} ARGS ${args_ASCIIDOC_OPTIONS} -o ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.html ${args_SOURCE} + COMMAND ${ASCIIDOC} ARGS ${args_ASCIIDOC_OPTIONS} --out-file=${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.html ${args_SOURCE} DEPENDS ${args_DEPENDS} COMMENT "Generating ${_doc_file}" ) set (${args_HTML} ${_doc_file} PARENT_SCOPE) endfunction (html_document) +configure_file (wsjtx.conf.in wsjtx.conf) html_document( HTML user_guide SOURCE user_guide/wsjtx-main.adoc - ASCIIDOC_OPTIONS -a data-uri -a toc2 -a max-width=1024px -b xhtml11 - DEPENDS ${UG_SRCS} ${UG_IMGS} + ASCIIDOC_OPTIONS -a data-uri -a toc2 -a max-width=1024px --conf-file=${CMAKE_CURRENT_BINARY_DIR}/wsjtx.conf --backend=xhtml11 + DEPENDS ${common_SRCS} ${UG_SRCS} ${UG_IMGS} ) add_custom_target (docs ALL DEPENDS ${user_guide}) diff --git a/doc/common/links.adoc b/doc/common/links.adoc index 28648119c..1197b42af 100644 --- a/doc/common/links.adoc +++ b/doc/common/links.adoc @@ -37,8 +37,8 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes. :asciidoctor_style: http://asciidoctor.org/docs/asciidoc-writers-guide/#delimited-blocks[AsciiDoctor Styles Guide] :asciidoctor_syntax: http://asciidoctor.org/docs/asciidoc-writers-guide/#delimited-blocks[AsciiDoctor Syntax Guide] :cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[Commons Attribution-ShareAlike 3.0 Unported License] -:debian32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2_i386.deb[wsjtx-1.4.0-rc2_i386.deb] -:debian64: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2_amd64.deb[wsjtx-1.4.0-rc2_amd64.deb] +:debian32: http://physics.princeton.edu/pulsar/K1JT/wsjtx_{VERSION}_i386.deb[wsjtx_{VERSION}_i386.deb] +:debian64: http://physics.princeton.edu/pulsar/K1JT/wsjtx_{VERSION}_amd64.deb[wsjtx_{VERSION}_amd64.deb] :debian: http://www.debian.org/[Debian] :dev_guide: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjt-dev-guide.html[Dev-Guide] :devsvn1: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[Devel-SVN] @@ -47,8 +47,8 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes. :download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[Download Page] :dxatlas: http://www.dxatlas.com/[Afreet Software, Inc.] :dxlcommander: http://www.dxlabsuite.com/commander/[ Commander ] -:fedora32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2_i686.rpm[wsjtx-1.4.0-rc2_i686.rpm] -:fedora64: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2_x86_64.rpm[wsjtx-1.4.0-rc2_x86_64.rpm] +:fedora32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-{VERSION}-i686.rpm[wsjtx-{VERSION}-i686.rpm] +:fedora64: http://physics.princeton.edu/pulsar/K1JT/wsjtx-{VERSION}-x86_64.rpm[wsjtx-{VERSION}-x86_64.rpm] :fmt_arrl: http://www.arrl.org/frequency-measuring-test[ARRL FMT Info] :fmt_group: https://groups.yahoo.com/neo/groups/FMT-nuts/info[FMT Group] :fmt_k5cm: http://www.k5cm.com/[FMT Event Info] @@ -83,12 +83,10 @@ d). Edit lines as needed. Keeping them in alphabetic order help see dupes. :kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd] :nh6z: http://www.nh6z.net/Amatuer_Radio_Station_NH6Z/Other_Peoples_Software.html[here] :omnirig: http://www.dxatlas.com/OmniRig/Files/OmniRig.zip[Download] -:osx_107: http://physics.princeton.edu/pulsar/K1JT/wsjtx_01feb14.tar.gz[WSJT-X_rc1_10.7.dmg] -:osx_109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_01feb14.tar.gz[WSJT-X_rc1_10.9.dmg] +:osx: http://physics.princeton.edu/pulsar/K1JT/wsjtx-{VERSION}-Darwin.dmg[wsjtx-{VERSION}-Darwin.dmg] :svn: http://subversion.apache.org/packages.html#windows[Subversion] -:win32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2-win32.exe[wsjtx-1.4.0-rc2-win32.exe] +:win32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-{VERSION}-win32.exe[wsjtx-{VERSION}-win32.exe] :wsjt_svn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[here] -:wsjtx_rc2_tag: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/tags/wsjtx-1.4.0-rc2/[Tag: WSJT-X v1.4 RC2] :wspr_code: http://physics.princeton.edu/pulsar/K1JT/WSPRcode.exe[WSPRcode.exe] :wspr_svn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/branches/wspr/[here] diff --git a/doc/user_guide/faq.adoc b/doc/user_guide/faq.adoc index 597a5e89c..a6163f6db 100644 --- a/doc/user_guide/faq.adoc +++ b/doc/user_guide/faq.adoc @@ -29,9 +29,12 @@ Start _WSJT-X_ from a command-prompt window, passing each instance a unique identifier as in the following two-instance example. This procedure will isolate the *Settings* file and the writable file location for each instance of _WSJT-X_. ++ +===== +wsjtx --rig-name=TS2000 - wsjtx --rig-name=TS2000 - wsjtx --rig-name=FT847 +wsjtx --rig-name=FT847 +===== When setting up rig control through _OmniRig_, something goes wrong when I click *Test CAT*. What can I do about it?:: @@ -52,4 +55,6 @@ window at the top of the primary display screen. You can restore menu bars to their traditional locations by typing the following in a command-prompt window: - sudo apt-get remove appmenu-qt5 +===== +sudo apt-get remove appmenu-qt5 +===== diff --git a/doc/user_guide/install-from-source.adoc b/doc/user_guide/install-from-source.adoc index 98834e2a0..466528f20 100644 --- a/doc/user_guide/install-from-source.adoc +++ b/doc/user_guide/install-from-source.adoc @@ -11,13 +11,17 @@ following packages: - fftw3 - MinGW (for Windows only) -Source code for _WSJT-X_ 1.4.0-rc2 can be downloaded with the command: +Source code for _WSJT-X_ v{VERSION} can be downloaded with the command: - svn co svn://svn.code.sf.net/p/wsjt/wsjt/tags/wsjtx-1.4.0-rc2 +===== +svn co svn://svn.code.sf.net/p/wsjt/wsjt/tags/wsjtx-{VERSION} +===== and for the current development branch, - svn co svn://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx +===== +svn co svn://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx +===== If you are interested in contributing to the development and documentation of _WSJT_ and its sister programs, please join the diff --git a/doc/user_guide/install-linux.adoc b/doc/user_guide/install-linux.adoc index 0684ce267..fe9075f0e 100644 --- a/doc/user_guide/install-linux.adoc +++ b/doc/user_guide/install-linux.adoc @@ -2,35 +2,45 @@ * For Debian, Ubuntu, and other Debian-based systems: ** 32-bit: {debian32} -- To install: +sudo dpkg -i wsjtx_1.4.0-rc2_i386.deb+ +- To install: +sudo dpkg -i wsjtx_{VERSION}_i386.deb+ - Uninstall: +sudo dpkg -P wsjtx+ ** 64-bit: {debian64} -- To install: +sudo dpkg -i wsjtx_1.4.0-rc2_amd64.deb+ +- To install: +sudo dpkg -i wsjtx_{VERSION}_amd64.deb+ - Uninstall: +sudo dpkg -P wsjtx+ ** You may also need to execute the following commands in a terminal: ++ +===== +sudo apt-get install libqt5multimediawidgets5 - sudo apt-get install libqt5multimediawidgets5 - sudo apt-get install libfftw3-single3 +sudo apt-get install libfftw3-single3 +===== ** On a 64-bit system also execute: - - sudo apt-get install libgfortran3:i386 ++ +===== +sudo apt-get install libgfortran3:i386 +===== * For Fedora, Red Hat, and other rpm-based systems: ** 32-bit: {fedora32} -- To install: +sudo rpm -i wsjtx-1.4.0-rc2_i686.rpm+ +- To install: +sudo rpm -i wsjtx-{VERSION}-i686.rpm+ - Uninstall: +sudo rpm -e wsjtx+ ** 64-bit: {fedora64} -- To install: +sudo rpm -i wsjtx-1.4.0-rc2_x86_64.rpm+ +- To install: +sudo rpm -i wsjtx-{VERSION}-x86_64.rpm+ - Uninstall: +sudo rpm -e wsjtx+ ** You may also need to execute the following commands in a terminal: ++ +===== +sudo yum install qt5-qtmultimedia - sudo yum install qt5-qtmultimedia - sudo yum install fftw-libs-single +sudo yum install fftw-libs-single +===== ** On a 64-bit system also execute: - - sudo yum install libgfortran.i686 ++ +===== +sudo yum install libgfortran.i686 +===== //// // Move to FAQ section? diff --git a/doc/user_guide/install-mac.adoc b/doc/user_guide/install-mac.adoc index 9f847b3b9..f050d8b01 100644 --- a/doc/user_guide/install-mac.adoc +++ b/doc/user_guide/install-mac.adoc @@ -1,9 +1,8 @@ -// These instructions are up-to-date for WSJT-X v1.4 +// These instructions are up-to-date for WSJT-X v{VERSION} -* OS X 10.7, 10.8: {osx_107} -* OS X 10.9: {osx_109} +* OS X 10.7 and later: {osx} -* After downloading it to your desktopo, double-click on the dmg file +* After downloading it to your desktop, double-click on the dmg file and consult its +ReadMe+ file for important installation notes. * If you have already installed a previous version, you can retain it by diff --git a/doc/user_guide/wsjtx-main.adoc b/doc/user_guide/wsjtx-main.adoc index 9390ed846..b6769972c 100644 --- a/doc/user_guide/wsjtx-main.adoc +++ b/doc/user_guide/wsjtx-main.adoc @@ -2,7 +2,7 @@ // This is a comment line, anything with // is ignored at process time. = WSJT-X User Guide //:Date: October 1, 2014 -:Revision: 1.4 +:Revision: {VERSION} // For web-pages, adding :badges: is ok, but is a security issue for // package building .deb, .rpm, etc as it exposes the IP address and the images // are non-free, so can't be included as part of the Debian package. diff --git a/doc/wsjtx.conf.in b/doc/wsjtx.conf.in new file mode 100644 index 000000000..ae6214f53 --- /dev/null +++ b/doc/wsjtx.conf.in @@ -0,0 +1,7 @@ +# This is an asciidoc configuraiton file which is processed by CMake +# as a configuration file to substitute variables +[attributes] +VERSION_MAJOR=@WSJTX_VERSION_MAJOR@ +VERSION_MINOR=@WSJTX_VERSION_MINOR@ +VERSION_PATCH=@WSJTX_VERSION_PATCH@ +VERSION=@WSJTX_VERSION_MAJOR@.@WSJTX_VERSION_MINOR@.@WSJTX_VERSION_PATCH@