This is the mail archive of the
cygwin-developers
mailing list for the Cygwin project.
Re: Cygwin web pages and HTML-Tidy
On Sat, 17 Jun 2006, Christopher Faylor wrote:
> On Sat, Jun 17, 2006 at 02:48:23PM -0400, Igor Peshansky wrote:
> >Hi,
> >
> >Sorry if this is the wrong list to discuss this, but I didn't want to air
> >this dirty laundry on the main list. If there is a different forum that's
> >more appropriate for this, please let me know.
> >
> >Someone (Lapo?) ran setup.html through HTML-Tidy. Well, first off, that
> >changed the file mode to XHTML (which is a good thing, IMO), but also
> >inlined the content of the <!--#include virtual="cygwin-header.html"-->
> >(which is a bad thing). Unfortunately, leaving the #include in makes for
> >ill-formed XML, since the closing tag of </head> and the opening tag of
> ><body> were both contained in cygwin-header.html. The only thing that
> >went into the header, technically, was the icon link.
> >
> >I also noticed that other HTML files were invalid, since they would close
> >the </head> tag before the #include, so </head> would be closed twice.
> >
> >Here's my proposal for cleaning it up:
> >
> >1) Split out the <link rel="icon"...> from cygwin-header.html and put it
> >in cygwin-icon.html (which will be #include'd separately).
> >
> >2) Add a CSS stylesheet to cygwin-header.html. Move all the body
> >attributes (text and link colors) into the CSS stylesheet. Remove the
> ></head> closing tag and the <body> opening tag from cygwin-header.html.
> >Change the individual documents to close </head> and open <body>, keeping
> >the #include within the <head/> element.
> >
> >3) Remove the <table><tr><td> sequence of opening tags from
> >cygwin-header.html and require that individual documents define a <div>
> >with a particular id. That way, we can add stylesheet information to
> >cygwin-header.html to control all of the documents.
> >
> >4) remove the </td></table> sequence of tags from cygwin-footer.html
> >(leaving it empty). I'd rather not get rid of it altogether, since we may
> >conceivably want a footer in the Cygwin webpages at some point.
> >
> >The above set of changes is pretty invasive, so I wanted to run this by
> >the developers before going on with them. Also, I'll post a patch on
> >cygwin-patches for your review before actually checking stuff in.
>
> I don't really understand the point of these changes other than that the
> file will now be "proper" html. Since the cygwin web site is under the
> control of Corinna and myself, this isn't the type of thing that you can
> just check in, anyway. You definitely will need approval and I, for
> one, am a fan of the "no one is complaining so why fix it" philosophy
> in this case, so I'm not really wild about making invasive changes.
My main complaint is that the #include was inlined into setup.html, so now
whenever cygwin-header.html (or any other file recursively #included in
it) changes, setup.html will not pick up the change (and is larger, to
boot). But it would certainly be cleaner (and likely render better) with
my changes.
Since you didn't complain about the discussion on this list, I'm assuming
it's ok. I'll work on a patch (which will probably not be as complex as I
made it sound, though it will touch a lot of files), and post it on
cygwin-patches when done. We can then decide whether the changes are
invasive enough to reject.
Igor
--
http://cs.nyu.edu/~pechtcha/
|\ _,,,---,,_ pechtcha@cs.nyu.edu | igor@watson.ibm.com
ZZZzz /,`.-'`' -. ;-;;,_ Igor Peshansky, Ph.D. (name changed!)
|,4- ) )-,_. ,\ ( `'-' old name: Igor Pechtchanski
'---''(_/--' `-'\_) fL a.k.a JaguaR-R-R-r-r-r-.-.-. Meow!
"Las! je suis sot... -Mais non, tu ne l'es pas, puisque tu t'en rends compte."
"But no -- you are no fool; you call yourself a fool, there's proof enough in
that!" -- Rostand, "Cyrano de Bergerac"