Re: [Kicad-developers] Documentation update

[Marco Ciampa]

On Wed, Jan 31, 2018 at 06:13:33PM +0100, Carsten Schoenert wrote:
> Hello Marco,
> 
> Am 31.01.18 um 17:34 schrieb Marco Ciampa:
> > Here we are... see attach
> 
> please follow some traditional rules for textiles, markdown isn't
> anything special, and keep the line breaks in such files between 76 and
> 80 characters. Don't just simple write some long lines without any line
> break.
> Otherwise it's horrible to read on today's big screens.

Oh sorry, I'll certanly do next time(patch).

Regards,

-- 


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] Documentation update

[Nick Østergaard]

I merged this patch.

2018-01-31 17:34 GMT+01:00 Marco Ciampa :

> Here we are... see attach
>
> Regards,
>
> --
>
>
> 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
>
>
___
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] Documentation update

[Carsten Schoenert]

Hello Marco,

Am 31.01.18 um 17:34 schrieb Marco Ciampa:
> Here we are... see attach

please follow some traditional rules for textiles, markdown isn't
anything special, and keep the line breaks in such files between 76 and
80 characters. Don't just simple write some long lines without any line
break.
Otherwise it's horrible to read on today's big screens.

-- 
Regards
Carsten Schoenert

___
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] Documentation update

[Marco Ciampa]

Here we are... see attach

Regards,

-- 


Marco Ciampa

I know a joke about UDP, but you might not get it.



 GNU/Linux User #78271
 FSFE fellow #364



>From 7d0f42d41faf579b74f7cc03939188031858cac7 Mon Sep 17 00:00:00 2001
From: Marco Ciampa 
Date: Wed, 31 Jan 2018 17:30:29 +0100
Subject: [PATCH] Added doc team ml reference to the contribute page

---
 content/contribute/docs-team.adoc | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/content/contribute/docs-team.adoc b/content/contribute/docs-team.adoc
index a812162..2b9decc 100644
--- a/content/contribute/docs-team.adoc
+++ b/content/contribute/docs-team.adoc
@@ -11,6 +11,9 @@ The Docs Team works on writing and maintaining documentation. Documentation incl
 
 We are always looking for volunteers who are interested in contributing to the KiCad documentation project.
 
+The first thing to do before anything is to join the link:https://launchpad.net/~kicad-doc-devs[KiCad Documentation Mailing List].
+You can also join the link:/community/irc[IRC channel] if you have questions. Usually, there are multiple KiCad developers/documenters in the channel.
+
 Most of the action takes place on two repositories on GitHub.
 
  - link:https://github.com/KiCad/kicad-doc[Official Documentation]
-- 
2.16.1

___
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] Documentation update

[Marco Ciampa]

On Wed, Jan 31, 2018 at 08:58:06AM -0500, Wayne Stambaugh wrote:
> On 1/31/2018 8:21 AM, Maciej Sumiński wrote:
> > On 01/31/2018 01:03 PM, Marco Ciampa wrote:
> >> On Wed, Jan 31, 2018 at 12:43:34PM +0100, Maciej Sumiński wrote:
> >>> On 01/31/2018 12:35 PM, Marco Ciampa wrote:
>  On Wed, Jan 31, 2018 at 12:16:50PM +0100, Maciej Sumiński wrote:
> > Does anyone currently work on the user documentation updates? I plan to
> > do so, but I would rather avoid work duplication.
> >
> > Regards,
> > Orson
> 
>  Great, if you do it, a big THANK YOU!
>  Docs really need a revise, especially screenshots are obsolete.
> 
>  PS: please do small commits, it will help translators to catch up and
>  enable other people to revise the changes immediatly...
> >>>
> >>> Sure, does one commit per .adoc file sound reasonable? Otherwise I may
> >>> end up with hundreds with descriptions a la "Eeschema: updated right
> >>> toolbar description".
> >>
> >> Sounds reasonable indeed, but feel free to adjust the span of the
> >> modifications to your needs if for example you need to move a piece of
> >> description from a chapter to another.
> >>
> >> Anyway if there are no objections, please go on, and thanks again.
> >>
> >> Another thing: please annouce and discuss this initiative also in the docs 
> >> ml.
> > 
> > Where can I sign up for the docs mailing list? I could not find it anywhere.
> 
> Orson,
> 
> The link[1] is on the main kicad developers website on launchpad.  I
> guess we should add these links to the "Contribute" page of the main
> kicad website.
> 

Good point, I am preparing a patch...

Regards,

-- 


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] Documentation update

[Wayne Stambaugh]

On 1/31/2018 8:21 AM, Maciej Sumiński wrote:
> On 01/31/2018 01:03 PM, Marco Ciampa wrote:
>> On Wed, Jan 31, 2018 at 12:43:34PM +0100, Maciej Sumiński wrote:
>>> On 01/31/2018 12:35 PM, Marco Ciampa wrote:
 On Wed, Jan 31, 2018 at 12:16:50PM +0100, Maciej Sumiński wrote:
> Does anyone currently work on the user documentation updates? I plan to
> do so, but I would rather avoid work duplication.
>
> Regards,
> Orson

 Great, if you do it, a big THANK YOU!
 Docs really need a revise, especially screenshots are obsolete.

 PS: please do small commits, it will help translators to catch up and
 enable other people to revise the changes immediatly...
