Re: [Scrollkeeper-devel] Simple URI's

[Ali A. <ali...@au...>]

* Laszlo Kovacs (las...@su...) wrote at 21:43 on 29/11/00:
> > > 2) Mapping the names.  The OMF file should specify the name by which the
> > > document should be referred.  This seems to require yet another OMF
> > > attribute to be created, perhaps IDENTIFIER.URINAME?  We will not have
> > > complete uniqueness here.  However ideally we will have a 1-1
> > > correspondence between NUID's and URINAME's.  We could keep a database on
> > > the web so people can register names and find out if a name is taken.
> > > This creates even more administrative overhead, but I think it is well
> > > worth the trouble it would take to set up a simple php/mysql site on
> > > SourceForge.
> > 
> > Not sure this is a good idea...you will have to have a 'URINAME' if you
> > are typing the URI manually.
> > 
> > BUT:
> > 
> > I think that applications should give scrollkeeper a "title", locale
> > (optional), and version # (optional), format (default would be Docbook).
> > Scrollkeeper would then search its database and return the unique IDs
> > (possible there will be more than one doc matching the criteria, so the
> > client would either pick the first one, or try to do some other
> > processing (e.g: See Also)).
> > 
> > You could also have another function that would return the "first found
> > match" of the document directly (so you don't have to search for UUID,
> > and then tell scrollkeeper to return this document - you just tell it
> > "return the first document that matches this criteria").
> > 
> > Anyway, this approach would only work if you have a list of documents to
> > choose from.
> > 
> > So, maybe URINAME's are the way to go.
> 
> Are you suggesting to try to partially match the string from the
> Scrollkeeper URI with the "title" that you described above? 

Well, you could use the title - but you would have to implement proper URI
escaping/handling (i.e. use %20 instead of a space, etc.)

This would suck though, because people are not going to make links to
sk-help:PPP%20HowTo (note: it would be case sensitive so HowTo may not work
(it might be HOWTO, or Howto - or it even could be 'How-to' or 'HOW-TO', etc.)
The title could be 'Gnumeric Manual' and people will not want to type all of
that out (and they may forget its name, was it 'Gnumeric manual?' or 'Gnumeric
Help', or 'Gnumeric Tutorial', etc.)

So I don't think title is a good idea.

We have the option of a new field called 'URINAME'. This means that there
needs to be a 'unique' URINAME for each help file, so the line between UUIDs
and URINAMEs become blurred (the only diff. is a doc in another locale has a
diff. UUID, but the same URINAME)...

I suggest you just go ahead and add an extra URINAME field (note you will
still need to handle propery escaping, but I doubt people will make the
URINAME "complex" (otherwise doc. authors just wont' link to it because they
can't remember the proper URINAME to use).

Regards,
Ali