All right, after about 4 months and a few news updates, I'm satisfied
that my script for regenerating main.html is working satisfactorily, so
I've switched the index.html and contents.html files over to using this,
rather than the main.shtml file. This should help out our mirrors who
don't support SSI.
The next step, as I see it, is to automate updates to dev/htdig-3.2/main.html
the same way. I can see 3 ways of doing this. The main difference between
the maindocs/dev/htdig-3.2 version and the maindocs version, is the latter
has been using the maindocs/css/htdig.css style sheet for quite some time,
but the former hasn't been. So we can...
1) make a copy of css/htdig.css in dev/htdig-3.2, and then the script that
updates main.html can just copy it to dev/htdig-3.2, and check in both
copies as needed, or
2) copy and check in the 2nd main.html as above, but use sed to strip out
the css-dependent stuff, or
3) fully regenerate dev/htdig-3.2/main.html, independently of the one in
maindocs (though using the same technique).
What do you folks think? If we plan to introduce the style sheet into
the 3.2 on-line docs soon, as well as into the htdoc subdirectory of the
source tree, then maybe option 1 is the way to go. It's easiest. If we
don't plan to do this soon, then option 2 might be better, so the look of
main.html is consistent with the other 3.2 on-line docs. However, both
1 and 2 assume that the information in main.html (i.e. the Introduction
and Recent News frame when you first go to the site) will remain the
same for both. If we want the option to have different content (e.g. a
different intro for 3.2), then option 3 is the only real viable one,
whether we add style sheets soon or not.
I'm planning for now to copy the main.html (minus the css stuff) to
dev/htdig-3.2 manually and check it in, for now, but I wouldn't mind some
feedback on this before I change the update script. The style sheet was
added to maindocs around the time 3.1.6 went out, as an experiment, but
we haven't really followed up in terms of deciding if we want to stick to
this format or not.
Back in February, I wrote...
> According to me:
> > Another way might be to do away with main.shtml and news.txt from the
> > maindocs tree altogether, and just have a main.html file, as before the
> > SourceForge days. Only difference is this time, the news section in
> > main.html would be between clear delimiters, and the news-get.sh script
> > would use these to automatically strip out and reinsert updated news
> > items from the one file. It would recommit it only if it was different
> > from yesterday's file. The script should also have proper tests to
> > ensure the newly generated file is indeed complete, to prevent the whole
> > thing from getting clobbered in the event of a disk space crunch, but
> > with that, it may be the best option from a maintenance point of view.
> > I'm leaning towards this latter approach.
> OK, I've implemented this on a trial basis. index.html and contents.html
> still point to main.shtml, with still includes news.txt. However, I've
> updated the news-get.sh script to maintain both news.txt and main.html,
> so we'll see how it goes in the coming days/weeks. If it seems solid,
> we can switch index.html and contents.html over to using main.html,
> and we can then get rid of main.shtml and news.txt (and take out the
> part in news-get.sh that maintains the latter).
> Please have a look and comment. I'd appreciate the extra eyeballs.
Gilles R. Detillieux E-mail: <grdetil@...>
Spinal Cord Research Centre WWW: http://www.scrc.umanitoba.ca/
Dept. Physiology, U. of Manitoba Winnipeg, MB R3E 3J7 (Canada)