>>>
>>> Sure, does one commit per .adoc file sound reasonable? Otherwise I may
>>> end up with hundreds with descriptions a la "Eeschema: updated right
>>> toolbar description".
>>
>> Sounds reasonable indeed, but feel free to adjust the span of the
>> modifications to your needs if for example you need to move a piece of
>> description from a chapter to another.
>>
>> Anyway if there are no objections, please go on, and thanks again.
>>
>> Another thing: please annouce and discuss this initiative also in the docs 
>> ml.
> 
> Where can I sign up for the docs mailing list? I could not find it anywhere.

Orson,

The link[1] is on the main kicad developers website on launchpad.  I
guess we should add these links to the "Contribute" page of the main
kicad website.

I am going to add a new section on symbol library management to the
Eeschema documentation and possibly a section on remapping soon but that
shouldn't clash with any of the existing documentation other than the
main page.

Cheers,

Wayne

[1]: https://launchpad.net/~kicad-doc-devs

> 
> Regards,
> Orson
> 
>> TIA
>>
>> Regards,
>>
>> --
>>
>>
>> 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
>>
> 
> 
> 
> 
> ___
> 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] Documentation update

[Maciej Sumiński]

On 01/31/2018 01:03 PM, Marco Ciampa wrote:
> On Wed, Jan 31, 2018 at 12:43:34PM +0100, Maciej Sumiński wrote:
>> On 01/31/2018 12:35 PM, Marco Ciampa wrote:
>>> On Wed, Jan 31, 2018 at 12:16:50PM +0100, Maciej Sumiński wrote:
 Does anyone currently work on the user documentation updates? I plan to
 do so, but I would rather avoid work duplication.

 Regards,
 Orson
>>>
>>> Great, if you do it, a big THANK YOU!
>>> Docs really need a revise, especially screenshots are obsolete.
>>>
>>> PS: please do small commits, it will help translators to catch up and
>>> enable other people to revise the changes immediatly...
>>
>> Sure, does one commit per .adoc file sound reasonable? Otherwise I may
>> end up with hundreds with descriptions a la "Eeschema: updated right
>> toolbar description".
> 
> Sounds reasonable indeed, but feel free to adjust the span of the
> modifications to your needs if for example you need to move a piece of
> description from a chapter to another.
> 
> Anyway if there are no objections, please go on, and thanks again.
> 
> Another thing: please annouce and discuss this initiative also in the docs ml.

Where can I sign up for the docs mailing list? I could not find it anywhere.

Regards,
Orson

> TIA
> 
> Regards,
> 
> --
> 
> 
> 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
> 




signature.asc
Description: OpenPGP digital signature
___
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] Documentation update

[Marco Ciampa]

On Wed, Jan 31, 2018 at 12:43:34PM +0100, Maciej Sumiński wrote:
> On 01/31/2018 12:35 PM, Marco Ciampa wrote:
> > On Wed, Jan 31, 2018 at 12:16:50PM +0100, Maciej Sumiński wrote:
> >> Does anyone currently work on the user documentation updates? I plan to
> >> do so, but I would rather avoid work duplication.
> >>
> >> Regards,
> >> Orson
> > 
> > Great, if you do it, a big THANK YOU!
> > Docs really need a revise, especially screenshots are obsolete.
> > 
> > PS: please do small commits, it will help translators to catch up and
> > enable other people to revise the changes immediatly...
> 
> Sure, does one commit per .adoc file sound reasonable? Otherwise I may
> end up with hundreds with descriptions a la "Eeschema: updated right
> toolbar description".

Sounds reasonable indeed, but feel free to adjust the span of the
modifications to your needs if for example you need to move a piece of
description from a chapter to another.

Anyway if there are no objections, please go on, and thanks again.

Another thing: please annouce and discuss this initiative also in the docs ml.

TIA

Regards,

--


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] Documentation update

[Maciej Sumiński]

On 01/31/2018 12:35 PM, Marco Ciampa wrote:
> On Wed, Jan 31, 2018 at 12:16:50PM +0100, Maciej Sumiński wrote:
>> Does anyone currently work on the user documentation updates? I plan to
>> do so, but I would rather avoid work duplication.
>>
>> Regards,
>> Orson
> 
> Great, if you do it, a big THANK YOU!
> Docs really need a revise, especially screenshots are obsolete.
> 
> PS: please do small commits, it will help translators to catch up and
> enable other people to revise the changes immediatly...

Sure, does one commit per .adoc file sound reasonable? Otherwise I may
end up with hundreds with descriptions a la "Eeschema: updated right
toolbar description".

Regards,
Orson

> TIA
> 
> Regards,
> 
> 
> --
> 
> 
> 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
> 




signature.asc
Description: OpenPGP digital signature
___
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] Documentation update

[Marco Ciampa]

On Wed, Jan 31, 2018 at 12:16:50PM +0100, Maciej Sumiński wrote:
> Does anyone currently work on the user documentation updates? I plan to
> do so, but I would rather avoid work duplication.
> 
> Regards,
> Orson

Great, if you do it, a big THANK YOU!
Docs really need a revise, especially screenshots are obsolete.

