Ichthyostega
5c8e88e59e
Debian-Docbase allows to register some HTML documentation; My old package definition added placeholder config, which renders the documentation configuration invalid (as pointed out by Lintian). However, I still think it is a good idea to have the anchor point already defined, and thus I came up with the idea of in fact providing some usable placeholder content... As it turns out, we also have a placeholder page at the Lumiera website, where the User Manual is assumed to be located later — so why not extend this one and then provide the HTML-rendering for the DEB package? To allow for this setup * I have now extended the placeholder page for the Website to include some generic description about Lumiera (from the 'about' page) * Furthermore, I added the screenshot (from the »Outer Space« page) * and I use this a an opportunity to document the various test / demo facilities currently available in the GUI, since these are rather obscure. While only intended for the developer, it seems still worthwhile to describe the possible effects — it may well be that we retain some of that test/demo functionality and in that case, we have now already some starting point for a documentation * Then, to include that page as stand-alone HTML, I used the 'Print Edit WE'-plugin from Firefox, to encode the images as inline-base64 URLs (which are restored by a tiny JavaScript embedded into that page) * and last but not least, our SCons buildsystem needs the ability to install such a documentation file, since it seems most adequate to handle this requirement as part of the generic installation (and not hidden in some Debian scripting)
16 lines
761 B
Text
16 lines
761 B
Text
NOTE: this is a placeholder -- the intention is to build a user Manual via Asciidoc
|
|
|
|
As of 2025, Lumiera is not usable, and thus only a placeholder HTML page is provided
|
|
for the DEB-Package. The content on this page is identical to the "User-Manual" page:
|
|
https://Lumiera.org/documentation/user/manual.html
|
|
|
|
For the delivery
|
|
- this page has been rendered with Asciidoc
|
|
- the resulting HTML has been processed with the "Print Edit WE" plugin of Firefox,
|
|
which inlines any resources (CSS, images)
|
|
|
|
This page will be installed by the Lumiera SCons build into $prefix/share/doc/lumiera
|
|
(see doc/SConsscript)
|
|
|
|
Hint: for updates, re-render the Asciidoc and then use git/diff to combine the
|
|
new or changed content with the embedded inline images (base64 data)
|