ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Glenn McAllister" <>
Subject Re: New doc format and organization
Date Tue, 17 Oct 2000 16:09:38 GMT

When I said there were problems with using a navigation frame, I was
thinking of having a dynamic expanding and colapsing table of contents,
rather than a static one.  From what I've seen so far, the problems often
come down to browser support for JavaScript and DHTML.

Given that the titles in the TOC are fairly short, we can probably get away
with having the static nav in a left hand frame and having the content in
the right, minus the embedded navigation.  It would look cleaner and remove
the navigation maintenance problems.

Glenn McAllister
Software Developer. IBM Toronto Lab, (416) 448-3805
"An approximate answer to the right question is better than the
right answer to the wrong question." - John W. Tukey

Please respond to

Subject:  Re: New doc format and organization

I have mixed feelings about this....

Reasons FOR it:

  a. maintenance of any one topic is easier since
     you only have to update a file or two...
  b. focus on one topic at a time is nice,
     especially if this is done as frames (see below)

Reasons against it:

  a. Can't search the document.
  b. Can't print the whole document
     at one shot.

However, if we get the docs to an automated
creation point, we should do both the frame
version and the single long version for

Cosmetic - it would be nicer if the "index.html"
was in a left hand frame for navigation, and
the right hand pane contained the information.
Glenn said there were issues across browsers, but
I don't know what they are....

I just did a quick test by creating this frame set:

  <FRAME src="index.html" name="left">
  <FRAME src="intro.htm" name="right">

Then, I edited "index.html" to have target=right
in all the hrefs, i.e.:

  <dt>1.0 <a href="intro.htm" target=right>Introduction</a></dt>
  <dt>2.0 <a href="getting_ant.htm" target=right>Getting Ant</a></dt>
  <dt>3.0 <a href="system_requirements.htm" target=right>Determining
system requirements</a></dt>
  <dt>4.0 <a href="building_ant.htm" target=right>Building Ant</a></dt>

I tested this with Netscape 5.7 and IE 5.0 on NT, and it
looked fine. Whenever you click on a link in the left
hand frame, the content appears in the right hand
side. I edited a few "next" and "previous" links to
be correct, and verified that they move within the
right hand frame correctly.

Only "big" change I see is that the list of contributors
looks odd in the left hand navigation pane, so I moved
it to "intro.htm".

It all looked fine to me. Not sure why this can't be part
of the 1.2 release. I've attached the modified files if
you'd like to try them out. Just unzip Glenn's file,
extract the attachments into the same place, and
start with "frames.html" rather than "index.html"...

Glenn McAllister wrote:
> Hello all.
> I've been working over the docs a bit to reorganize them.  The current
> format of one bit index.html file is getting too unwieldy.  The next
> logical step is to use framesets with some sort of navigation pane.
> Unfortunately, I don't have time to build one that will work across
> multiple browsers before our ship date.
View raw message