PS: please do small commits, it will help translators to catch up and
enable other people to revise the changes immediatly...

TIA

Regards,


--


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] Documentation update.

[Wayne Stambaugh]

We're sneaking up on it.  I prefer the slow steady progression.  Yes,
most folks would love to everything done right now.  All that does is
burn people out so you have these big changes in a short period of time
and then nothing for long periods of time.

On 8/21/2015 9:03 AM, Adam Wolf wrote:
> Everyday things get a little bit better.  Good work team!
> 
> On Aug 21, 2015 8:02 AM, "Wayne Stambaugh"  > wrote:
> 
> Just a heads up for all of our documentation developers.  I've deleted
> the kicad-doc branch from KiCad project on github and sent an invitation
> to Marco so he can transfer the master copy of kicad-doc to the KiCad
> project.  Please do not send any pull requests to Marco's kicad-doc repo
> until after the transfer is complete.  I've set up a new Documentation
> team on the KiCad project for the documentation developers to join.  I
> will send out an announcement once the transfer is complete.  Thank you
> for your patience while Marco and I get this set up.
> 
> Cheers,
> 
> Wayne
> 
> ___
> 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] Documentation update.

[Adam Wolf]

Everyday things get a little bit better.  Good work team!
On Aug 21, 2015 8:02 AM, "Wayne Stambaugh"  wrote:

> Just a heads up for all of our documentation developers.  I've deleted
> the kicad-doc branch from KiCad project on github and sent an invitation
> to Marco so he can transfer the master copy of kicad-doc to the KiCad
> project.  Please do not send any pull requests to Marco's kicad-doc repo
> until after the transfer is complete.  I've set up a new Documentation
> team on the KiCad project for the documentation developers to join.  I
> will send out an announcement once the transfer is complete.  Thank you
> for your patience while Marco and I get this set up.
>
> Cheers,
>
> Wayne
>
> ___
> 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] Documentation update

[Marco Ciampa]

Just tested the output of the Nick CI 

http://ci.kicad-pcb.org/job/kicad-doc-with-cmake/ws/

Very good! Congrats to Brian and to Nick for the quick CI build!

--


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] Documentation update

[Brian Sidebotham]

Thanks Nick, now fixed.

Best Regards,

Brian.

On 11 April 2015 at 08:56, Nick Østergaard  wrote:
> 2015-04-11 9:54 GMT+02:00 Nick Østergaard :
>> 2015-04-11 1:10 GMT+02:00 Brian Sidebotham :
>>> On 8 April 2015 at 14:08, Wayne Stambaugh  wrote:
 On 4/8/2015 4:51 AM, Brian Sidebotham wrote:
> On 4 April 2015 at 16:23, Wayne Stambaugh  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] Documentation update

[Nick Østergaard]

2015-04-11 9:54 GMT+02:00 Nick Østergaard :
> 2015-04-11 1:10 GMT+02:00 Brian Sidebotham :
>> On 8 April 2015 at 14:08, Wayne Stambaugh  wrote:
>>> On 4/8/2015 4:51 AM, Brian Sidebotham wrote:
 On 4 April 2015 at 16:23, Wayne Stambaugh  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] Documentation update

[Nick Østergaard]

2015-04-11 1:10 GMT+02:00 Brian Sidebotham :
> On 8 April 2015 at 14:08, Wayne Stambaugh  wrote:
>> On 4/8/2015 4:51 AM, Brian Sidebotham wrote:
>>> On 4 April 2015 at 16:23, Wayne Stambaugh  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.

___
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] Documentation update

[Brian Sidebotham]

On 8 April 2015 at 14:08, Wayne Stambaugh  wrote:
> On 4/8/2015 4:51 AM, Brian Sidebotham wrote:
>> On 4 April 2015 at 16:23, Wayne Stambaugh  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.

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] Documentation update

[Wayne Stambaugh]

On 4/8/2015 4:51 AM, Brian Sidebotham wrote:
> On 4 April 2015 at 16:23, Wayne Stambaugh  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.

> 
> 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] Documentation update

[Nick Østergaard]

2015-04-08 10:51 GMT+02:00 Brian Sidebotham :
> On 4 April 2015 at 16:23, Wayne Stambaugh  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.

I know the KiCad-Winbuilder is sort of off topic here, but since it
was mentioned; I will need to mention that the installer script still
needs some work. For example I need to figure out how to handle the
KISYSMOD and KISYS3DMOD variables. Currently they are set as from the
build host, which is bad, because those are invalid for others than
the builder. I started another thread regarding that issue.

> 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.
>
> 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] Documentation update

[Brian Sidebotham]

On 4 April 2015 at 16:23, Wayne Stambaugh  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.

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] Documentation update

[Nick Østergaard]

