Re: [Scrollkeeper-devel] Scrollkeeper file format improvements?

[<las...@Su...>]

> > Second the TOC:
> >
> > Functionally JavaHelp and Scrollkeeper files are the same so there is
> > only a little room for changes with obvious benefit.
> >
> > Scrollkeeper format is:
> >
> > <tocsect1 linkid="intro">Introduction
> >     <tocsect2 linkid="whatisscrollkeeper">What is ScrollKeeper?
> >     </tocsect2>
> >     <tocsect2 linkid="aboutthisdoc">About This Document
> >     </tocsect2>
> >     <tocsect2 linkid="authors">Authors
> >     </tocsect2>
> >     <tocsect2 linkid="scrollkeeperlicense">ScrollKeeper License
> >     </tocsect2>
> > </tocsect1>
> >
> > The numbering of the tocsects caused me tremendous problems while
> > writing the TOC extractor stylesheet (although that was my first ever
> > stylesheet, it is not that difficult actually). I think we should get
> > rid of those numbers regardless of other changes. The only help browser
> > using Scrollkeeper currently that I know of is Nautilus and it doesn't
> > use those numbers at all. No code change would be needed there if the
> > numbers go.
> 
> Sounds reasonable.  I think the reason they are there are because DocBook
> uses <sect1>, <sect2>, etc.  It would be interesting to know the reason
> why DocBook numbers their sections.  I suspect it is (a) for the author,
> since they read and write the markup and having numbers helps keep them
> from getting confused, and (b) <books>, <articles>, etc. have strict rules
> on how they can be sectioned.  Neither of these really apply here, so I
> think we can do away with the numbers if there is any incentive to do so,
> such as making things simpler.
> 
> > The JavaHelp TOC file is:
> >
> > <tocitem image="toplevelfolder" text="Java Development Environment">
> >     <tocitem target="jde.intro">Introduction to JDE Online Help />
> >     <tocitem text="IDE Tutorial" target="tut.starttoc">
> >         <tocitem text="Introducing JDE" target="tut.intro" />
> >         <tocitem text="Tutorial One" target="tut.quickstart" / >
> >         <tocitem text="Tutorial Two" target="tut.edit" />
> >         <tocitem text="Tutorial Three" target="tut.errors" />
> >     </tocitem>
> > </tocitem>
> >
> > It holds the same info as Scrollkeeper's, if there is no technical
> > reason against it, I would support switching to it.
> 
> Somebody mentioned on this list a little while back that one should not
> have "running text" as an attribute.
> 
> Dan

I just noticed that I didn't finish this thread. So final suggestion is:

From:

<tocsect1 linkid="intro">Introduction
     <tocsect2 linkid="whatisscrollkeeper">What is ScrollKeeper?
     </tocsect2>
<tocsect1>

To:

<tocitem target="intro">Introduction
     <tocitem target="whatisscrollkeeper">What is ScrollKeeper?
     </tocitem>
<tocitem>

Comments?

Laszlo