Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 20 Nov 1999 10:38:26 +0100
From:      Jeroen Ruigrok/Asmodai <asmodai@wxs.nl>
To:        Nik Clayton <nik@freebsd.org>
Cc:        Poul-Henning Kamp <phk@freebsd.org>, doc@freebsd.org
Subject:   Re: wishlist item: <sys/queue.h> in schematic form
Message-ID:  <19991120103826.A41154@daemon.ninth-circle.org>
In-Reply-To: <19991119193946.A85059@catkin.nothing-going-on.org>
References:  <25692.942762210@critter.freebsd.dk> <19991118081404.C93488@kilt.nothing-going-on.org> <19991118213606.E35248@daemon.ninth-circle.org> <19991119193946.A85059@catkin.nothing-going-on.org>

next in thread | previous in thread | raw e-mail | index | archive | help
-On [19991120 00:00], Nik Clayton (nik@freebsd.org) wrote:
>On Thu, Nov 18, 1999 at 09:36:06PM +0100, Jeroen Ruigrok/Asmodai wrote:
>> >Also, is the Handbook the best place for this?  After reading the comments
>> >in <sys/queue.h>, I would have thought that queue(3) would be more 
>> >appropriate?
>> 
>> I am already working on getting this drawn.  What would be the best
>> format to use for it anyways?  I myself love to use TGif for schematic
>> drawings, but I don't know what's the best for the DocBook usage.
>> 
>> Eivind had the idea that you prefer something like PS for printing and
>> gif/jp[e]g for webpages.  Is this with the 3.1 version of DocBook
>> doable?  AFAIK not.
>
>To be honest, I was just thinking we could get away with ASCII art.

Mayhaps.  But ASCII is limiting in certain aspects as you know.

>I definitely think this should be part of queue(3), which rather limits
>the formatting choices.  This is why I thought Poul could send me a GIF,
>which I can then turn in to an ASCII diagram (it's been ages since I 
>did any, I used to be a dab hand at it in my BBS days).

Heh.  BBS's taught one to be creative with ANSI-codes/ASCII.

>That's not to say that we couldn't have an article about using the queue(3)
>macros, written in DocBook, with pretty pictures, but I'd like to get 
>the core programmer's documentation sorted first.

Sound idea.  And also one of the goals I am working on as well, as you
know by know. ;)  That aalib, could one go from gif to ASCII with it?
Can't remember for sure what it's exact function was.  Time for some
more research. =)

>To answer your question -- I haven't yet tested embedding[1] pictures in our
>documentation so that it appears in the formatted output.  GIF files or
>similar for the web output will certainly work, and I strongly suspect
>(but, as I say, haven't tested) that EPS will be the necessary format 
>for PS and PDF.  We'll probably need BMP for RTF output too.

*nod*

But the thing is, can we specify multiple formats for one and the same
image which the conversion proces automatically picks when going from
DocBook to, say, RTF, PDF or HTML?

>Testing this is high on my list of priorities.  On the 1st of December my
>current contract ends, at which point I get to do all this 9 to 5, instead
>of 7.30 to 11, which will make a big difference.

I am somewhat doing DocBook now from 9 to 5, barring my Cisco and Unix
administrating and programming work, to document our local, national and
global network and all things associated.  But I still have a lot to
play with and test.  Might be interesting to pass ideas back and forth.

-- 
Jeroen Ruigrok van der Werven/Asmodai                  asmodai(at)wxs.nl
The BSD Programmer's Documentation Project <http://home.wxs.nl/~asmodai>;
Network/Security Specialist        BSD: Technical excellence at its best
Quoth the raven, "Nevermore!"


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19991120103826.A41154>