Den 06/04/2015 22.53 skrev "Wayne Stambaugh" :
>
> On 4/6/2015 2:16 PM, jp charras wrote:
> > Le 06/04/2015 19:55, Wayne Stambaugh a écrit :
> >> One other important note.  I just noticed that the legacy odt kicad-doc
> >> repo on launchpad has commits up to 4/5 (yesterday).  All of the doc
> >> devs need to stop using this repo or you changes could get lost.  The
> >> asciidoc documentation is now the official documentation for the
project
> >> so please contribute you doc changes to
> >> https://github.com/ciampix/kicad-doc.  At some point I will make the
> >> lp:kicad-doc repo read only for historical purposes.  There really
> >> should be no more commits to lp:kicad-doc
> >
> > Looks like all recent commits are only related to the GUI translations,
> > not the doc translations.
> >
> > No decision was taken for the GUI translations, so the "legacy kicad-doc
> > repo on launchpad" is the only one repo for these translations (which
> > are not related to asciidoc).
>
> I'm not sure what you mean by GUI translations.  Do you mean the
> translation of document strings to other languages or images in that go
> into the documentation that show translated strings?  I would think in
> either case, they should be updated in the asciidoc documentation.

He meas the po and mo files for the kicad GUI, nothing directly related to
the docs. IMHO the mo files which are compiled from the po fiæes somehpw
does not belong in the repo itself. I mentioned this earlier in a thread I
do not remember.

> >
> >>
> >> On 4/4/2015 11:35 AM, Nick Østergaard wrote:
> >>> 2015-04-04 17:23 GMT+02:00 Wayne Stambaugh :
>  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.
> >>>
> >>> It is because of the way Marco made it with his Makefiles. He made it
> >>> such that there was only one Makefile and then a make.sh from each the
> >>> docs. This is not ideal IMHO, but I hope the CMake stuff will solve
> >>> that.
> >>>
>  1) Is all of the legacy ODT documentation converted to asciidoc?
> >>>
> >>> I hope someone else can answer that.
> >>>
>  2) Does all the English language asciidoc build in both html and
> pdf at least on Linux?
> >>>
> >>> Yes. See http://ci.kicad-pcb.org/job/kicad-doc-testing/
> >>>
> >>> Although this is not use the cmake stuff. Still waiting on that to
get merged.
> >>>
>  3) Do all of the supported translations build?
> >>>
> >>> Yes, so far. See above.
> >>>
>  4) I didn't see any CMake configuration files yet.  Are we making any
> progress on that front?
> >>>
> >>> I think the latest CMake work for the docs are in
> >>> https://github.com/BrianSidebotham/kicad-doc, I have not tried
> >>> building it recently because there has been no announcement on that it
> >>> "should work now".
> >>
> >> I would like to see this ready by stable release time even though it is
> >> not 100% necessary.  I'll take a look at it when I get some time.
> >>
> >>>
>  5) Does anyone know if asciidoc supports including sections?  I would
> like to see the "Managing Footprint Libraries" pulled out of both
> the CvPcb and Pcbnew documentation so they don't have to
constantly
> be kept in sync.  The other reason is that the path configuration
> dialog documentation will be identical for all of the kicad apps
> so it would be nice to only write that once.  If it is possible to
> do this in asciidoc, please create a common/ folder in the repo
> for sections that are common to help reduce maintenance.
> >>>
> >>> This is possible, see the end of:
> >>>
https://raw.githubusercontent.com/ciampix/kicad-doc/master/src/asciidoc/Pcbnew/Pcbnew.adoc
> >>>
> >>> I guess the github interpreter does not support it... but that should
> >>> not matter for us.
> >>>
>  5) Do we have an autobuilder set up for the documentation so that our
> package autobuilders can pull from to provide current
documentation?
> >>>
> >>> Yes, see earlier. This still does not nessesarely depend on the cmake
> >>> stuff, because as it, it builds, and then the pdf's or whatever should
> >>> just be copied to the distribution package.
> >>>
>  6) What else am I missing?
> >>>
> >>> You counted 5 twice :P
> >>>
>  Once I have a handle on this, I would like to create an "official"
repo
>  in github.com/KiCad.  This would only be the contents of the asciidoc
>  folder.  I don't want new users to be confused by the markdown and
rest
>  folders in the current repo.  I will give the appropriate folks the
>  necessary privileges to maintain the new repo so I will need a list
of
>  github users that should have these privileges.  Many thanks to our
doc
>  devs for their efforts.
>

Re: [Kicad-developers] Documentation update

[Wayne Stambaugh]

On 4/6/2015 2:16 PM, jp charras wrote:
> Le 06/04/2015 19:55, Wayne Stambaugh a écrit :
>> One other important note.  I just noticed that the legacy odt kicad-doc
>> repo on launchpad has commits up to 4/5 (yesterday).  All of the doc
>> devs need to stop using this repo or you changes could get lost.  The
>> asciidoc documentation is now the official documentation for the project
>> so please contribute you doc changes to
>> https://github.com/ciampix/kicad-doc.  At some point I will make the
>> lp:kicad-doc repo read only for historical purposes.  There really
>> should be no more commits to lp:kicad-doc
> 
> Looks like all recent commits are only related to the GUI translations,
> not the doc translations.
> 
> No decision was taken for the GUI translations, so the "legacy kicad-doc
> repo on launchpad" is the only one repo for these translations (which
> are not related to asciidoc).

I'm not sure what you mean by GUI translations.  Do you mean the
translation of document strings to other languages or images in that go
into the documentation that show translated strings?  I would think in
either case, they should be updated in the asciidoc documentation.

