documentation tweaks and website update

This commit is contained in:
david 2001-11-25 23:26:18 +00:00
parent 066aec74f2
commit 188d72cb81
5 changed files with 46 additions and 33 deletions

View File

@ -14,6 +14,8 @@ Unreleased 0.6 ScrollKeeper access is locale aware
(including --help).
Malcolm: Added option to start on different
interface and/or port.
www.scrollserver.org is now the home page
fixed default cache dir problem by adding /
2001-09-23 0.5 Moved internal cache files to cache root.
Handle anchors (#foo) in URIs.

View File

@ -4,5 +4,7 @@ David C. Merrill <david@lupercalia.net>
The stylesheets are very slightly hacked versions of Norman Walsh's excellent
DocBook stylesheets.
Thanks to Malcolm Tredinnick <malcolm@commsecure.com.au> for patches.
Thanks to Malcolm Tredinnick <malcolm@commsecure.com.au> for his help. Malcolm
implemented the command line options and worked on the caching system.
Thanks also to Nik Clayton for his help with xsl:sort.

View File

@ -3,7 +3,23 @@ to read up on ScrollKeeper as well to understand how the two work together.
If you would like to help develop ScrollServer, there are some bugs listed on
the SourceForge project page you could look into, or write me if you want to
develop a new feature.
develop a new feature. Most of the current SourceForge bugs are really features
and other enhancements. I have a zero bug policy. My policy is to always fix
bugs before developing any features.
If you are interested in coding C, then ScrollKeeper would appreciate your
help and deserves your support.
ScrollServer and ScrollKeeper have the potential to become a complete
distributed information database based on the latest XML technologies for
creating richly linked data. There are some large hurdles to that
accomplishment, particularly the fact that these technologies are relatively new
and so ScrollServer is on the cutting edge. But that is where the fun is.
It is only recently that Linux documentation has started to move seriously into
XML, allowing projects such as this to exist. Thanks to all the hard work people
have put into creating good documentation for Linux. Hopefully ScrollServer will
make it easier than ever to share and access that documentation.
david@lupercalia.net
@ -25,20 +41,6 @@ XPointer (W3C Last Call Working Draft)
XML Topic Maps
XSLT
If you are interested in coding C, then ScrollKeeper would appreciate your
help and deserves your support.
ScrollServer and ScrollKeeper have the potential to become a complete
distributed information database based on the latest XML technologies for
creating richly linked data. There are some large hurdles to that
accomplishment, particularly the fact that these technologies are relatively new
and so ScrollServer is on the cutting edge. But that is where the fun is.
It is only recently that Linux documentation has started to move seriously into
XML, allowing projects such as this to exist. Thanks to all the hard work people
have put into creating good documentation for Linux. Hopefully ScrollServer will
make it easier than ever to share and access that documentation.
Server Process
--------------
@ -62,7 +64,7 @@ Document Processing
Internal pages are generated from xsl stylesheets. The documentation itself is
generated from DocBook SGML and XML sources and xsl stylesheets, but eventually
it will have to support man pages, info pages, and other formats.
it will support man pages, info pages, and other formats.
Documents in html are served, but they look different from the DocBook documents
because we don't generate them ourselves. There is no navigation bar on the top,

View File

@ -1,5 +1,5 @@
This is ScrollServer 0.6, a Python based http server that provides access to
a scrollkeeper database with any web browser.
This is ScrollServer, a Python based http server that provides access to
a ScrollKeeper database with any web browser.
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
@ -10,9 +10,12 @@ It must be usable in text browsers but attractive in X.
It must Serve all documentation formats supported by ScrollKeeper.
It must provide browsing by document title or topic.
At this time, these three requirements have been met and the primary need
is some good testing.
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
search library.
search library. Right now there is no search functionality.
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
@ -28,8 +31,6 @@ 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.
Sound like an interesting project?
Dependencies

View File

@ -6,15 +6,6 @@
<BODY>
<h1>ScrollServer</h1>
<h2>Latest Release</h2>
The latest release is version 0.5, which offers several improvements. It is
architecturally cleaner than 0.4 and uses css stylesheets for a much more
attractive appearance. There is a dependency I'm still trying to figure out. If
you encounter a bug please let me know as it will help me figure it out.
<p>
See CHANGELOG for the nitty gritty.
<h2>What is ScrollServer?</h2>
ScrollServer is a <a href="http://www.python.org">Python</a> based http server
@ -74,10 +65,25 @@ 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.
<p>
Sound like an interesting project?
<h2>Latest Release</h2>
The latest release is <a href="scrollserver-0.6.tar.bz2">version 0.6</a>.
There's been quite a few improvements,
including better cache handling, LOCALE awareness, updated stylesheets,
command line config options and other miscellaneous cleanups.
<p>
See CHANGELOG for the nitty gritty.
<h2>Earlier Releases</h2>
<a href="scrollserver-0.5-tar.bz2">ScrollServer 0.5</a> offers several improvements.
It is architecturally cleaner than 0.4 and uses css stylesheets for a much more
attractive appearance. There is a dependency I'm still trying to figure out. If
you encounter a bug please let me know as it will help me figure it out.
<h2>Resources</h2>
See these sites for information about related topics.