Commit Graph

25 Commits

Author SHA1 Message Date
Joe Taylor
cfffe1dcbe Update the CMakeLists.txt for User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7066 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-09-08 19:15:17 +00:00
Bill Somerville
460cb2c681 Only generate USLetter size PDFs for languages that might need it
Only en-US, fr-CA, es-MX and es-CO use the USLetter paper size.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6646 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-04-24 19:05:03 +00:00
Bill Somerville
188dad0293 User Guide localization
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6341 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2016-01-02 22:30:12 +00:00
Bill Somerville
2595b9c723 Another attempt to get installed locations right
That is, right for all platforms with both local and package installs.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6248 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-12-08 20:39:50 +00:00
Bill Somerville
9a21e77159 Make install locations configuration variables
Locations  of various  components  to be  determined at  configuration
time.   This  allows   various   "Standard"  system   layouts  to   be
accomodated. For example on FreeBSD the manpages are usually installed
in the man directory i.e. /usr/local/man whereas the WSJT-X default is
to install them in share/man i.e. /usr/share/man. By setting the CMake
variable  WSJT_MANPAGE_DESTINATION to  either a  relative or  absolute
path the install location can be set:

  $ cmake -D WSJT_MANPAGE_DESTINATION=. ...

will install the manpages at ${CMAKE_INSTALL_PREFIX}/man

The new configuration variables are:

 WSJT_BIN_DESTINATION
 WSJT_LIB_DESTINATION
 WSJT_SHARE_DESTINATION
 WSJT_DOC_DESTINATION
 WSJT_DATA_DESTINATION
 WSJT_MANPAGE_DESTINATION
 WSJT_PLUGIN_DESTINATION
 WSJT_QT_CONF_DESTINATION

NB: changes to the above may break WSJT-X at present where the install
    locations of files used directly by WSJT-X are moved.

Warning: using absolute  paths for these variables  is not recommended
as files may be installed  in unexpected places, particularly when run
with  root  privileges.  All  relative   paths  with  be  relative  to
CMAKE_INSTALL_PREFIX.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6192 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-26 19:45:10 +00:00
Bill Somerville
2bd71bfd2f Add PDF generation to docs target
Cleaned  up   some  syntax   anomolies  because   of  the   switch  to
asciidoctor. Minor text tweaks to improve PDF pagination. Reduced HTML
master font size to 80% for better web rendering.

Removed references to KVASD from User Guide.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6142 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-21 02:34:20 +00:00
Bill Somerville
3760d89995 Switch to ascidoctor for User Guide generation
Requires Ruby and asciidoctor to be installed.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6131 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-19 00:08:30 +00:00
Joe Taylor
f125c22a72 Many more edits of the User Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6105 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-16 20:13:47 +00:00
Joe Taylor
1870966ada More editing of User Guide. Bring some images up to Version 1.6.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6102 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-16 00:11:40 +00:00
Joe Taylor
2c98233d3a Final (?) additions to WSJT-X User Guide for v1.6.0. Close reading
is now strongly encouraged!  We "go to press" soon!


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6090 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-13 20:26:41 +00:00
Joe Taylor
d228bd69c7 Add Tool Tips for WSPR controls.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6066 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-10 14:19:22 +00:00
Joe Taylor
ca4095153b Add a brief "Support" section to the WSJT-X User Guide. (Section 16.)
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5602 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-06-12 19:52:29 +00:00
Joe Taylor
7d88ac61b2 More additions to User Guide for v1.6.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5480 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-31 15:58:33 +00:00
Joe Taylor
bbde47e847 Starting to update the User Guide to describe features new to v1.6.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5479 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-31 15:29:59 +00:00
Bill Somerville
28da5db930 Added graphic for JTAlert to user guide
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5438 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-28 02:07:15 +00:00
Bill Somerville
d20112fe9d Fix up user guide sources for use in WSJT-X build
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5437 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-28 01:50:34 +00:00
Bill Somerville
9d30bd5511 Clarify that documentation building is optional
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5428 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-27 22:06:59 +00:00
Bill Somerville
376e4d2e70 Add an asciidoc theme so that project specific CSS can be used
The file doc/theme/wsjt.css is the theme  CSS file and it contains the
contents of the  standard asciidoc.css file followed  by WSJT specific
CSS overrides. If required a file  doc/theme/wsjt.js may be added at a
later date.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5369 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-05-12 21:32:18 +00:00
Bill Somerville
1e21ff617a Make CMake variable for asciidoc script less likely to be overridden
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5327 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-29 23:56:48 +00:00
Bill Somerville
f71aa73e9c Ensure that asciidoc configuration file changes trigger doc builds
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5322 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-29 10:25:27 +00:00
Bill Somerville
c0b7afc2f6 Use absolute path for Python interpreter to avoid picking up v3
Because asciidoc  doesn't work with Python  3 we must not  allow it to
run via  a shebang  or Windows  file association,  instead we  now use
find_package()  on Python  and  filter the  version.  This means  that
CMAKE_PREFIX_PATH   can  be   used  to   select  the   correct  Python
installation if there are more than one and one is v3 or newer.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5321 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-29 00:51:52 +00:00
Bill Somerville
cdd088d749 Solve the WSJT-X manual versioning issue
The user guide  is now installed with the product  version in the name
so  serving the  same  file from  the project  web  server will  allow
multiple manual versions to be easily supported.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5320 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-28 22:59:12 +00:00
Bill Somerville
c5b18d0809 Added automatic VERSION attributes to asciidoc generation
Also tring a few minor technical formatting experiments.

Added  common asciidoc  files  to dependencies  so that  modifications
cause rebuilds.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5319 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-28 22:33:32 +00:00
Bill Somerville
3a33bc79f0 Take out invalid custom command output that causes unnecessary rebuilds
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5317 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-28 19:44:23 +00:00
Bill Somerville
c197d216b3 First attempt at adding the WSJT-X user guide to the CMake build
These documentation source files are not  the one true version, just a
copy for testing purposes. DO NOT EDIT THESE FILES.

To use this  on Windows you will need a  working asciidoc installation
and  the  path  to  it  must be  included  in  your  CMAKE_PREFIX_PATH
(probably via a  local CMake tool chain file). At  the time of writing
the official  asciidoc package does  not work on Windows.   The latest
development  master does  however  work,  it can  be  downloaded as  a
snapshot ZIP archive from here:

  https://github.com/asciidoc/asciidoc/archive/master.zip

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5316 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-28 18:37:50 +00:00