Re: MM doc update

[Mike Hearn]

The problem with ASCII art is that the website uses a proportional font 
so it looks all messed up. I think a good janitorial task would be for 
somebody to install Inkscape and convert the ASCII art diagrams we have 
in the docs to SVG, so they could be rendered to PNGs or something and 
become a part of the developer guide.

What do people think of this? If anybody is reading this and wants to 
help the Wine projcet but doesn't want to/can't write patches, this 
would be a great little job to do.

BTW you can install Inkscape via autopackage (plug plug), using the 
nightly builds from here:

http://navi.cx/~mike/inkscape

thanks -mike

MM doc update

[Eric Pouech]

Mike Hearn a écrit :
> The problem with ASCII art is that the website uses a proportional font 
> so it looks all messed up. 
> which one ? I just checked the MM and the ntdll/kernel sections and they 
> look ok here. looks more a html browser setting issue, rather than a 
> winehq one (unless you don't have fixed fonts installed)
> I think a good janitorial task would be for 
> somebody to install Inkscape and convert the ASCII art diagrams we have 
> in the docs to SVG, so they could be rendered to PNGs or something and 
> become a part of the developer guide.
> IMO, we should be able to build the doc without too many dependencies 
> and also still to be able to generate PS, pdf and even full txt 
> documentation. The real solution would be SVG embedded in DocBook so 
> that it could be rendered into the various output formats.
> But this doesn't seem to be fully ready for prime time (at least last 
> time I checked).

A+

MM doc update

[Mike Hearn]

Eric Pouech wrote:
> which one ? I just checked the MM and the ntdll/kernel sections and they 
> look ok here. looks more a html browser setting issue, rather than a 
> winehq one (unless you don't have fixed fonts installed)

eg, http://winehq.com/site/docs/wine-devel/x2143

it's understandable but looks a bit messy.
> IMO, we should be able to build the doc without too many dependencies 
> and also still to be able to generate PS, pdf and even full txt 
> documentation. The real solution would be SVG embedded in DocBook so 
> that it could be rendered into the various output formats.
> But this doesn't seem to be fully ready for prime time (at least last 
> time I checked).

True, but I think it would be possible to have pre-rendered versions in 
CVS. I know Alexandre doesn't like binaries in the tree but I think PNGs 
generated from the SVG inputs would be OK as they'd hardly ever change. 
Then you could embed the images directly into the DocBook.

thanks -mike

MM doc update

[Francois Gouget]

On Mon, 11 Oct 2004, Mike Hearn wrote:
> Eric Pouech wrote:
> > which one ? I just checked the MM and the ntdll/kernel sections and they 
> > look ok here. looks more a html browser setting issue, rather than a winehq 
> > one (unless you don't have fixed fonts installed)
>
> eg, http://winehq.com/site/docs/wine-devel/x2143
>
> it's understandable but looks a bit messy.

It looks just fine here. The HTML uses <pre class="screen"> which should 
cause your browser to use fixed fonts. If that's not the case then there 
is something wrong with your setup.

-- 
Francois Gouget         fgouget(a)free.fr        http://fgouget.free.fr/
               Linux: Because rebooting is for adding new hardware

MM doc update

[Mike Hearn]

Francois Gouget wrote:
> It looks just fine here. The HTML uses <pre class="screen"> which should 
> cause your browser to use fixed fonts. If that's not the case then there 
> is something wrong with your setup.

OK. I'll investigate. However, the diagrams have always looked wrong to 
me even on a variety of different machines and browsers :(

thanks -mike

MM doc update

[Brian Vincent]

On Thu, 14 Oct 2004 13:45:01 +0100, Mike Hearn <mike(a)navi.cx> wrote:
> OK. I'll investigate. However, the diagrams have always looked wrong to
> me even on a variety of different machines and browsers :(

They look good here with Mozilla on XP and Linux.

With regard to Inkscape and SVG, I think this is an excellent idea
but it's a bit premature.  Looks like Docbook won't support it until
the schemas in version 4.3.  Right now 4.2 seems to be what's 
shipping (at least on my FC test1 Linux box.)

There should be a way to:

1. separate the diagrams into other files
2. create separate SVG and plain fixed-width font ASCII diagrams
3. then based on what autoconf finds for docbook version include
    the appropriate diagram 

This is probably an idea to revisit in about 6 - 9 months.

-Brian