> 
>>
>> On 4/4/2015 11:35 AM, Nick Østergaard wrote:
>>> 2015-04-04 17:23 GMT+02:00 Wayne Stambaugh :
 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.
>>>
>>> It is because of the way Marco made it with his Makefiles. He made it
>>> such that there was only one Makefile and then a make.sh from each the
>>> docs. This is not ideal IMHO, but I hope the CMake stuff will solve
>>> that.
>>>
 1) Is all of the legacy ODT documentation converted to asciidoc?
>>>
>>> I hope someone else can answer that.
>>>
 2) Does all the English language asciidoc build in both html and
pdf at least on Linux?
>>>
>>> Yes. See http://ci.kicad-pcb.org/job/kicad-doc-testing/
>>>
>>> Although this is not use the cmake stuff. Still waiting on that to get 
>>> merged.
>>>
 3) Do all of the supported translations build?
>>>
>>> Yes, so far. See above.
>>>
 4) I didn't see any CMake configuration files yet.  Are we making any
progress on that front?
>>>
>>> I think the latest CMake work for the docs are in
>>> https://github.com/BrianSidebotham/kicad-doc, I have not tried
>>> building it recently because there has been no announcement on that it
>>> "should work now".
>>
>> I would like to see this ready by stable release time even though it is
>> not 100% necessary.  I'll take a look at it when I get some time.
>>
>>>
 5) Does anyone know if asciidoc supports including sections?  I would
like to see the "Managing Footprint Libraries" pulled out of both
the CvPcb and Pcbnew documentation so they don't have to constantly
be kept in sync.  The other reason is that the path configuration
dialog documentation will be identical for all of the kicad apps
so it would be nice to only write that once.  If it is possible to
do this in asciidoc, please create a common/ folder in the repo
for sections that are common to help reduce maintenance.
>>>
>>> This is possible, see the end of:
>>> https://raw.githubusercontent.com/ciampix/kicad-doc/master/src/asciidoc/Pcbnew/Pcbnew.adoc
>>>
>>> I guess the github interpreter does not support it... but that should
>>> not matter for us.
>>>
 5) Do we have an autobuilder set up for the documentation so that our
package autobuilders can pull from to provide current documentation?
>>>
>>> Yes, see earlier. This still does not nessesarely depend on the cmake
>>> stuff, because as it, it builds, and then the pdf's or whatever should
>>> just be copied to the distribution package.
>>>
 6) What else am I missing?
>>>
>>> You counted 5 twice :P
>>>
 Once I have a handle on this, I would like to create an "official" repo
 in github.com/KiCad.  This would only be the contents of the asciidoc
 folder.  I don't want new users to be confused by the markdown and rest
 folders in the current repo.  I will give the appropriate folks the
 necessary privileges to maintain the new repo so I will need a list of
 github users that should have these privileges.  Many thanks to our doc
 devs for their efforts.
>>>
>>> I think we can move it just now. I would prefer to keep the history of
>>> the current asciidoc folder. If it is not good enough to just delete
>>> the markdown and rest folders and move asciidoc to the root, we can
>>> also use git filter-branch to get a more "clean" repo of the new
>>> documentation.
>>
>> OK.  I'll wait until Marco (or someone eles) cleans out the markdown and
>> rest folders and moves the contents of the asciidoc folder into the src
>> folder.

Re: [Kicad-developers] Documentation update

[jp charras]

Le 06/04/2015 19:55, Wayne Stambaugh a écrit :
> One other important note.  I just noticed that the legacy odt kicad-doc
> repo on launchpad has commits up to 4/5 (yesterday).  All of the doc
> devs need to stop using this repo or you changes could get lost.  The
> asciidoc documentation is now the official documentation for the project
> so please contribute you doc changes to
> https://github.com/ciampix/kicad-doc.  At some point I will make the
> lp:kicad-doc repo read only for historical purposes.  There really
> should be no more commits to lp:kicad-doc

Looks like all recent commits are only related to the GUI translations,
not the doc translations.

No decision was taken for the GUI translations, so the "legacy kicad-doc
repo on launchpad" is the only one repo for these translations (which
are not related to asciidoc).

