Re: [Kicad-developers] Fwd: Documentation update
Brian, How did you get po4a to build? I tried everything I could think of (I'm no Perl expert so take that with the appropriate grain of salt) but no luck. I did manage to get the some of the dependencies to build using msys2 but po4a is still giving me grief. I would rather not have to install externally built binary if I don't have to. Thanks, Wayne On 4/17/2015 6:07 PM, Brian Sidebotham wrote: I'm nearly ready for a pull request. I've just committed changes to my repo so that PDF and HTML can be built on Windows and Linux. Both dblatex and FOP are supported for PDF generation on Linux and Windows, however I cannot get the dblatex PDF build to complete on Windows because of a problem with the xlstproc I'm using. Perhaps someone will have better luck than me. Because of that, I've noted in cmake-readme.adoc in my repo that only FOP is suppored under Windows. CMake just does feature checking, not platform checking, so you can give anything that's supported a go. Getting the full dblatex tool chain seutp on Windows is a bit of a pain! Best Regards, Brian. On 14 April 2015 at 00:52, Nick Østergaard oe.n...@gmail.com wrote: Great. Den 13/04/2015 22.57 skrev Brian Sidebotham brian.sidebot...@gmail.com: I sync'd with Marco's repo so that's now reflected in my repo. I just need to do the po update stuff I think and then I'll do a pull request to get the repo's aligned. Best Regards, Brian. On 12 April 2015 at 23:12, Nick Østergaard oe.n...@gmail.com wrote: I have now done this. 2015-04-11 13:48 GMT+02:00 Nick Østergaard oe.n...@gmail.com: So now is a good time to remove the src/markdown and src/rest and move src/asciidoc to src? If so, I can do that now, such that you can pull those changes. 2015-04-11 13:43 GMT+02:00 Brian Sidebotham brian.sidebot...@gmail.com: On 11 April 2015 at 12:32, Brian Sidebotham brian.sidebot...@gmail.com wrote: On 11 April 2015 at 12:11, Nick Østergaard oe.n...@gmail.com wrote: Great. I just looked briefly on the cmake setup. It seems to me like you intend to include a CMakeLists.txt inside each doc dir with the only change being the name or path of the root adoc file. Would it not mere more sense to have a common CMakeLists.txt in the src/asciidoc dir (to be renamed just src when we remove the markdown and rest variants), which searches the folders or is just given an array of root doc files? Things will change, I've just begun the start of adding macros to create pdf and html targets. There's plenty more work to do yet. Certainly there'll be a lot of common code that can be shared through higher level cmake files. The initial plan was to get CvPcb translation and generation complete. Once the repo achieves that, I can pull request it into Marco's repo and then hopefully there'll be plenty of resource to complete the CMake stuff, then Marco's repo will come under the KiCad umbrella. Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Fwd: Documentation update
On 18 April 2015 at 17:36, Wayne Stambaugh stambau...@gmail.com wrote: Brian, How did you get po4a to build? I tried everything I could think of (I'm no Perl expert so take that with the appropriate grain of salt) but no luck. I did manage to get the some of the dependencies to build using msys2 but po4a is still giving me grief. I would rather not have to install externally built binary if I don't have to. Thanks, Wayne Hi Wayne, The trick is not to build po4a because it's not required to be built. So long as po4a is in your path, kicad-doc's FindPO4A will be able to find it and use it. I found the easiest thing to do is not to install po4a as a perl module, but rather just run it with the perl interpreter from source. The only dependency it requires for us to use it is Unicode:GCString; You must install that perl module using cpan or similar. Once that dependency is in place, you can simply run the po4a utilities like so: perl -IC:/path/to/po4a/lib po4a That's what we do in the kicad-doc CMake. In msys2, perhaps you want to do a helper script in /usr/bin or something that as having the po4a source directory in your PATH may seem a bit odd, whereas in Windows the PATH variable is usually just full of this sort of junk! ;) By the way, I too spent a few days trying to get it to build properly on Windows, using various versions of Perl, but with no luck until I had the epiphany of not building it! For dblatex, please see the appropriate notes in https://github.com/BrianSidebotham/kicad-doc/blob/master/cmake-readme.adoc Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Fwd: Documentation update
I'm nearly ready for a pull request. I've just committed changes to my repo so that PDF and HTML can be built on Windows and Linux. Both dblatex and FOP are supported for PDF generation on Linux and Windows, however I cannot get the dblatex PDF build to complete on Windows because of a problem with the xlstproc I'm using. Perhaps someone will have better luck than me. Because of that, I've noted in cmake-readme.adoc in my repo that only FOP is suppored under Windows. CMake just does feature checking, not platform checking, so you can give anything that's supported a go. Getting the full dblatex tool chain seutp on Windows is a bit of a pain! Best Regards, Brian. On 14 April 2015 at 00:52, Nick Østergaard oe.n...@gmail.com wrote: Great. Den 13/04/2015 22.57 skrev Brian Sidebotham brian.sidebot...@gmail.com: I sync'd with Marco's repo so that's now reflected in my repo. I just need to do the po update stuff I think and then I'll do a pull request to get the repo's aligned. Best Regards, Brian. On 12 April 2015 at 23:12, Nick Østergaard oe.n...@gmail.com wrote: I have now done this. 2015-04-11 13:48 GMT+02:00 Nick Østergaard oe.n...@gmail.com: So now is a good time to remove the src/markdown and src/rest and move src/asciidoc to src? If so, I can do that now, such that you can pull those changes. 2015-04-11 13:43 GMT+02:00 Brian Sidebotham brian.sidebot...@gmail.com: On 11 April 2015 at 12:32, Brian Sidebotham brian.sidebot...@gmail.com wrote: On 11 April 2015 at 12:11, Nick Østergaard oe.n...@gmail.com wrote: Great. I just looked briefly on the cmake setup. It seems to me like you intend to include a CMakeLists.txt inside each doc dir with the only change being the name or path of the root adoc file. Would it not mere more sense to have a common CMakeLists.txt in the src/asciidoc dir (to be renamed just src when we remove the markdown and rest variants), which searches the folders or is just given an array of root doc files? Things will change, I've just begun the start of adding macros to create pdf and html targets. There's plenty more work to do yet. Certainly there'll be a lot of common code that can be shared through higher level cmake files. The initial plan was to get CvPcb translation and generation complete. Once the repo achieves that, I can pull request it into Marco's repo and then hopefully there'll be plenty of resource to complete the CMake stuff, then Marco's repo will come under the KiCad umbrella. Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Fwd: Documentation update
On Mon, Apr 13, 2015 at 09:57:55PM +0100, Brian Sidebotham wrote: I sync'd with Marco's repo so that's now reflected in my repo. I just need to do the po update stuff I think and then I'll do a pull request to get the repo's aligned. Trerrific, many thanks! I am studying cmake to be able in the future to help, just in case, but I think that now it is superfluous... -- Marco Ciampa I know a joke about UDP, but you might not get it. ++ | GNU/Linux User #78271 | | FSFE fellow #364 | ++ ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Fwd: Documentation update
I sync'd with Marco's repo so that's now reflected in my repo. I just need to do the po update stuff I think and then I'll do a pull request to get the repo's aligned. Best Regards, Brian. On 12 April 2015 at 23:12, Nick Østergaard oe.n...@gmail.com wrote: I have now done this. 2015-04-11 13:48 GMT+02:00 Nick Østergaard oe.n...@gmail.com: So now is a good time to remove the src/markdown and src/rest and move src/asciidoc to src? If so, I can do that now, such that you can pull those changes. 2015-04-11 13:43 GMT+02:00 Brian Sidebotham brian.sidebot...@gmail.com: On 11 April 2015 at 12:32, Brian Sidebotham brian.sidebot...@gmail.com wrote: On 11 April 2015 at 12:11, Nick Østergaard oe.n...@gmail.com wrote: Great. I just looked briefly on the cmake setup. It seems to me like you intend to include a CMakeLists.txt inside each doc dir with the only change being the name or path of the root adoc file. Would it not mere more sense to have a common CMakeLists.txt in the src/asciidoc dir (to be renamed just src when we remove the markdown and rest variants), which searches the folders or is just given an array of root doc files? Things will change, I've just begun the start of adding macros to create pdf and html targets. There's plenty more work to do yet. Certainly there'll be a lot of common code that can be shared through higher level cmake files. The initial plan was to get CvPcb translation and generation complete. Once the repo achieves that, I can pull request it into Marco's repo and then hopefully there'll be plenty of resource to complete the CMake stuff, then Marco's repo will come under the KiCad umbrella. Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Fwd: Documentation update
Great. Den 13/04/2015 22.57 skrev Brian Sidebotham brian.sidebot...@gmail.com: I sync'd with Marco's repo so that's now reflected in my repo. I just need to do the po update stuff I think and then I'll do a pull request to get the repo's aligned. Best Regards, Brian. On 12 April 2015 at 23:12, Nick Østergaard oe.n...@gmail.com wrote: I have now done this. 2015-04-11 13:48 GMT+02:00 Nick Østergaard oe.n...@gmail.com: So now is a good time to remove the src/markdown and src/rest and move src/asciidoc to src? If so, I can do that now, such that you can pull those changes. 2015-04-11 13:43 GMT+02:00 Brian Sidebotham brian.sidebot...@gmail.com : On 11 April 2015 at 12:32, Brian Sidebotham brian.sidebot...@gmail.com wrote: On 11 April 2015 at 12:11, Nick Østergaard oe.n...@gmail.com wrote: Great. I just looked briefly on the cmake setup. It seems to me like you intend to include a CMakeLists.txt inside each doc dir with the only change being the name or path of the root adoc file. Would it not mere more sense to have a common CMakeLists.txt in the src/asciidoc dir (to be renamed just src when we remove the markdown and rest variants), which searches the folders or is just given an array of root doc files? Things will change, I've just begun the start of adding macros to create pdf and html targets. There's plenty more work to do yet. Certainly there'll be a lot of common code that can be shared through higher level cmake files. The initial plan was to get CvPcb translation and generation complete. Once the repo achieves that, I can pull request it into Marco's repo and then hopefully there'll be plenty of resource to complete the CMake stuff, then Marco's repo will come under the KiCad umbrella. Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Fwd: Documentation update
I have now done this. 2015-04-11 13:48 GMT+02:00 Nick Østergaard oe.n...@gmail.com: So now is a good time to remove the src/markdown and src/rest and move src/asciidoc to src? If so, I can do that now, such that you can pull those changes. 2015-04-11 13:43 GMT+02:00 Brian Sidebotham brian.sidebot...@gmail.com: On 11 April 2015 at 12:32, Brian Sidebotham brian.sidebot...@gmail.com wrote: On 11 April 2015 at 12:11, Nick Østergaard oe.n...@gmail.com wrote: Great. I just looked briefly on the cmake setup. It seems to me like you intend to include a CMakeLists.txt inside each doc dir with the only change being the name or path of the root adoc file. Would it not mere more sense to have a common CMakeLists.txt in the src/asciidoc dir (to be renamed just src when we remove the markdown and rest variants), which searches the folders or is just given an array of root doc files? Things will change, I've just begun the start of adding macros to create pdf and html targets. There's plenty more work to do yet. Certainly there'll be a lot of common code that can be shared through higher level cmake files. The initial plan was to get CvPcb translation and generation complete. Once the repo achieves that, I can pull request it into Marco's repo and then hopefully there'll be plenty of resource to complete the CMake stuff, then Marco's repo will come under the KiCad umbrella. Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
[Kicad-developers] Fwd: Documentation update
Great. I just looked briefly on the cmake setup. It seems to me like you intend to include a CMakeLists.txt inside each doc dir with the only change being the name or path of the root adoc file. Would it not mere more sense to have a common CMakeLists.txt in the src/asciidoc dir (to be renamed just src when we remove the markdown and rest variants), which searches the folders or is just given an array of root doc files? -- Forwarded message -- From: Brian Sidebotham brian.sidebot...@gmail.com Date: 2015-04-11 10:40 GMT+02:00 Subject: Re: [Kicad-developers] Documentation update To: Nick Østergaard oe.n...@gmail.com Cc: Wayne Stambaugh stambau...@gmail.com, KiCad Developers kicad-developers@lists.launchpad.net Thanks Nick, now fixed. Best Regards, Brian. On 11 April 2015 at 08:56, Nick Østergaard oe.n...@gmail.com wrote: 2015-04-11 9:54 GMT+02:00 Nick Østergaard oe.n...@gmail.com: 2015-04-11 1:10 GMT+02:00 Brian Sidebotham brian.sidebot...@gmail.com: On 8 April 2015 at 14:08, Wayne Stambaugh stambau...@gmail.com wrote: On 4/8/2015 4:51 AM, Brian Sidebotham wrote: On 4 April 2015 at 16:23, Wayne Stambaugh stambau...@gmail.com wrote: Now that we are in feature freeze, I need an update on where we stand as far as the asciidoc documentation conversion process is concerned. I did a git pull yesterday and now `make html` fails for a missing po directory. I have a few questions about the current state of the documentation. 1) Is all of the legacy ODT documentation converted to asciidoc? 2) Does all the English language asciidoc build in both html and pdf at least on Linux? 3) Do all of the supported translations build? 4) I didn't see any CMake configuration files yet. Are we making any progress on that front? Hi Wayne, Sorry, I've been really busy doing other stuff, but the CMake stuff is underway: https://github.com/BrianSidebotham/kicad-doc It's still experimental and not fully functional yet, but it can now progress better. Nick has fixed the msys2 KiCad-Winbuilder which was broken for a while and had me stumped! That project is now close to being able to provide decent installers. At the moment it can create the installers, but I think there's still some outstanding work to make the installers complete. Hopefully I'll be able to get the CMake stuff up and running pretty soon. I'll concentrate on Linux and then make sure things work through msys2. PDF generation under msys2 is a pain, but could be possible through either asciidoctor-pdf or else a2x and Apache fop. What development isn't painful on windows? Kudos to the msys2 folks for significantly improving the situation. It's come a long way from all the set up work required to get the old msys/mingw32 system to work. I'll see if I can take a look at your CMake work this weekend. Hi Wayne, I did a few commits tonight and at least under Linux it'll now build the equivalent of the Makefile stuff for CvPcb and package it up, so that includes all languages in both HTML and PDF. Hi Brian I just tried to build the master branch on your fork of the kicad-doc repo. I noticed that it does not build pdf for the english version. See: $ ls src/asciidoc/CvPcb/ -gG totalt 3112 drwxr-xr-x 14320 11 apr 09:45 CMakeFiles -rw-r--r-- 1 2853 11 apr 09:45 cmake_install.cmake -rw-r--r-- 1 74799 11 apr 09:45 CvPcb-en.html -rw-r--r-- 1 31789 11 apr 09:45 CvPcb-fr.adoc -rw-r--r-- 1 74956 11 apr 09:46 CvPcb-fr.html -rw-r--r-- 1 867638 11 apr 09:45 CvPcb-fr.pdf -rw-r--r-- 1 35549 11 apr 09:45 CvPcb-it.adoc -rw-r--r-- 1 79276 11 apr 09:45 CvPcb-it.html -rw-r--r-- 1 993656 11 apr 09:46 CvPcb-it.pdf -rw-r--r-- 1 36179 11 apr 09:45 CvPcb-pl.adoc -rw-r--r-- 1 80319 11 apr 09:45 CvPcb-pl.html -rw-r--r-- 1 874894 11 apr 09:45 CvPcb-pl.pdf drwxr-xr-x 6180 11 apr 09:45 images -rw-r--r-- 1 14120 11 apr 09:45 Makefile Also using the make target directly does not make it appear together with the html. make cvpcb_pdf_en But I notice that there is a ../src/asciidoc/CvPcb/CvPcb.pdf. In case it is not too clear, notice the .., the path is relative to a build folder created with mkdir build; cd build; cmake ..; make ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Fwd: Documentation update
So now is a good time to remove the src/markdown and src/rest and move src/asciidoc to src? If so, I can do that now, such that you can pull those changes. 2015-04-11 13:43 GMT+02:00 Brian Sidebotham brian.sidebot...@gmail.com: On 11 April 2015 at 12:32, Brian Sidebotham brian.sidebot...@gmail.com wrote: On 11 April 2015 at 12:11, Nick Østergaard oe.n...@gmail.com wrote: Great. I just looked briefly on the cmake setup. It seems to me like you intend to include a CMakeLists.txt inside each doc dir with the only change being the name or path of the root adoc file. Would it not mere more sense to have a common CMakeLists.txt in the src/asciidoc dir (to be renamed just src when we remove the markdown and rest variants), which searches the folders or is just given an array of root doc files? Things will change, I've just begun the start of adding macros to create pdf and html targets. There's plenty more work to do yet. Certainly there'll be a lot of common code that can be shared through higher level cmake files. The initial plan was to get CvPcb translation and generation complete. Once the repo achieves that, I can pull request it into Marco's repo and then hopefully there'll be plenty of resource to complete the CMake stuff, then Marco's repo will come under the KiCad umbrella. Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Fwd: Documentation update
On 11 April 2015 at 12:11, Nick Østergaard oe.n...@gmail.com wrote: Great. I just looked briefly on the cmake setup. It seems to me like you intend to include a CMakeLists.txt inside each doc dir with the only change being the name or path of the root adoc file. Would it not mere more sense to have a common CMakeLists.txt in the src/asciidoc dir (to be renamed just src when we remove the markdown and rest variants), which searches the folders or is just given an array of root doc files? Things will change, I've just begun the start of adding macros to create pdf and html targets. There's plenty more work to do yet. Certainly there'll be a lot of common code that can be shared through higher level cmake files. Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Fwd: Documentation update
On 11 April 2015 at 12:32, Brian Sidebotham brian.sidebot...@gmail.com wrote: On 11 April 2015 at 12:11, Nick Østergaard oe.n...@gmail.com wrote: Great. I just looked briefly on the cmake setup. It seems to me like you intend to include a CMakeLists.txt inside each doc dir with the only change being the name or path of the root adoc file. Would it not mere more sense to have a common CMakeLists.txt in the src/asciidoc dir (to be renamed just src when we remove the markdown and rest variants), which searches the folders or is just given an array of root doc files? Things will change, I've just begun the start of adding macros to create pdf and html targets. There's plenty more work to do yet. Certainly there'll be a lot of common code that can be shared through higher level cmake files. The initial plan was to get CvPcb translation and generation complete. Once the repo achieves that, I can pull request it into Marco's repo and then hopefully there'll be plenty of resource to complete the CMake stuff, then Marco's repo will come under the KiCad umbrella. Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
