Koha Manual in Git

[nengard]

I have some awesome news.  As you know I'm working with both ByWater
and BibLibre.  Well thanks to BibLibre, we now have a git repo for the
Koha 3.2 Manual:
http://git.biblibre.com/cgi-bin/gitweb.cgi?p=kohadocs;a=summary -- and
I'm working on converting everything (and updating everything) over to
DocBook so that it will be much easier for translation and publishing
in multiple outlets.

What you'll see in the repo so far is a few images and the start of
the docbook file.  I am working on it daily to try and get all of the
content over.  You'll probably see me asking questions so that I can
improve on what was written so far - and fill in gaps.  Any help you
can give is greatly appreciated!!

Thank to BibLibre (and specifically Henri-Damien) for helping get this
up and running so that I can easily share my work with you all.

Thanks
Nicole C. Engard
Documentation Manager
_______________________________________________
Koha-devel mailing list
Koha-devel@...
http://lists.koha.org/mailman/listinfo/koha-devel

[Frederic Demians]

Why are you using directly DocBook format which is a nightmare to deal
with, editing, transforming? when you could use as lightweight markup
language like asciidoc?

  http://www.methods.co.nz/asciidoc/

asciidoc files can be translated to HTML and DocBook (and then PDF).
asciidoc source files can very easily be tracked  with git. Indeed git
documentation is edited with asciidoc.

Thanks for the good work by the way :-)
--
Frédéric DEMIANS
http://www.tamil.fr/u/fdemians.html
_______________________________________________
Koha-devel mailing list
Koha-devel@...
http://lists.koha.org/mailman/listinfo/koha-devel

[Chris Nighswonger]

On Mon, Oct 19, 2009 at 9:08 AM, Nicole Engard <nengard@...> wrote:

I have some awesome news.  As you know I'm working with both ByWater
and BibLibre.  Well thanks to BibLibre, we now have a git repo for the
Koha 3.2 Manual:
http://git.biblibre.com/cgi-bin/gitweb.cgi?p=kohadocs;a=summary -- and
I'm working on converting everything (and updating everything) over to
DocBook so that it will be much easier for translation and publishing
in multiple outlets.

This is great news Nicole. Thanks for the continued good work!

BibLibre++ && ByWater++  #for open community contributions

Kind Regards,
Chris

_______________________________________________
Koha-devel mailing list
Koha-devel@...
http://lists.koha.org/mailman/listinfo/koha-devel

[nengard]

Because that was what was asked of me by those who work in other
languages :) No clue why I'm using it - I just do whatever I have to
to make things accessible to all.

Nicole

On Mon, Oct 19, 2009 at 9:35 AM, Frederic Demians <frederic@...> wrote:

> Why are you using directly DocBook format which is a nightmare to deal with,
> editing, transforming? when you could use as lightweight markup language
> like asciidoc?
>
>  http://www.methods.co.nz/asciidoc/
>
> asciidoc files can be translated to HTML and DocBook (and then PDF).
> asciidoc source files can very easily be tracked  with git. Indeed git
> documentation is edited with asciidoc.
>
> Thanks for the good work by the way :-)
> --
> Frédéric DEMIANS
> http://www.tamil.fr/u/fdemians.html
>

_______________________________________________
Koha-devel mailing list
Koha-devel@...
http://lists.koha.org/mailman/listinfo/koha-devel

[Frederic Demians]

> Because that was what was asked of me by those who work in other
> languages :) No clue why I'm using it - I just do whatever I have to
> to make things accessible to all.

Speaking accessibility... This documentation:

    http://progit.org/book/

is written with asciidoc. An html version is generated (the above link).
But a PDF version can also be created from the same source files.

The source files are managed/versioned with git, and translations are
done from the English authoritative version:

    http://github.com/progit/progit

So it seems very possible to maintain a multilingual documentation with
this technique.

Now, it's only time to hope DocBook will do the job for Koha
documentation without too much overhead, even if my experience says me
the contrary.

--
Frédéric

_______________________________________________
Koha-devel mailing list
Koha-devel@...
http://lists.koha.org/mailman/listinfo/koha-devel

[nengard]

I misunderstood the difference between copyright and licensing (as in
the GPL) and for that reason - and the fact that the 3.2 is so
different from 3.0 - I will be re-writing the 3.2 manual from scratch
(which will also force me to review every single section in more
detail).  For right now I'm about to update the version that is in Git
to include LibLime in the copyright tag (since it does include content
from the old 3.0/3.2 manuals).

