Modules: Difference between revisions

Modules (view source)

Revision as of 08:33, 5 May 2021

275 bytes removed , 08:33, 5 May 2021

m

→‎Javascript libraries

HansR

Bureaucrats, Administrators

1,635

edits

@@ Line 26: / Line 26: @@
 == 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''.
+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''.
-As [https://jquery.com/ 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.
+#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.
-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 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.
 If you  use the [[Website Generator]], '''set both parameters to false'''.
 [[Category:CumulusUtils]]