docs in a wiki [was Re: making review/bug filing optional

Benton, Kevin kevin.benton at amd.com
Fri Mar 18 20:39:03 UTC 2005


> My biggest problem with documentation in X?HTML/CSS is that when
> printing tables end up looking like crap, getting split in the middle
> of a cell, etc. If CSS[23] addresses this, *and* browsers can support
> it, then perhaps it is worth looking at. But for generating
> documentation that looks good in print and on the screen, the choices
> are really DocBook or LaTeX (the Python documentation set being a
> primary example of the LaTeX aspect.)

I'm very glad to report that isn't an issue in XHTML/CSS if you use
orphans and widows styles. :)  The only real annoyance I've seen with it
(printing) is not being able to control the header and footer that most
browsers put on pages.  That control won't be here till CSS 3 Paged
Media.  I still have to use my own software to create my index and TOC
but that's really not that hard to do.

---
Kevin Benton
Perl/Bugzilla Developer
Advanced Micro Devices
 
The opinions stated in this communication do not necessarily reflect the
view of Advanced Micro Devices and have not been reviewed by management.
This communication may contain sensitive and/or confidential and/or
proprietary information.  Distribution of such information is strictly
prohibited without prior consent of Advanced Micro Devices.  This
communication is for the intended recipient(s) only.  If you have
received this communication in error, please notify the sender, then
destroy any remaining copies of this communication.

> With that said, I like the idea of putting the docs into a Wiki. One
> feature that is nice about the PostgreSQL and MySQL documentation sets
> is that you can view them online with or without user comments: being
> able to include user feedback/clarification directly into the
> documentation can be very useful.
> 
> --
> Tom Emerson                                          Basis Technology
> Corp.
> Software Architect
> http://www.basistech.com
>   "Beware the lollipop of mediocrity: lick it once and you suck
forever"
> -
> To view or change your list settings, click here:
> <http://bugzilla.org/cgi-bin/mj_wwwusr?user=kevin.benton@amd.com>






More information about the developers mailing list