Skip to contentSkip to conversation

batmand-howto conversation

B.A.T.M.A.N. Sven Eckelmann 2 participants 5 messages Jan 21, 2009 – Jan 25, 2009

lore
Share & tools
lore
#0 lore raw

Hi,
I could not find any type of "source" (aka batmand-howto.odt in this case) of the batmand-howto written by Wesley Tsai and it seems to be partially outdated. Because of that I decided to do a conversation of the PDF to LaTeX so it can be changed more easily. It is quite rough at the moment, but I hope that their is some kind of interest in it.
Current sources can be found at http://gitorious.org/projects/batmand-howto
and Simon and Marek have write access to mainline.

Best regards,
Sven

#1 lore raw

Hey Sven,

thanks for your work, it'd be nice to keep the howto up to date. We might as well merge the howto with our ongoing documentation [1]. What do you (and the others) think?

Anyway, i'd upload the updated version of the howto as soon as you consider it ready. Just compiled it and it seems quite good from a quick look ... ;)

best regards,
Simon

[1] http://gitorious.org/projects/batman-adv-doc

Quoted 19 lines · Sven Eckelmann

Hi,
I could not find any type of "source" (aka batmand-howto.odt in this case) of the batmand-howto written by Wesley Tsai and it seems to be partially outdated. Because of that I decided to do a conversation of the PDF to LaTeX so it can be changed more easily. It is quite rough at the moment, but I hope that their is some kind of interest in it.
Current sources can be found at http://gitorious.org/projects/batmand-howto
and Simon and Marek have write access to mainline.

Best regards,
Sven

_______________________________________________
B.A.T.M.A.N mailing list
[email protected]
https://lists.open-mesh.net/mm/listinfo/b.a.t.m.a.n

#2 lore raw
Quoted 3 lines · On Friday 23 January 2009 00:10:28 Simon Wunderlich wrote:

thanks for your work, it'd be nice to keep the howto up to date. We might as well merge the howto with our ongoing documentation [1]. What do you (and the others) think?

Hm, sounds interesting, but I see different problems. First thing is the different copyright. You specified GPL2 for the batman(-adv) documentation and Wesley released his stuff as CC-by-nc-sa-3.0. These licenses aren't compatible in the way that you relicense his work under the GPL2 [2], but you can ask him if he relicenses his work.
The second thing is that somebody has to rewrite it into XML Docbook. This isn't that bad but I will definitely not doing anything like that until somebody explained me why you are using a SGML Docbook tool to convert a XML docbook to your target format. When you try it on another distribution than debian etch/lenny you will propably receive an error (try for example one of our public accessible machines at tuc).
And maybe somebody can answer the question what is the right way to do the conversation job? I found different references that their is/was some xsl stylesheet to convert them to pdf but I don't want to fiddle about xsltproc and different xsl paths on each plattform. I tried xmlto some time ago (small shell script which does all the xslt stuff for me), but the output was quite bad and it had problems with the images (hm, reminds me on the fact that the current way the images are handled inside batman-adv-doc is a hack too). The last thing is that the target audience is different. I don't think that mixing the two ideas together. Maybe it works when their would be
* part 1 - batmand - algorithm, implementation, usage, ...
* part 2 - batman-adv, differents in implementation, usage, ... ... or something completely different

Quoted 2 lines

Anyway, i'd upload the updated version of the howto as soon as you consider it ready.

Tell me how something could be ready which describes another object which hasn't reached a final state and probably never will. But I don't intend to change anything in the near future. Everything Wesley did is included, new informations are merged and images are scalable. So proceed further as you wish.

Best regards,
Sven

Quoted 1 line

[1] http://gitorious.org/projects/batman-adv-doc

[2] http://www.gnu.org/philosophy/license-list.html

#3 lore raw

On Friday 23 January 2009 01:26:18 Sven Eckelmann wrote:
[...]

Quoted 5 lines

Hm, sounds interesting, but I see different problems. First thing is the different copyright. You specified GPL2 for the batman(-adv) documentation and Wesley released his stuff as CC-by-nc-sa-3.0. These licenses aren't compatible in the way that you relicense his work under the GPL2 [2], but you can ask him if he relicenses his work.

Ok, I asked him and he agreed.

Quoted 6 lines

The second thing is that somebody has to rewrite it into XML Docbook. This isn't that bad but I will definitely not doing anything like that until somebody explained me why you are using a SGML Docbook tool to convert a XML docbook to your target format. When you try it on another distribution than debian etch/lenny you will propably receive an error (try for example one of our public accessible machines at tuc).

Pushed fix in a clone of your git repo and requested merge.

Quoted 8 lines

And maybe somebody can answer the question what is the right way to do the conversation job? I found different references that their is/was some xsl stylesheet to convert them to pdf but I don't want to fiddle about xsltproc and different xsl paths on each plattform. I tried xmlto some time ago (small shell script which does all the xslt stuff for me), but the output was quite bad and it had problems with the images (hm, reminds me on the fact that the current way the images are handled inside batman-adv-doc is a hack too).

Seems to be better now. xmlto with fo output +fop isn't that bad. Their are problems with images when you try to generate pdf directly but generating ps and then pdf works fine. I read that renderx xep works better, but it is a commercial tool.

Regards,
Sven

#4 lore raw
In reply to Sven Eckelmann
Quoted 4 lines · Sven Eckelmann

Maybe it works when their would be
* part 1 - batmand - algorithm, implementation, usage, ...
* part 2 - batman-adv, differents in implementation, usage, ... ... or something completely different

It is merged now into batman-adv-doc. A little bit more work is still needed...

Best regards,
Sven