> 
> On 4/4/2015 11:35 AM, Nick Østergaard wrote:
>> 2015-04-04 17:23 GMT+02:00 Wayne Stambaugh :
>>> 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.
>>
>> It is because of the way Marco made it with his Makefiles. He made it
>> such that there was only one Makefile and then a make.sh from each the
>> docs. This is not ideal IMHO, but I hope the CMake stuff will solve
>> that.
>>
>>> 1) Is all of the legacy ODT documentation converted to asciidoc?
>>
>> I hope someone else can answer that.
>>
>>> 2) Does all the English language asciidoc build in both html and
>>>pdf at least on Linux?
>>
>> Yes. See http://ci.kicad-pcb.org/job/kicad-doc-testing/
>>
>> Although this is not use the cmake stuff. Still waiting on that to get 
>> merged.
>>
>>> 3) Do all of the supported translations build?
>>
>> Yes, so far. See above.
>>
>>> 4) I didn't see any CMake configuration files yet.  Are we making any
>>>progress on that front?
>>
>> I think the latest CMake work for the docs are in
>> https://github.com/BrianSidebotham/kicad-doc, I have not tried
>> building it recently because there has been no announcement on that it
>> "should work now".
> 
> I would like to see this ready by stable release time even though it is
> not 100% necessary.  I'll take a look at it when I get some time.
> 
>>
>>> 5) Does anyone know if asciidoc supports including sections?  I would
>>>like to see the "Managing Footprint Libraries" pulled out of both
>>>the CvPcb and Pcbnew documentation so they don't have to constantly
>>>be kept in sync.  The other reason is that the path configuration
>>>dialog documentation will be identical for all of the kicad apps
>>>so it would be nice to only write that once.  If it is possible to
>>>do this in asciidoc, please create a common/ folder in the repo
>>>for sections that are common to help reduce maintenance.
>>
>> This is possible, see the end of:
>> https://raw.githubusercontent.com/ciampix/kicad-doc/master/src/asciidoc/Pcbnew/Pcbnew.adoc
>>
>> I guess the github interpreter does not support it... but that should
>> not matter for us.
>>
>>> 5) Do we have an autobuilder set up for the documentation so that our
>>>package autobuilders can pull from to provide current documentation?
>>
>> Yes, see earlier. This still does not nessesarely depend on the cmake
>> stuff, because as it, it builds, and then the pdf's or whatever should
>> just be copied to the distribution package.
>>
>>> 6) What else am I missing?
>>
>> You counted 5 twice :P
>>
>>> Once I have a handle on this, I would like to create an "official" repo
>>> in github.com/KiCad.  This would only be the contents of the asciidoc
>>> folder.  I don't want new users to be confused by the markdown and rest
>>> folders in the current repo.  I will give the appropriate folks the
>>> necessary privileges to maintain the new repo so I will need a list of
>>> github users that should have these privileges.  Many thanks to our doc
>>> devs for their efforts.
>>
>> I think we can move it just now. I would prefer to keep the history of
>> the current asciidoc folder. If it is not good enough to just delete
>> the markdown and rest folders and move asciidoc to the root, we can
>> also use git filter-branch to get a more "clean" repo of the new
>> documentation.
> 
> OK.  I'll wait until Marco (or someone eles) cleans out the markdown and
> rest folders and moves the contents of the asciidoc folder into the src
> folder.  I don't want new contributors to be confused by the three
> separate doc types.  This should preserve the history as well.
> 
>>
>> I think Marco should have access at least. I would also like to have
>> access too. I guess those others that are likely interested will call
>> out them selves.
> 
> As of now I have you and Marco with repo maintenance privileges.  I'll
> make an another announcement once the "official" 

Re: [Kicad-developers] Documentation update

[Wayne Stambaugh]

One other important note.  I just noticed that the legacy odt kicad-doc
repo on launchpad has commits up to 4/5 (yesterday).  All of the doc
devs need to stop using this repo or you changes could get lost.  The
asciidoc documentation is now the official documentation for the project
so please contribute you doc changes to
https://github.com/ciampix/kicad-doc.  At some point I will make the
lp:kicad-doc repo read only for historical purposes.  There really
should be no more commits to lp:kicad-doc

On 4/4/2015 11:35 AM, Nick Østergaard wrote:
> 2015-04-04 17:23 GMT+02:00 Wayne Stambaugh :
>> 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.
> 
> It is because of the way Marco made it with his Makefiles. He made it
> such that there was only one Makefile and then a make.sh from each the
> docs. This is not ideal IMHO, but I hope the CMake stuff will solve
> that.
> 
>> 1) Is all of the legacy ODT documentation converted to asciidoc?
> 
> I hope someone else can answer that.
> 
>> 2) Does all the English language asciidoc build in both html and
>>pdf at least on Linux?
> 
> Yes. See http://ci.kicad-pcb.org/job/kicad-doc-testing/
> 
> Although this is not use the cmake stuff. Still waiting on that to get merged.
> 
>> 3) Do all of the supported translations build?
> 
> Yes, so far. See above.
> 
>> 4) I didn't see any CMake configuration files yet.  Are we making any
>>progress on that front?
> 
> I think the latest CMake work for the docs are in
> https://github.com/BrianSidebotham/kicad-doc, I have not tried
> building it recently because there has been no announcement on that it
> "should work now".

I would like to see this ready by stable release time even though it is
not 100% necessary.  I'll take a look at it when I get some time.

