Revision [2522]
This is an old revision of IncludeRemote made by DarTar on 2004-11-27 13:15:45.
Including Remote Wikka Content
Last edited by DarTar:
An alternative approach for distributing documentation
Sat, 27 Nov 2004 13:15 UTC [diff]
An alternative approach for distributing documentation
Sat, 27 Nov 2004 13:15 UTC [diff]
An interesting solution for making freshly-updated HelpInfo wikka documentation available to end users, without distributing the whole documentation package, might be to create a {{help page="PageName"}} plugin allowing to retrieve content from the main wikka server, using something like the raw method.
Here's how it might function:
- the user of a wikka distribution opens a local WikkaDocumentation page containing {{help page="HelpInfo"}};
- the plugin connects to the main wikka server,
- it retrieves a raw version of HelpInfo with no header and footer (i.e. the mere page content in wikka syntax),
- it parses the retrieved page for internal links and translates them into local links for retrieving remote content (links pointing to remote URLs need not be translated), and finally
- it prints locally the documentation contents.
- if a connection is not available, a splash page with a static link to http://wikka.jsnx.com/HelpInfo and a short text is printed;
A similar plugin might be used also for bug notifications and other kinds of "centralized" content.
Note that no MySQL connection to the central database is needed, provided that a method exists for retrieving pure page content with the header and footer stripped.
-- DarTar
CategoryDevelopment