[boost] [serialization] Some doc issues

9 Feb 2006

      Hi there,

Some fairly minor issues with the serialization docs.

1.  On this page :
http://boost.org/libs/serialization/doc/rationale.html

The title is spelt :

<title>Seriealization  - Rationale</title>

Of course you wouldn't normally see that title, because the title
normally comes from the frameset, but if you follow a link from an
external source to a document that belongs in the right frame then it
becomes visible. (as I did).

2. It would be helpful to have a "this page belongs in my <frameset>" 
or something along those lines.  Without that there is no way to get
from a sub document to the contents.  See [1] for an example of how
this can work.

3. In firefox there are some rather odd characters at the top of the
contents frame?? They're not there in opera or IE, so I can't see
where they're coming from.  It might be because the <!doctype is in
lower case, and should be <!DOCTYPE.

4. The javascript that detects the current browser is broken, and
incomplete.  Firstly appName is spelt appnName.  Which means that if
you're not a netscape browser or IE then you don't get the expanding
menu.

Actually the whole browser detection thing is a flawed way of going
about it, because it is exclusive of browsers that aren't
Microsoft/Netscape/Konqueror.  And many browsers would be perfectly
capable of handling the script.  See this page [1] for a discussion on
why  browser detection is flawed.

You can rewrite the script quite simply to use object detection
instead of browser detection, see [2].

Sam

[1] http://www.quirksmode.org/js/support.html

[2]
function toggle(element) {
  if (null == element){
    return;
  }
  var targetId = element.id + "_detail";
  var targetElement = document.getElementById ?
document.getElementById(targetId) : document.all[targetId];
  if (null != targetElement){
    if (targetElement.style.display == "none") {
      targetElement.style.display = "";
      element.src="minus.gif";
    }
    else{
      targetElement.style.display = "none";
      element.src="plus.gif";
    }
  }
}

function clickHandler(e)
{
    if (!e) { e = window.event; }
    var target = e.target ? e.target : e.srcElement;
    toggle(target);
}

function collapse_all()
{
    if (document.images)
    {
    var l = document.images;
    var i = l.length;
    while(i > 0)
    {
      i = i - 1;
      var image = l[i];
      image.style.display = "";
      toggle(image);
    }
  }
}

function initialize()
{
    if (document.getElementById || document.all)
    {
        document.onclick = clickHandler;
        collapse_all();
    }
}

[boost] [serialization] Some doc issues

Sam Partington