Modules: Difference between revisions
m (→Introduction) |
|||
| Line 1: | Line 1: | ||
== Introduction == |
== Introduction == |
||
Modules are the basic building blocks of CumulusUtils. Identifying modules on the commandline they become synonym with commands to CumulusUtils. |
Modules are the basic building blocks of CumulusUtils. Identifying modules on the commandline they become synonym with commands to CumulusUtils. |
||
When using the Website Generator, all modules are used implicitly. Modules, with some exceptions, can be used standalone in any website by including the output of CumulusUtils in that website. When using the standalone mode you need to be aware of the [[cumulusutils.ini|inifile parameters]] (section general) ''GeneratejQueryInclude'' and ''DoLibraryIncludes''. |
|||
#GeneratejQueryInclude will - if true - generate the required jQuery library reference line on top of the module. |
|||
#DoLibraryIncludes will - if true - generate the required library references (e.g. HighCharts, Leaflet etc...) on top of the module. |
|||
If you manage these libraries in your website yourself set these parameter values to false. |
|||
If the modules don't work and you have no idea what this is about, set these values to true. |
|||
== The list of modules == |
== The list of modules == |
||
Revision as of 08:30, 5 May 2021
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):
- SysInfo
- Forecast
- StationMap
- UserReports
- pwsFWI
- Top10
- Graphs
- Yadr
- Records
- NOAA
- DayRecords
- AirQuality
- ChartsCompiler
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
The usage of javascript libraries like jQuery, Highcharts or Leaflet is controlled by the user who already may have these libraries included in his website on another level. In that case a second inclusion is not wanted. Therefore two explicit parameters exist which govern these situations: GeneratejQueryInclude and DoLibraryIncludes.
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 you have no idea what this is about, set it to true or start reading about javascript libraries.
Libraries for Highcharts or Leaflet are included when required in a specific module IF the inifile parameter DoLibraryIncludes is true (default). Set to false if you already use the libraries on another level. If you have no idea what this is about, set it to true or start reading about javascript libraries.
If you use the Website Generator, set both parameters to false.
