2001-11-25 23:26:18 +00:00
|
|
|
This is ScrollServer, a Python based http server that provides access to
|
|
|
|
a ScrollKeeper database with any web browser.
|
2001-09-10 12:23:50 +00:00
|
|
|
|
|
|
|
ScrollServer is in very early development, but it is already useful. It has
|
|
|
|
been tested on RedHat 7.1 and Debian Woody. Reports of success or failure on
|
|
|
|
other systems greatly appreciated.
|
|
|
|
|
2001-09-22 02:54:49 +00:00
|
|
|
I'm working towards a 1.0 release which will implement basic functionality.
|
|
|
|
It must be usable in text browsers but attractive in X.
|
|
|
|
It must Serve all documentation formats supported by ScrollKeeper.
|
2001-09-22 15:28:08 +00:00
|
|
|
It must provide browsing by document title or topic.
|
2001-11-26 03:00:58 +00:00
|
|
|
It must be fully web standards compliant.
|
2001-09-22 02:54:49 +00:00
|
|
|
|
2001-11-25 23:26:18 +00:00
|
|
|
At this time, these three requirements have been met and the primary need
|
|
|
|
is some good testing.
|
|
|
|
|
2001-09-22 02:54:49 +00:00
|
|
|
In later releases searching should be powerful but easy. It's a classic trade
|
|
|
|
off, but I'm going to try. It will probably mean writing my own DocBook-aware
|
2001-11-25 23:26:18 +00:00
|
|
|
search library. Right now there is no search functionality.
|
2001-09-22 02:54:49 +00:00
|
|
|
|
|
|
|
There are more ambitious goals in the long term. Eventally, ScrollServers will
|
|
|
|
be able to talk to one another, and to share information with each other. One
|
|
|
|
ScrollServer will `publish' a document or five hundred, and another will
|
|
|
|
`subscribe' to the `publication'. This is mainly for the benefit of the Linux
|
|
|
|
Documentation Project and others who provide more general Linux information.
|
|
|
|
|
|
|
|
Each subscription can be left offsite or cached locally, updating the
|
|
|
|
local ScrollKeeper database. If the local ScrollServer database has a cached
|
|
|
|
copy of the document, it will be used in preference to the online copy.
|
|
|
|
|
|
|
|
Eventually a reader might be able to rate a document, and have their comments
|
|
|
|
sent to the publisher (i.e., the other ScrollServer) and also to the author of
|
|
|
|
the document, which can be extracted from the DocBook.
|
|
|
|
|
2001-09-18 16:37:57 +00:00
|
|
|
|
2001-09-23 17:32:51 +00:00
|
|
|
Dependencies
|
|
|
|
|
|
|
|
xsltproc and libxml
|
|
|
|
python 2.?
|
|
|
|
python-xml
|
|
|
|
|
|
|
|
|
2001-09-10 12:23:50 +00:00
|
|
|
Known Bugs
|
|
|
|
|
|
|
|
Gnome specific uris such as gnome-help:foo don't work. I and the gnome-doc
|
2001-09-18 16:37:57 +00:00
|
|
|
people are working on a solution. It may just mean work in the xsl stylesheets.
|
2001-09-10 12:23:50 +00:00
|
|
|
|
|
|
|
KDE documents haven't even been looked at yet.
|
|
|
|
|
|
|
|
HTML is cached, but there is no cache management.
|
2001-09-22 02:54:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
David Merrill
|
|
|
|
david@lupercalia.net
|
|
|
|
|