/program/manual.php - a kickstarter for the documentation
This script is an entry point; it can be called directly. It is also linked to from /program/admin.php, via the help button, implementing a context-sensitive help function. The following parameters are recognised:
construct a list of 0 or more languages from the languages directory
This routine examines the directory $path to see which subdirectories exist. Each subdirectory indicates a possible language. An array keyed with these languages and the full name of the language in the language itself is returned (but it could be empty).
construct a list of 0 or more languages of available manuals
This routine examines the directory $path to see which subdirectories exist. Each subdirectory indicates a possible language. An array keyed with these languages and the full path to the directory containing the manual's index.html is returned (but it could be empty).
redirect the user to a specific place in the manual OR show helpful message about downloading the manual
There is a Website@School Users' Guide available, in English. This is a separate download from the project's website. That means that it is optional to have the (English) manual installed. If it is installed, it is installed under /program/manuals/en/. There might also be translations available, say the Dutch version of the manual. That one would be installed in /program/manuals/nl/ which allows for peaceful co-existence of multiple translations of the manual. This script manual.php is designed to:
show a screen to the visitor presenting a choice between various available translations of the manual
show a screen to the visitor hinting at downloading a manual archive from download.websiteatschool.eu
Documentation generated on Tue, 28 Jun 2016 19:10:31 +0200 by phpDocumentor 1.4.0