> 
>> 5) Does anyone know if asciidoc supports including sections?  I would
>>like to see the "Managing Footprint Libraries" pulled out of both
>>the CvPcb and Pcbnew documentation so they don't have to constantly
>>be kept in sync.  The other reason is that the path configuration
>>dialog documentation will be identical for all of the kicad apps
>>so it would be nice to only write that once.  If it is possible to
>>do this in asciidoc, please create a common/ folder in the repo
>>for sections that are common to help reduce maintenance.
> 
> This is possible, see the end of:
> https://raw.githubusercontent.com/ciampix/kicad-doc/master/src/asciidoc/Pcbnew/Pcbnew.adoc
> 
> I guess the github interpreter does not support it... but that should
> not matter for us.
> 
>> 5) Do we have an autobuilder set up for the documentation so that our
>>package autobuilders can pull from to provide current documentation?
> 
> Yes, see earlier. This still does not nessesarely depend on the cmake
> stuff, because as it, it builds, and then the pdf's or whatever should
> just be copied to the distribution package.
> 
>> 6) What else am I missing?
> 
> You counted 5 twice :P
> 
>> Once I have a handle on this, I would like to create an "official" repo
>> in github.com/KiCad.  This would only be the contents of the asciidoc
>> folder.  I don't want new users to be confused by the markdown and rest
>> folders in the current repo.  I will give the appropriate folks the
>> necessary privileges to maintain the new repo so I will need a list of
>> github users that should have these privileges.  Many thanks to our doc
>> devs for their efforts.
> 
> I think we can move it just now. I would prefer to keep the history of
> the current asciidoc folder. If it is not good enough to just delete
> the markdown and rest folders and move asciidoc to the root, we can
> also use git filter-branch to get a more "clean" repo of the new
> documentation.

OK.  I'll wait until Marco (or someone eles) cleans out the markdown and
rest folders and moves the contents of the asciidoc folder into the src
folder.  I don't want new contributors to be confused by the three
separate doc types.  This should preserve the history as well.

> 
> I think Marco should have access at least. I would also like to have
> access too. I guess those others that are likely interested will call
> out them selves.

As of now I have you and Marco with repo maintenance privileges.  I'll
make an another announcement once the "official" repo is up and running.

> 
>> Cheers,
>>
>> Wayne
> 
> Thank you for finally starting this thread.
> 

___
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] Documentation update

[Nick Østergaard]

2015-04-06 16:54 GMT+02:00 Marco Ciampa :
> I have decided to "open" my documentation repository more, to
> encourage/foster the development of the documentation migration
> effort.
>
> Due to the nature of the CVSs, where every error could be easily
> reversed, that should not come up to any real problem.
>
> Having said this, I have promoted as "collaborator" (having pull right on
> the repo) every people that have contributed in with a patch.

I think you meant push, not pull here. :)

> I think that will improve the trust and collaboration of anyone involved
> in the project.
>
> There are still missing many translators, so I exhort to come and give a
> hand every non-english speaker. The English speakers are also welcome of
> course as revisors of the source documents (missing sections, obsolete
> screenshots, etc.)
>
> Regards,
>
> --
>
>
> 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

___
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] Documentation update

[Marco Ciampa]

I have decided to "open" my documentation repository more, to
encourage/foster the development of the documentation migration
effort.

Due to the nature of the CVSs, where every error could be easily
reversed, that should not come up to any real problem.

Having said this, I have promoted as "collaborator" (having pull right on
the repo) every people that have contributed in with a patch.

I think that will improve the trust and collaboration of anyone involved
in the project.

There are still missing many translators, so I exhort to come and give a
hand every non-english speaker. The English speakers are also welcome of
course as revisors of the source documents (missing sections, obsolete
screenshots, etc.)

Regards,

--


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] Documentation update

[Eldar Khayrullin]

Ok))

04.04.2015 21:54, Marco Ciampa пишет:

Just to make the whole thing clear(er).

The way it is done now, the method used to handle the documents
compilation, permit to separate the Author from the Translator in a way
that the Author can work on the docs freely. The Translator's life is
really easier because the system handle the work-in-progress of authors
signaling just the strings that are changed and letting the Translators
concentrate only on the changed text without having to keep revising the
whole document for every change made on it.

In the example brough of the progit book that mechanism is missing since
they have to translate a _static_ version of a book, not a dynamic one.

This is if I am not totally wrong here... ;-)

--


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


___
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] Documentation update

[Marco Ciampa]

Just to make the whole thing clear(er).

The way it is done now, the method used to handle the documents
compilation, permit to separate the Author from the Translator in a way
that the Author can work on the docs freely. The Translator's life is
really easier because the system handle the work-in-progress of authors
signaling just the strings that are changed and letting the Translators
concentrate only on the changed text without having to keep revising the
whole document for every change made on it.

In the example brough of the progit book that mechanism is missing since
they have to translate a _static_ version of a book, not a dynamic one.

This is if I am not totally wrong here... ;-)

--


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] Documentation update

[Marco Ciampa]

On Sat, Apr 04, 2015 at 08:06:14PM +0300, Eldar Khayrullin wrote:
> Maybe I can mistaken, but I think that need to divide each i18n to
> separate repos on Github in accordance
> them language, for example kicad-doc-ru, kicad-doc-fr and so on.
> Each repo contains two languages one from them
> english. kicad-doc-en main repo contains only english language.
> Other repos pull changes from main repo.

IMHO that is exactly the wrong way to do it, for many reasons.

1) so the english version is duplicated for each language

2) it will be difficult to keep it in sync every "reference" english
   version

> So now, repos have small size (few ethernet traffic),

1) using asciidoc the size of docs is really low,
2) the size of .po files for each language even less.
3) And IMHO the traffic of git sync repo is just for dev and not casual users
=> not a real issue.
4) on github a branch produce no waste of space at all

> easy to separate managing.
> And in life few people who at the same
> time use more than two languages: english and native language.
> 
> Other projects using this policy. See for example https://github.com/progit.

That is a book that once it is written, it does not change, so the
way they handle it does not need to, and actually is, _not_ so smart.

