Documentation build processes - Question for Steve Ratcliffe
Hi Steve The process for converting files like {svn}/doc/typ-compiler.txt to mkgmap-rNNNN.zip:doc/typ-compiler.txt are failing. For a while the resultant typ-compiler.txt has been chopped off after 8193 bytes. tuning.txt is zero bytes. The web versions: http://www.mkgmap.org.uk/doc/typ-compiler etc are correct. Also, what are the tools used to build the .txt and html versions of these files. Best wishes Ticker
Hi Ticker
The process for converting files like {svn}/doc/typ-compiler.txt to mkgmap-rNNNN.zip:doc/typ-compiler.txt are failing.
For a while the resultant typ-compiler.txt has been chopped off after 8193 bytes. tuning.txt is zero bytes.
I'm looking into that failure. Running the commands locally gives me a typ-compiler.txt of size 15402 which looks correct, and tuning.txt is ok too.
Also, what are the tools used to build the .txt and html versions of these files.
The documentation is created by running the script: scripts/download/mkdoc To successfully run the script you first need to install asciidoc (https://asciidoc.org/) and fop (https://xmlgraphics.apache.org/fop/). The following python packages are also required: mwtext mkgmap-pygments pygments-xslfo-formatter In case it matters the actual versions in use are: fop 1.1: http://mirror.ox.ac.uk/sites/rsync.apache.org/xmlgraphics/fop/binaries/fop-1... asciidoc is https://asciidoc.googlecode.com/hg/#7c0bc8eacba9 but that url no longer exists. Steve
Thanks Steve is mwtext https://pypi.org/project/mwtext/ ? I've found all the stuff to generate style-manual.pdf Ticker On Mon, 2020-06-22 at 10:10 +0100, Steve Ratcliffe wrote:
Hi Ticker
The process for converting files like {svn}/doc/typ-compiler.txt to mkgmap-rNNNN.zip:doc/typ-compiler.txt are failing.
For a while the resultant typ-compiler.txt has been chopped off after 8193 bytes. tuning.txt is zero bytes.
I'm looking into that failure. Running the commands locally gives me a typ-compiler.txt of size 15402 which looks correct, and tuning.txt is ok too.
Also, what are the tools used to build the .txt and html versions of these files.
The documentation is created by running the script:
scripts/download/mkdoc
To successfully run the script you first need to install asciidoc (https://asciidoc.org/) and fop (https://xmlgraphics.apache.org/fop/) .
The following python packages are also required:
mwtext mkgmap-pygments pygments-xslfo-formatter
In case it matters the actual versions in use are:
fop 1.1: http://mirror.ox.ac.uk/sites/rsync.apache.org/xmlgraphics/fop/binarie s/fop-1.1-bin.tar.gz
asciidoc is https://asciidoc.googlecode.com/hg/#7c0bc8eacba9 bu t that url no longer exists.
Steve _______________________________________________ mkgmap-dev mailing list mkgmap-dev@lists.mkgmap.org.uk http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
On 22/06/2020 11:16, Ticker Berkin wrote:
is mwtext https://pypi.org/project/mwtext/ ?
No it isn't - unfortunately. I did not realize that it was not on pypi and now someone else has grabbed the name. I'm going to call it mwconv instead. That is not the bug though as it is picking up a local copy. The bug has probably existed since Oct 2016. The fix is trivial (not closing the output, as you may have guessed by the fact that the sizes are 4k block sizes) but I need to rename everything. I'll reply again once it is all sorted out. Cheers, Steve
Hi Steve The ./doc/*.txt files now all build correctly into ./dist/doc/ when I do $ ./scripts/download/mkdoc Thanks Ticker On Mon, 2020-06-22 at 13:10 +0100, Steve Ratcliffe wrote:
On 22/06/2020 11:16, Ticker Berkin wrote:
is mwtext https://pypi.org/project/mwtext/ ;?
No it isn't - unfortunately. I did not realize that it was not on pypi and now someone else has grabbed the name. I'm going to call it mwconv instead.
That is not the bug though as it is picking up a local copy.
The bug has probably existed since Oct 2016. The fix is trivial (not closing the output, as you may have guessed by the fact that the sizes are 4k block sizes) but I need to rename everything. I'll reply again once it is all sorted out.
Cheers, Steve _______________________________________________ mkgmap-dev mailing list mkgmap-dev@lists.mkgmap.org.uk http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Hi Ticker Yes, should all be fixed now during the build. Steve
Hi Steve, please commit the last patch from Ticker if you think it ist okay. I have no access to svn for a while. Cioa, Gerd ---- Steve Ratcliffe schrieb ---- Hi Ticker Yes, should all be fixed now during the build. Steve _______________________________________________ mkgmap-dev mailing list mkgmap-dev@lists.mkgmap.org.uk http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Hi Steve One more question on the mkgmap documentation process: What software does the mkgmap server use to display html from the mediaWiki .txt files? For testing changes to options.txt etc it would handy to to run the same thing. Thanks Ticker
Hi Ticker
What software does the mkgmap server use to display html from the mediaWiki .txt files? For testing changes to options.txt etc it would handy to to run the same thing.
It uses the same library, you just need to specify the html output-type option. mwconv -t html typ-compiler.txt [html is the default so there is no need for the -t] If you want to check the exact same look as the website, then you can include the css file from the website by replacing the html header of the result down to the first <h2> with: <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <link rel="stylesheet" type="text/css" href="http://www.mkgmap.org.uk/static/css/bundle.css"> </head> <body> <div id="page"> <div id="maincontent"> <div id="main-inner"> <div id="wiki-page"> The text should now be identical at all browser widths Steve
Thanks Steve, now I don't have to wait for the web release mechanism to check if changes to doc/*.txt look right Ticker
participants (3)
-
Gerd Petermann -
Steve Ratcliffe -
Ticker Berkin