Hello All,

Joe has approved the Ascdictor migration. The plan as it stands:

* WSJT-X v1.6.0: Use AsciiDoc / A2x (Python2 version) as is.
* WSJT-X v1.6.1: Migrate to Asciidoctor

Note: there are still a couple items to get resolved for various
flavours of *Nix. Those items can be worked on for the v1.6.1 release.

*WSPR / WSJT*
- There are no pending releases scheduled, so I'll update the repository
build tools, JTSDK-Win32 and JTSDK-Nix to reflect the changes.

MAP65, WSPRX, misc docs:
These can be transitioned now, or whenever someone has the time. The
same limitations for *Nix flavours applies here as well.


*STYLESHEETS*
- There are a couple things that need be customized, like font sizes and
possibly Section Header colours etc. That can be worked on for the
WSJT-X v1.6.1 release.

- We should create a master *.css file and stick it in the repository
somewhere, then pull that sheet into each document tree as appropriate.

To use a custom stylesheet is rather simple, add the attribute to the
main document header (relative to *-main.adoc file):

:stylesheet: wsjt-master.css

or whatever you want to name it. For ease of implementation, you can add
it to the same directory as the *-main.adoc file. Or use the theme
directory, whichever is easier to manage.

Asciidoctor provides what they call a "Theme Factory" for generating
stylesheets. We can get into this later, but it's very easy to generate
new themes / stylesheets.


73's
Greg, KI7MT


On 11/10/2015 11:40 AM, Bill Somerville wrote:
> On 10/11/2015 18:13, KI7MT wrote:
>> Hi Bill,
> Hi Greg,
>>
>> I've run into a couple snags as well. On 14.04, the repo version of
>> Asciidoctor is v1.4.1. The gem version is v1.5.3.
>>
>> * First snag
>> 1.4.1 does not generate the manpages, where 1.5.3 does, but 1.5.3 does
>> does not like the multiple manpage spawning. e.g. 3 or 4 manpages from
>> one. Asciidoc handled that no problem. I didn't see this at first as I
>> installed via the gem method initially while following their install
>> instructions.
> Yes the .so or multiple manpages from a single source seems to be a 
> complete omission from asciidoc :( That is a bit of a nuisance but I 
> could duplicate the manpages as a brute force fix but see below.
>>
>> * Second snag
>> v1.4.1 does not support LaTeX math ( :stem: latexmath ) or even
>> asciimath. Reading the their release notes, that looks to have been
>> added at the 1.5.x version time frame.
> The stem support is probably not that serious for WSJT-X although I 
> suspect that some formulae may be nice in the appendices as the document 
> matures.
>>
>> Ubuntu 14.04 and 15.04 have v1.4.1 in the repo package
>> Ubuntu 15.10 and 16.05 have 1.5.3
>>
>> * To install the gem, for resting:
>> sudo apt-get remove asciidoctor
>> sudo gem install asciidoctor
>> exec $SHELL -l
>>
>> The last command just refreshes the shell, closing / re-opening would do
>> the same thing.
> That's fine for testing but given that the main manpage requirement is 
> for build hosts we seem to be screwed.
>>
>> I think it's worth the change as well, but, it may be wise to hold off
>> the formal switch until after the v1.6.0 release, unless of course, the
>> repo version in Ubunto gets updated to v1.5, or I can use the Wily
>> packport some how.
> How about we stick with a2x for the manpages for now and switch to 
> asciidoctor for the User Guide, at least that way we can have better 
> book generation until the next LTS Ubuntu release when we can drop 14.04 
> support. By then the asciidoctor manpage back end might be more capable.
>>
>> Everything seems to be working OK on Windows, that's because the Gem
>> version installed was v1.5.3 right out the gate.
> For WSJT-X builds on Windows the manpage generation is not done so there 
> is no show stopper there that I see at present. We do build the manpages 
> on OS X with aa2x but at least there we have the latest asciidoctor 
> available.
>>
>>
>> 73's
>> Greg, KI7MT
> 73
> Bill
> G4WJS.
>>
>>
>> On 11/10/2015 05:13 AM, Bill Somerville wrote:
>>> On 08/11/2015 19:18, Greg Beam wrote:
>>>> you use the same name to build man pages
>>>> also ( asciidoctor -b manpage 12345.1.txt ).
>>> Hi Greg,
>>>
>>> I am doing the necessary changes to use asciidoctor with WSJT-X. It is
>>> not quite as seamless as it should be but the benefits definitely seem
>>> worth the pain.
>>>
>>> I am finding that asciidoctor manpage backend available in the Ubuntu
>>> 14.04 LTS is not working so I don't think using it for manpages is yet
>>> feasible. What version of asciidoctor are you using to get manpage
>>> generation?
>>>
>>> Currently I am holding off committing my changes as I know Joe is busy
>>> doing User Guide updates and I do not want to disrupt that.
>>>
>>> 73
>>> Bill
>>> G4WJS.
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> wsjt-devel mailing list
>> wsjt-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/wsjt-devel
> 
> 
> ------------------------------------------------------------------------------
> _______________________________________________
> wsjt-devel mailing list
> wsjt-devel@lists.sourceforge.net
> 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

------------------------------------------------------------------------------
_______________________________________________
wsjt-devel mailing list
wsjt-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/wsjt-devel

Reply via email to