On Sun, 3 Oct 2004 13:46:22 -0600, Jonathan Turkanis <technews@kangaroologic.com> wrote:
The really big problem is that the HTML for the index, which can be rather large, would be physically included in each content page. This could make
"Caleb Epstein" <caleb.epstein@gmail.com> wrote in message news:989aceac041004104824d6f905@mail.gmail.com... the
library documentation enormous.
What about a middle ground? The index can live in its own frame to prevent this duplication of code, but there could be some level of navigation available on each page (e.g. prev/next/up/down links). This way folks who dislike or can't view frames can still find their way around.
This is what I favor for automatically generated documentation. It doesn't work for handwritten docs, since adding the prev/next/up/down is 'tedious and error prone'. Jonathan