[Bf-docboard] Planning

Stefano Selleri bf-docboard@blender.org
Mon, 3 May 2004 14:31:01 +0200


This is a multi-part message in MIME format.

------=_NextPart_000_0686_01C4311B.42172E70
Content-Type: text/plain;
	charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable

Hi!

>While I've done most of my XML work under Linux, I've been doing a lot =
of it  under >Windows lately. As a result I've been looking at a number =
of open source non-cygwin >approaches to generating DocBook. I say =
non-cycgwin only because not everyone wants to >install cygwin just to =
do DocBook. As a result, my PDF generation doesn't go through >LateX.=20

This looks interesting :)

>As you've been incorporating the new manual pages into CVS, I've been =
able to successfully >build HTML versions, both as a single long page, =
and in the chunk style you currently use to >generate the HTML version =
of the manual. I'm still working through some PDF issues, but >they're =
not related to LateX capacities. =20

I had some issues on image naming and format, but now I can build a PDF
on Linux :)



    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.
    =20
    epydoc traslates to HTML and PDF directly, without passing through
    DocBook :(
    =20
    I found a java DocLet translating HTML to XML so I can take the HTML =
generated
    by epydoc and convert it to DocBook BUT:
    =20
    1 - Result is quite poor

  Is the HTML generated by epydoc of poor quality, or is it the result =
of converting the HTML to XML?

The HTML from epydoc is *very* nice, and is online :)

The  HTML obtained from the XML pbtained from the HTML obtained from =
epydoc is not nice...



    2 - THe resulting XML generates a (poor quality) HTML but does NOT =
generate a PDF
        because LateX capacity are exceeded (sorry)
    =20
    Hence I'm still in trouble for this.
    =20
    Ideal thing would be an epydoc -> DocBook converter but any other =
suggestion is welcome :)

>I'll look into this. If I come up with a solution, I'll let you know.

Thanx a lot :)

>BTW, at some point I'll finish writing up the chapter on how to install =
a DocBook >environment under Windows. Originally, this was planned to be =
in an appendix, but maybe it >should go into the new blender3d.org =
section?

It sounds a nice proposal, B@rt is managing blender3d.org sections, but =
I tink it would be usefull in both places

Stefano



    Thanx for kind words & offering
    =20
    Stefano
  - martin=20

------=_NextPart_000_0686_01C4311B.42172E70
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 =
size=3D2></FONT>
<DIV><BR>&gt;While I've done most of my XML work under Linux, I've been =
doing a=20
lot of it&nbsp; under &gt;Windows lately. As a result I've been looking =
at a=20
number of open source non-cygwin &gt;approaches to generating DocBook. I =
say=20
non-cycgwin only because not everyone wants to &gt;install cygwin just =
to do=20
DocBook. As a result, my PDF generation doesn't go through &gt;LateX. =
<BR></DIV>
<DIV><FONT face=3DArial size=3D2>This looks interesting =
:)</FONT></DIV><FONT=20
face=3DArial size=3D2></FONT>
<DIV><BR>&gt;As you've been incorporating the new manual pages into CVS, =
I've=20
been able to successfully &gt;build HTML versions, both as a single long =
page,=20
and in the chunk style you currently use to &gt;generate the HTML =
version of the=20
manual. I'm still working through some PDF issues, but &gt;they're not =
related=20
to LateX capacities.&nbsp; <BR></DIV>
<DIV><FONT face=3DArial size=3D2>I had some issues on image naming and =
format, but=20
now I can build a PDF</FONT></DIV>
<DIV><FONT face=3DArial size=3D2>on Linux :)</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT><BR>&nbsp;</DIV>
<BLOCKQUOTE dir=3Dltr=20
style=3D"PADDING-RIGHT: 0px; PADDING-LEFT: 5px; MARGIN-LEFT: 5px; =
BORDER-LEFT: #000000 2px solid; MARGIN-RIGHT: 0px">
  <BLOCKQUOTE class=3Dcite cite=3D"" type=3D"cite"><FONT face=3DArial=20
    size=3D2></FONT><FONT face=3DArial size=3D2></FONT><BR><FONT =
face=3Darial size=3D2>THe=20
    Python group is using epydoc for Python API doc, I would like<BR>to =
