Re: [Scrollkeeper-devel] Re: converting omf files

[Dan Mueth <muet alumni uchicago edu>]

It looks like I forgot to update the web page after the release.  I fixed 
the mistake John found and uploaded the HTML form of the doc to the web 
page.  Now the doc should be completely up-to-date:

http://scrollkeeper.sourceforge.net/documentation/writing_scrollkeeper_omf_files/index.html

That is the authoritative document for writing ScrollKeeper/OMF files.

For general information on setting up a package to play nicely with 
ScrollKeeper (ie. build and install its docs and OMF files), see the 
scrollkeeper-example2 package:

https://sourceforge.net/project/showfiles.php?group_id=11543&release_id=80136

The accompanying manual which explains how the example package works is 
also available online as HTML:

http://scrollkeeper.sourceforge.net/documentation/scrollkeeper_example2_manual/index.html

For GNOME folks, we have a modified version of the scrollkeeper-example2 
package and document which simplifies things a bit further, assuming a 
standard GNOME setup.  We still need to propagate the OMF file updates to 
this package, but the rest of it is up-to-date.  It can be obtained from 
GNOME CVS at gnome-docu/gdp/gdp-example2.  

And finally, the list of categories of the contents listing can be found 
at:

http://scrollkeeper.sourceforge.net/documentation.shtml

I think this documentation together covers everything most people need to 
care about, except folks hacking on ScrollKeeper or a help browser.

Dan



On 5 May 2002, John Fleck wrote:

> On Sun, 2002-05-05 at 14:52, John Fleck wrote:
> > On Sun, 2002-05-05 at 16:19, David Merrill wrote:.
> > > > 
> > > > I've been looking all over the sk site(s) and still have yet to figure
> > > > out what the differences are. Where is this documented, and are there
> > > > pointers to examples?
> > > 
> > > http://scrollkeeper.sourceforge.net/documentation/writing_scrollkeeper_omf_files/
> > > 
> > > and there is an example in that same document. I'm just working
> > > through it myself. If you have time, do you want to take over this
> > > issue though? I'm rather harried and being pulled in too many
> > > directions.
> > > 
> > 
> > Unfortunately, the web page David points to above is out of date. Dan
> > hasn't updated the documentation yet to match the DTD, so the only place
> > the new format is documented in the DTD itself, I believe. It's in the
> > tarball at extract/dtds/scrollkeeper-omf.dtd.
> > 
> > I think Dan's swamped and needs help with stuff like this. If no one
> > else does soon, I'm planning on jumping in and rewriting that
> > documentation, as we need this for the upcoming GNOME release. I'll also
> > take a look at db2omf and see if it's within my modest skills to change
> > that as well.
> > 
> 
> OK, it looks as though the "writing_scrollkeeper_omf_files.xml in
> ScrollKeeper cvs is more up-to-date than the version on the web site at
> the URL above.
> 
> The "minimal OMF file" and "complete OMF file" examples in the cvs
> version of the doc validate, with the exception of the "id" attribute of
> the "version" tag, which should be "identifier". I'll file a bug, and
> perhaps when Dan surfaces he can do whatever magic is necessary to get
> the web site version of the doc updated.
> 
> Cheers,
> John
>