For the future, I will be the main copyright holder on the manual and
when the Koha Foundation is formed I will sign my copyright over to
the Foundation as I don't think any one company should own the
copyright - instead it should be community owned  (feel free to keep
this email so that you have documentation of my promise).  Other
copyright holders will be ByWater Solutions and BibLibre and anyone
else who helps me write bits - or contributes their documentation for
me to include in the manual.

I hope this is acceptable to all - I think it's the best way to
support the community and the best way to force me to make sure ever
3.2 feature is accurately documented :)

Thanks everyone for your understanding and support so far,
Nicole C. Engard
Koha Documentation Manager


> from Joshua Ferraro <jmf@...>
> to Nicole Engard <nengard@...>
> cc sowash@...
> date Mon, Oct 19, 2009 at 9:27 AM
> subject Re: [Koha] Koha Manual in Git
> mailed-by liblime.com

> Hi Nicole,
> As a reminder, per your employment contract 'Assignment of Inventions'
> clause, any Koha documentation content that you created during your tenure
> at LibLime is Copyright LibLime. With that in mind, be sure to reference the
> copyright holder in the main body for any content you copy over to this Git
> repository and give proper attribution for any derivative works.
> If you need a copy of the agreement you signed we'd be happy to provide you
> with one.
> Regards,
> Josh
>
> On Mon, Oct 19, 2009 at 9:08 AM, Nicole Engard <nengard@...> wrote:
>>
>> I have some awesome news.  As you know I'm working with both ByWater
>> and BibLibre.  Well thanks to BibLibre, we now have a git repo for the
>> Koha 3.2 Manual:
>> http://git.biblibre.com/cgi-bin/gitweb.cgi?p=kohadocs;a=summary -- and
>> I'm working on converting everything (and updating everything) over to
>> DocBook so that it will be much easier for translation and publishing
>> in multiple outlets.
>>
>> What you'll see in the repo so far is a few images and the start of
>> the docbook file.  I am working on it daily to try and get all of the
>> content over.  You'll probably see me asking questions so that I can
>> improve on what was written so far - and fill in gaps.  Any help you
>> can give is greatly appreciated!!
>>
>> Thank to BibLibre (and specifically Henri-Damien) for helping get this
>> up and running so that I can easily share my work with you all.
>>
>> Thanks
>> Nicole C. Engard
>> Documentation Manager
>> _______________________________________________
>> Koha mailing list
>> Koha@...
>> http://lists.katipo.co.nz/mailman/listinfo/koha
>
>
>
> --
> Joshua Ferraro                       SUPPORT FOR OPEN-SOURCE SOFTWARE
> CEO                         migration, training, maintenance, support
> LibLime                                Featuring Koha Open-Source ILS
> jmf@... |Full Demos at http://liblime.com/koha |1(888)KohaILS
>

_______________________________________________
Koha-devel mailing list
Koha-devel@...
http://lists.koha.org/mailman/listinfo/koha-devel

[Chris Cormack-6]

2009/10/20 Nicole Engard <nengard@...>:

> I misunderstood the difference between copyright and licensing (as in
> the GPL) and for that reason - and the fact that the 3.2 is so
> different from 3.0 - I will be re-writing the 3.2 manual from scratch
> (which will also force me to review every single section in more
> detail).  For right now I'm about to update the version that is in Git
> to include LibLime in the copyright tag (since it does include content
> from the old 3.0/3.2 manuals).
>
> For the future, I will be the main copyright holder on the manual and
> when the Koha Foundation is formed I will sign my copyright over to
> the Foundation as I don't think any one company should own the
> copyright - instead it should be community owned  (feel free to keep
> this email so that you have documentation of my promise).  Other
> copyright holders will be ByWater Solutions and BibLibre and anyone
> else who helps me write bits - or contributes their documentation for
> me to include in the manual.
>
> I hope this is acceptable to all - I think it's the best way to
> support the community and the best way to force me to make sure ever
> 3.2 feature is accurately documented :)
>
> Thanks everyone for your understanding and support so far,
> Nicole C. Engard
> Koha Documentation Manager
>

Sounds like a great plan to me,

1/ We get an updated accurate manual
2/ People don't get threatened with Lawyers

A big ++ to all your work on this Nicole, and my thanks to the people
in the community who have made it possible for you to do this

Chris
_______________________________________________
Koha-devel mailing list
Koha-devel@...
http://lists.koha.org/mailman/listinfo/koha-devel