include=20
    it in the Online doc as an organic part, not as an external=20
    object.<BR></FONT>&nbsp;<BR><FONT face=3Darial size=3D2>epydoc =
traslates to HTML=20
    and PDF directly, without passing through<BR>DocBook=20
    :(<BR></FONT>&nbsp;<BR><FONT face=3Darial size=3D2>I found a java =
DocLet=20
    translating HTML to XML so I can take the HTML generated<BR>by =
epydoc and=20
    convert it to DocBook BUT:<BR></FONT>&nbsp;<BR><FONT face=3Darial =
size=3D2>1 -=20
    Result is quite poor</FONT></BLOCKQUOTE>
  <DIV><BR>Is the HTML generated by epydoc of poor quality, or is it the =
result=20
  of converting the HTML to XML?<BR></DIV></BLOCKQUOTE>
<DIV dir=3Dltr><FONT face=3DArial size=3D2>The HTML from epydoc is =
*very* nice, and is=20
online :)</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>The&nbsp; HTML obtained from the XML =
pbtained from=20
the HTML obtained from epydoc is not nice...</FONT></DIV>
<DIV dir=3Dltr><BR></DIV>
<BLOCKQUOTE dir=3Dltr=20
style=3D"PADDING-RIGHT: 0px; PADDING-LEFT: 5px; MARGIN-LEFT: 5px; =
BORDER-LEFT: #000000 2px solid; MARGIN-RIGHT: 0px">
  <BLOCKQUOTE class=3Dcite cite=3D"" type=3D"cite"><FONT face=3DArial=20
    size=3D2></FONT><FONT face=3DArial size=3D2></FONT><BR><FONT =
face=3Darial size=3D2>2 -=20
    THe resulting XML generates a (poor quality) HTML but does NOT =
generate a=20
    PDF<BR>&nbsp;&nbsp;&nbsp; because LateX capacity are exceeded=20
    (sorry)<BR></FONT>&nbsp;<BR><FONT face=3Darial size=3D2>Hence I'm =
still in=20
    trouble for this.<BR></FONT>&nbsp;<BR><FONT face=3Darial =
size=3D2>Ideal thing=20
    would be an epydoc -&gt; DocBook converter but any other suggestion =
is=20
    welcome :)</FONT></BLOCKQUOTE></BLOCKQUOTE>
<DIV dir=3Dltr><BR>&gt;I'll look into this. If I come up with a =
solution, I'll let=20
you know.<BR></DIV>
<DIV dir=3Dltr><FONT face=3DArial size=3D2>Thanx a lot =
:)</FONT><BR><BR>&gt;BTW, at=20
some point I'll finish writing up the chapter on how to install a =
DocBook=20
&gt;environment under Windows. Originally, this was planned to be in an=20
appendix, but maybe it &gt;should go into the new blender3d.org =
section?</DIV>
<DIV dir=3Dltr><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV dir=3Dltr><FONT face=3DArial size=3D2>It sounds a nice proposal, <A =

href=3D"mailto:B@rt">B@rt</A> is managing <FONT face=3D"Times New Roman" =

size=3D3>blender3d.org sections, but I tink it would be usefull in both=20
places</FONT></FONT></DIV>
<DIV dir=3Dltr>&nbsp;</DIV>
<DIV dir=3Dltr><FONT face=3DArial size=3D2>Stefano</FONT><BR><BR></DIV>
<BLOCKQUOTE dir=3Dltr=20
style=3D"PADDING-RIGHT: 0px; PADDING-LEFT: 5px; MARGIN-LEFT: 5px; =
BORDER-LEFT: #000000 2px solid; MARGIN-RIGHT: 0px">
  <BLOCKQUOTE class=3Dcite cite=3D"" type=3D"cite"><BR><FONT =
face=3Darial size=3D2>Thanx=20
    for kind words &amp; offering<BR></FONT>&nbsp;<BR><FONT face=3Darial =

    size=3D2>Stefano</BLOCKQUOTE><X-SIGSEP>
  <P></X-SIGSEP>- martin</FONT> </P></BLOCKQUOTE></BODY></HTML>

------=_NextPart_000_0686_01C4311B.42172E70--