Menu
▾
▴
Re: [wsjt-devel] WSJT-X: User Guide updates for v1.5.0
|
From: KI7MT <ki...@gm...> - 2015-04-28 06:09:23
|
Hello All, I don't know about Mac, but for Windows, we can do away with JTSDK-DOC, install a Full version of Python27 + Asciidoc, and that should do it. I need to test if base64 encoding is available with a full Python27 install on Windows, but I think it is. Linux, is simple to implement. The Cmake scripts should be able to deal with this easily, it's just paths to Python2 and Asciidoc (maybe a toolchain.cmake file item? not sure). For WSPR and WSJT, we can add a small Makefile in the docs directory, building both the HTML docs and Manpages, and it's done. I'm working on this approach for JTSDK Nix now. The biggest change is the location of Icons and Images. For Data-URI builds (single file HTML) the images must be in the same directory (./icons ./images ./main-file.adoc ) as the file being built. This will no doubt cause duplication of a few files (links.adoc xyz.icon etc). With a full Python27 + AsciiDoc, Docs && Manpages can be compiled at build time, Linux and Windows. This should give you the versatility your needing. I think Mac should be OK with this approach also. If you want to go that route, I'll start working on the necessary changes. The Build commands are simple: Example Doc (for 1.5.1 or something): asciidoc -b xhtml11 -a data-uri -a toc2 -o wsjtx-1.5.0.html ./wsjtx-1.5.0.adoc Example Manpage: a2x --doctype manpage --format manpage --no-xmllint wsjtx.1.txt While this sounds like allot, it's really not allot of work to implement. 73's Greg, KI7MT On 04/27/2015 09:49 AM, Bill Somerville wrote: > Hi All, > > that time has arrived again where a general availability (GA) release is > imminent in the form of v1.5.0. I know there has been discussion on how > to handle versions within the documentation but I doubt any real > progress will be made on that front unless we have a way of building the > documentation on every platform including Windows as part of the product > build. That aside, releases do have a local copy of the user guide so > versioning is implicit therefore I don't think there is an urgent need > to sort out documentation builds. > > Here are some suggested user guide updates for v1.5.0: > > Throughout: references to v1.4.0 need to be updated to v1.5.0, > ----------------------------------------------------------------------------------- > > 3.2 Linux: the Linux prerequisite dependencies have changed, > on Debian based systems: > sudo apt-get install libqt5multimedia5-plugins libqt5serialport5 > > if on Ubuntu 15.04 or similar systems shipping with Qt v5.4, the Qt > dependencies are slightly different: > sudo apt-get install libfftw3-single3 libqt5opengl5 > libqt5multimedia5-plugins libqt5serialport5 > > on RPM based systems: > sudo rpm install fftw-libs-single qt5-qtmultimedia qt5-qtserialport > > We should also add a "build from the release source tarball" section for > other *nix systems: > > required tools: autotools, cmake, gcc, g++ (opptionally clang & > clang++), gfortran, libfftw3-dev, qt5 development (v5.2.1 or newer). > > mkdir ~/src > cd ~/src > tar xzf wsjtx-1.5.0.tgz > cd wsjtx-1.5.0 > mkdir build > cd build > cmake .. > cmake --build . > sudo cmake --build . --target install > > For all Linux installation methods we need to add a section on obtaining > and running the KVASD installer. > ----------------------------------------------------------------------------------- > > 4.1 Settings - General: new fields: > "Message generation for type 2 compound callsign holders" we probably > only need to say this option is only relevant to type 2 compound > callsign holders, > > "Monitor returns to last used frequency" hopefully self explanatory, > option is greyed out if no CAT control is selected. > ----------------------------------------------------------------------------------- > > 4.2 Settings - Radio: new behaviour: > The screen shot probably needs updating as with "None" as rig most > fields are now greyed out, > > "Force Control Lines" - this whole group is now checkable, this allows > DTR and RTS to be forced either high or low. > ----------------------------------------------------------------------------------- > > 4.5 Reporting: new fields: > UDP server group controls the name or address and port number of a UDP > server that will receive status updates from WSJT-X. Although no > implementations are yet available, it is expected that cooperating > applications like JTAlertX will take advantage of this to get maximum > information about a running WSJT-X application. > ----------------------------------------------------------------------------------- > > 4.7 Colors: new page. > ----------------------------------------------------------------------------------- > > 6.4 Sample File 2 example: minor changes related to parallel decoding, > "Since the Tx mode was set to *Tx JT65*, signals in that mode were > decoded first. If you had selected *Tx JT9*, JT9 signals would have been > decoded first." is not quite correct on a multi core CPU. Perhaps the > decoded activity screen shot should be with interleaved modes. > ----------------------------------------------------------------------------------- > > 7.3 Type 2 Compound-Callsign Messages: behaviour changes, > This is probably the place to mention that the "Settings->General" > option to change the format of generated messages for type 2 compound > call holders. Also WSJT-X v1.5.0 makes a better attempt to process QSO > with or by a type 2 compound callsign holder by using double-clicks of > decodes. The warning about actually taking notice of the message > content is of course still appropriate. > ----------------------------------------------------------------------------------- > > 7.4 Pre-QSO Checklist: advice, > It is best to not suggest the rig be set to split mode manually, if > WSJT-X can't set split for itself then split mode working is unlikely to > work. > ----------------------------------------------------------------------------------- > > 8.2 Main Window: additional information, > Monitor - if using CAT control; clicking "Monitor" off relinquishes > control of the rig and if "Monitor returns to last used frequency" in > "Settings->General" is selected; clicking "Monitor" back on will return > to the original frequency. > ----------------------------------------------------------------------------------- > > 8.7.1 File Menus: new item, > Now has "Open log directory". > ----------------------------------------------------------------------------------- > > 8.7.7 Help Menu: changes: > Needs a new screen shot of the "Keyboard Shortcuts" window. > ----------------------------------------------------------------------------------- > > 9 ShowDXCC entity and worked before status: query and changes: > I'm not sure why this section is in the "Platform Dependencies" > section as it works everywhere. > > The "Settings->Colors" page needs a mention here. > > 73 > Bill > G4WJS. > > > > ------------------------------------------------------------------------------ > One dashboard for servers and applications across Physical-Virtual-Cloud > Widest out-of-the-box monitoring support with 50+ applications > Performance metrics, stats and reports that give you Actionable Insights > Deep dive visibility with transaction tracing using APM Insight. > http://ad.doubleclick.net/ddm/clk/290420510;117567292;y > > > > _______________________________________________ > wsjt-devel mailing list > wsj...@li... > https://lists.sourceforge.net/lists/listinfo/wsjt-devel > -- ---------------------------------------------------------------- Launchpad....: https://launchpad.net/~ki7mt Ubuntu Hams..: https://launchpad.net/~ubuntu-hams-devel Debian Hams..: https://alioth.debian.org/projects/pkg-hamradio/ JTSDK........: https://sourceforge.net/projects/jtsdk/ OpenPGP......: C177 6630 7115 78FE 9A2B 9F7F 18C0 F6B7 0DA2 F991 |
