[Bf-docboard] Planning

Stefano Selleri bf-docboard@blender.org
Fri, 30 Apr 2004 08:34:56 +0200


This is a multi-part message in MIME format.

------=_NextPart_000_21B5_01C42E8E.03FB4890
Content-Type: text/plain;
	charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable

Hi!

>>The Book was written with 2.30 in mind, updated to 2.31 "since there =
was time"
>>and contains a chapter on new 2.32 features.
=20
>>I don't have any XML of this latter chapter, only an RTF, which I =
might very well share
>>but Im unwilling to add that chapter to the new Doc tree.
=20
>>I'd rather update the other chapters!

>If no one has signed up for this, I'll be happy to convert it. I'm =
converting a bunch of Word >docs at work into XML anyway...
>Just let me know what you need.

Well, since that RTF we're talking of is basically a changelog its value
in the doc is rather minor, I really think its content should be
disseminated throughout the relevant chapter,
much more easy for reader to spot info this way :)

BUT

If you are a conversion expert, I have a question :)

THe Python group is using epydoc for Python API doc, I would like
to include it in the Online doc as an organic part, not as an external =
object.

epydoc traslates to HTML and PDF directly, without passing through
DocBook :(

I found a java DocLet translating HTML to XML so I can take the HTML =
generated
by epydoc and convert it to DocBook BUT:

1 - Result is quite poor

2 - THe resulting XML generates a (poor quality) HTML but does NOT =
generate a PDF
    because LateX capacity are exceeded (sorry)

Hence I'm still in trouble for this.

Ideal thing would be an epydoc -> DocBook converter but any other =
suggestion is welcome :)
=20
Thanx for kind words & offering

Stefano
------=_NextPart_000_21B5_01C42E8E.03FB4890
Content-Type: text/html;
	charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=3DContent-Type content=3D"text/html; =
charset=3Diso-8859-1">
<META content=3D"MSHTML 6.00.2800.1106" name=3DGENERATOR>
<STYLE></STYLE>
</HEAD>
<BODY bgColor=3D#ffffff>
<DIV><FONT face=3DArial size=3D2>Hi!</FONT></DIV><FONT face=3DArial=20
size=3D2></FONT><FONT face=3DArial size=3D2></FONT>
<DIV><BR><FONT face=3Darial size=3D2>&gt;&gt;The Book was written with =
2.30 in mind,=20
updated to 2.31 "since there was time"<BR>&gt;&gt;and contains a chapter =
on new=20
2.32 features.<BR></FONT>&nbsp;<BR><FONT face=3Darial size=3D2>&gt;&gt;I =
don't have=20
any XML of this latter chapter, only an RTF, which I might very well=20
share<BR>&gt;&gt;but Im unwilling to add that chapter to the new Doc=20
tree.<BR></FONT>&nbsp;<BR><FONT face=3Darial size=3D2>&gt;&gt;I'd rather =
update the=20
other chapters!<BR></FONT><BR>&gt;If no one has signed up for this, I'll =
be=20
happy to convert it. I'm converting a bunch of Word &gt;docs at work =
into XML=20
anyway...<BR>&gt;Just let me know what you need.<BR></DIV>
<DIV><FONT face=3DArial size=3D2>Well, since that RTF we're talking of =
is basically=20
a changelog its value</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>in the doc is rather minor, I really =
think its=20
content should be</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>disseminated throughout the relevant=20
chapter,</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>much more easy for reader to spot info =
this way=20
:)</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>BUT</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>If you are&nbsp;a conversion expert, I =
have a=20
question :)</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>THe Python group is using epydoc for =
Python API=20
doc, I would like</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>to include it in the Online doc as an =
organic part,=20
not as an external object.</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>epydoc traslates to HTML and PDF =
directly, without=20
passing through</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>DocBook :(</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>I found a java DocLet translating HTML =
to XML so I=20
can take the HTML generated</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>by epydoc and convert it&nbsp;to =
DocBook=20
BUT:</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>1 - Result is quite poor</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>2 -&nbsp;THe resulting XML generates a =
(poor=20
quality) HTML but does NOT generate a PDF</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>&nbsp;&nbsp;&nbsp; because LateX =
capacity are=20
exceeded (sorry)</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>Hence I'm still in trouble for =
this.</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>Ideal thing would be an epydoc -&gt; =
DocBook=20
converter but any other suggestion&nbsp;is&nbsp;welcome :)</FONT></DIV>
<DIV>&nbsp;<BR><FONT face=3DArial size=3D2>Thanx for kind words &amp;=20
offering</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>Stefano</FONT></DIV></BODY></HTML>

------=_NextPart_000_21B5_01C42E8E.03FB4890--