Modules
Introduction
Modules are the basic building blocks of CumulusUtils. Identifying modules on the commandline they become synonym with commands to CumulusUtils.
The list of modules
CumulusUtils offers the following modules (which can be used as commands):
The multiple module commands
In addition to the true modules which are equivalent to commands, there are commands which are strictly spoken not modules because they do not comprise a single functionality:
- Website => generates the website which consists of all modules, the inclusion of the libraries is embedded in website's index.html.
- All => generates all modules without the context of the website, the inclusion of the libraries is embedded in the generated files.
- UserAskedData => a specific command used for generating JSON datafiles when required by other modules (Compiler and/or AirQuality)
- CompileOnly => a command which activates the compiler only. This is a very specific command with more than one effect. Please check out its own page.
Javascript libraries
Each module has its own parameters but for modules which use javascript or Highcharts or Leaflet libraries there are additional considerations (which btw are also valid for individual module generation). It is assumed that modules are used within a website so there is no document load function to start the javascript or other initialisation.
As jQuery is a requirement for almost all modules (with menu's), CumulusUtils has provided a parameter GeneratejQueryInclude in the section [General] which the user can set to true or false. If his site has already a general inclusion of this library or another version, set it to false. If the site has no other use for jQuery, set it to true. If you have no idea what I am talking about, set it to true or start reading about jQuery.
Libraries for Highcharts or Leaflet are always included in that specific module but this may change in future this wiki will be adjusted accordingly.