[Gambas-user] Offline documentation is out-of-date

[Christopher Brian Jack]

On Sun, 4 Jun 2006, Rob Kudla wrote:

> On Sat June 3 2006 21:39, Christopher Brian Jack wrote:
> > How hard would it be to produce an application that updated
> > the offline documentation to match updates to the online
> > documentation?  Digests like MD5 or SHA1 would be sufficient
> > for detecting file changes and the plus would be that

> While the old wiki stored its data in files, the new one is
> MySQL-based.  Further, as with all wikis, the offline version
> needs to contain HTML markup, while the data stored on the
> server side contains wiki code... so there needs to be a program
> that generates the HTML out of the wiki code.

> That program may be as simple as wget --mirror, but ideally you
> want something a little faster and nicer to the web server.  The
> "publish" program provided that for TWiki; whether the current
> wiki Benoit wrote has such a utility, I don't know, but we can
> always use the wget method once in a while in a pinch (and if I
> were to catch people doing that a lot during the day, I'd have
> to put IP bandwidth restrictions in place.)

Keep modification times at the remote in the DB so it answer queue hints
in the HTTP headers such as If-Modified-Since which prevents serving
content that hasn't changed.  Something a little more complicated than
wget would be needed in that scenario so maybe the helpsystem code itself
would need to issue the HTTP requests and format the If-Modified-Since
header based on file modification times.

A further refinement is to add to the wiki code a way to generate a list
of changed URLs (nodes) in the wiki tree and only request the pages that
have changed, based on the list received:

http://www.gambasdocs.org/updated-since?<RFC-compliant UTC date>

The resulting data would be a possibly-empty text/plain document
containing a list of newline delimited URLs to wiki paths modified since
the specified date.  For each URL copy the location part of the URL to a
string for the file pathname and wget the changed URL to the pathname
saved in the string.

.=================================================.
|  Christopher BRIAN Jack aka "Gau of the Veldt"  |
+================================================='
| brian _AT_ brians-anime _DOT_ com
`=================================================-
Hi Spambots, my email address is sputnik at ...1334...