IMHO and I may be wrong, of course. :-)

--


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] Documentation update

[Marco Ciampa]

On Sat, Apr 04, 2015 at 05:35:23PM +0200, Nick Østergaard wrote:
> 2015-04-04 17:23 GMT+02:00 Wayne Stambaugh :
> > 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.
> 
> It is because of the way Marco made it with his Makefiles. He made it
> such that there was only one Makefile and then a make.sh from each the
> docs. This is not ideal IMHO, but I hope the CMake stuff will solve
> that.

I have done this to have just one single Makefile to check/debug.
Sorry I am not a Make expert for sure, nor a real programmer.
I simply did my best.

I decided to study CMake though so I hope it will improve in the
future.

> > 1) Is all of the legacy ODT documentation converted to asciidoc?
> 
> I hope someone else can answer that.

Looking at this page:

http://www.kicad-pcb.org/display/KICAD/KiCad+Documentation

* KiCad Reference Manual.   done
* Eeschema Reference Manual.done
* Cvpcb Reference Manual.   done
* Pcbnew Reference Manual.  done
* Gerbeview Reference Manual.   done
* Getting Started in KiCad. done

* IDF manualdone

* KiCad Scripting Reference Manual or
http://www.kicad-pcb.org/display/KICAD/KiCad+Scripting+Reference+Manual
not converted but I can start converting it into asciidoc in any moment
if you ask me to do it.

and this page

* Python scripting reference or 
http://ci.kicad-pcb.org/job/kicad-doxygen/ws/build/pcbnew/doxygen-python/html/index.html
I see it void...



Check by yourself the subdirs here:

https://github.com/ciampix/kicad-doc/tree/master/src/asciidoc

or the docs build here:

http://ci.kicad-pcb.org/view/KiCad%20docs/job/kicad-doc-testing/ws/src/asciidoc/

Regards,

--


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] Documentation update

[Eldar Khayrullin]

Maybe I can mistaken, but I think that need to divide each i18n to 
separate repos on Github in accordance
them language, for example kicad-doc-ru, kicad-doc-fr and so on. Each 
repo contains two languages one from them
english. kicad-doc-en main repo contains only english language. Other 
repos pull changes from main repo.


So now, repos have small size (few ethernet traffic), easy to separate 
managing. And in life few people who at the same

time use more than two languages: english and native language.

Other projects using this policy. See for example https://github.com/progit.

___
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] Documentation update

[Nick Østergaard]

2015-04-04 17:23 GMT+02:00 Wayne Stambaugh :
> 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.

It is because of the way Marco made it with his Makefiles. He made it
such that there was only one Makefile and then a make.sh from each the
docs. This is not ideal IMHO, but I hope the CMake stuff will solve
that.

> 1) Is all of the legacy ODT documentation converted to asciidoc?

I hope someone else can answer that.

> 2) Does all the English language asciidoc build in both html and
>pdf at least on Linux?

Yes. See http://ci.kicad-pcb.org/job/kicad-doc-testing/

Although this is not use the cmake stuff. Still waiting on that to get merged.

> 3) Do all of the supported translations build?

Yes, so far. See above.

> 4) I didn't see any CMake configuration files yet.  Are we making any
>progress on that front?

I think the latest CMake work for the docs are in
https://github.com/BrianSidebotham/kicad-doc, I have not tried
building it recently because there has been no announcement on that it
"should work now".

> 5) Does anyone know if asciidoc supports including sections?  I would
>like to see the "Managing Footprint Libraries" pulled out of both
>the CvPcb and Pcbnew documentation so they don't have to constantly
>be kept in sync.  The other reason is that the path configuration
>dialog documentation will be identical for all of the kicad apps
>so it would be nice to only write that once.  If it is possible to
>do this in asciidoc, please create a common/ folder in the repo
>for sections that are common to help reduce maintenance.

This is possible, see the end of:
https://raw.githubusercontent.com/ciampix/kicad-doc/master/src/asciidoc/Pcbnew/Pcbnew.adoc

I guess the github interpreter does not support it... but that should
not matter for us.

> 5) Do we have an autobuilder set up for the documentation so that our
>package autobuilders can pull from to provide current documentation?

Yes, see earlier. This still does not nessesarely depend on the cmake
stuff, because as it, it builds, and then the pdf's or whatever should
just be copied to the distribution package.

> 6) What else am I missing?

You counted 5 twice :P

> Once I have a handle on this, I would like to create an "official" repo
> in github.com/KiCad.  This would only be the contents of the asciidoc
> folder.  I don't want new users to be confused by the markdown and rest
> folders in the current repo.  I will give the appropriate folks the
> necessary privileges to maintain the new repo so I will need a list of
> github users that should have these privileges.  Many thanks to our doc
> devs for their efforts.

I think we can move it just now. I would prefer to keep the history of
the current asciidoc folder. If it is not good enough to just delete
the markdown and rest folders and move asciidoc to the root, we can
also use git filter-branch to get a more "clean" repo of the new
documentation.

I think Marco should have access at least. I would also like to have
access too. I guess those others that are likely interested will call
out them selves.

> Cheers,
>
> Wayne

Thank you for finally starting this thread.

___
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