Modules - Revision history

HansR: /* The list of modules */

2024-12-05T13:43:34Z

The list of modules

← Older revision		Revision as of 13:43, 5 December 2024
Line 20:		Line 20:
	#[[ChartsCompiler]]		#[[ChartsCompiler]]
	#[[MeteoCam]]		#[[MeteoCam]]
			#[[Diary]]
	#[[UserAskedData]]		#[[UserAskedData]]

HansR: /* The multiple module commands */

2024-07-05T07:24:00Z

The multiple module commands

← Older revision		Revision as of 07:24, 5 July 2024
Line 28:		Line 28:
	#[[ChartsCompiler\|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.		#[[ChartsCompiler\|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.

	If you use modules but want the resulting server location outside of ~~you~~ main website location (e.g. in a subdirectory CUtils) then please create that directory and set your uploads for CUtils accordingly. To have your website find the specific realtime values (the JSON files) specifically generated for CUtils, than run the [[UserAskedData]] command and set the parameter where to locate those data. In the case as above:		If you use modules but want the resulting server location outside of your main website location (e.g. in a subdirectory CUtils) then please create that directory and set your uploads for CUtils accordingly. To have your website find the specific realtime values (the JSON files) specifically generated for CUtils, than run the [[UserAskedData]] command and set the parameter where to locate those data. In the case as above:
	DoModular=true		DoModular=true
	ModulePath=<path>		ModulePath=<path>

HansR: /* Commandline parameters (v7 and up) */

2024-07-05T06:15:18Z

Commandline parameters (v7 and up)

← Older revision		Revision as of 06:15, 5 July 2024
Line 51:		Line 51:
	<script src='lib/cumulusutils.js'></script>		<script src='lib/cumulusutils.js'></script>
	</pre>		</pre>
	This library is generated with the website command separately with the CUlib command. <br>		This library is generated with the website command separately with the ''CUlib'' command. <br>
	It has it's [[CumulusUtils Runtime Library\|own entry in the wiki]].		It has it's [[CumulusUtils Runtime Library\|own entry in the wiki]].

HansR: /* Commandline parameters (v7 and up) */

2024-06-27T14:02:49Z

Commandline parameters (v7 and up)

← Older revision		Revision as of 14:02, 27 June 2024
Line 45:		Line 45:

	== Commandline parameters (v7 and up) ==		== Commandline parameters (v7 and up) ==

⚫	To have modules work properly with the commandline parameters introduced in version 7 of CUtils, you need to use a ~~script~~ in ~~your~~ ~~own index file:~~

		⚫	To have modules work properly with the commandline parameters introduced in version 7 of CUtils, you need to use the runtime library for ''CumulusUtils''
	<pre>		<pre>
		⚫	<script src='lib/cumulusutils.js'></script>
⚫	<script>
⚫	const urlParams = new URLSearchParams(window.location.search);
⚫	</script>
	</pre>		</pre>
			This library is generated with the website command separately with the CUlib command. <br>
			It has it's [[CumulusUtils Runtime Library\|own entry in the wiki]].

	You can also use - i.s.o. the ~~script~~ above - ~~the~~ ~~runtime~~ ~~library~~ ~~for~~ ~~''CumulusUtils'':~~		You can also use - i.s.o. the library above - a script in your own HTML file:
	<pre>		<pre>
		⚫	<script>
⚫	<script src='lib/cumulusutils.js'></script>
		⚫	const urlParams = new URLSearchParams(window.location.search);
		⚫	</script>
	</pre>		</pre>
	This library is currently only generated with the website command (which you can run even if you don't use the website) but in future it will be possible to generate it separately with an additional command. It will then get it's own entry in the wiki.

	[[Category:CumulusUtils]]		[[Category:CumulusUtils]]

HansR at 07:25, 16 April 2024

2024-04-16T07:25:43Z

← Older revision		Revision as of 07:25, 16 April 2024
Line 43:		Line 43:

	If you use the [[Website Generator]], '''set both parameters to false'''.		If you use the [[Website Generator]], '''set both parameters to false'''.

			== Commandline parameters (v7 and up) ==
			To have modules work properly with the commandline parameters introduced in version 7 of CUtils, you need to use a script in your own index file:
			<pre>
			<script>
			const urlParams = new URLSearchParams(window.location.search);
			</script>
			</pre>

			You can also use - i.s.o. the script above - the runtime library for ''CumulusUtils'':
			<pre>
			<script src='lib/cumulusutils.js'></script>
			</pre>
			This library is currently only generated with the website command (which you can run even if you don't use the website) but in future it will be possible to generate it separately with an additional command. It will then get it's own entry in the wiki.

	[[Category:CumulusUtils]]		[[Category:CumulusUtils]]

HansR at 09:05, 14 November 2023

2023-11-14T09:05:17Z

← Older revision		Revision as of 09:05, 14 November 2023
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 and can be used in a users own website. The [[Website Generator\|website]] is not seen as a module but it is the CUtils own aggregate of the modules.

	== The list of modules ==		== The list of modules ==
	CumulusUtils offers the following modules (which can be used as commands):		CumulusUtils offers the following modules (which can be used as commands):
	#[[SysInfo]]		#[[SysInfo]]
⚫	#[[Forecast]]
⚫	#[[StationMap]]
⚫	#[[UserReports]]
	#[[pwsFWI]]		#[[pwsFWI]]
	#[[~~Records~~ ~~- Top10~~\|~~Top10~~]]		#[[Extra Sensors\|ExtraSensors]]
			#[[Custom Logs]]
	#[[Graphs]]		#[[Graphs]]
	#[[Yadr]]		#[[Yadr]]
	#[[Records]]		#[[Records]]
	#[[NOAA]]		#[[NOAA]]
		⚫	#[[Forecast]]
		⚫	#[[StationMap]]
		⚫	#[[UserReports]]
			#[[Records - Top10\|Top10]]
	#[[Records - DayRecords\|DayRecords]]		#[[Records - DayRecords\|DayRecords]]
	#[[AirLink]] (before version 6.1 this was [[AirQuality]])		#[[AirLink]] (before version 6.1 this was [[AirQuality]])
	#[[ChartsCompiler]]		#[[ChartsCompiler]]
			#[[MeteoCam]]
	#[[Extra Sensors\|ExtraSensors]]
	#[[UserAskedData]]		#[[UserAskedData]]

Line 23:		Line 25:
	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:		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 Generator\|Website]] => generates the website which consists of all modules, the inclusion of the libraries is embedded in website's index.html.		#[[Website Generator\|Website]] => generates the website which consists of all modules, the inclusion of the libraries is embedded in website's index.html.
	#[[UserAskedData]] => a specific command used for generating JSON datafiles when required by other modules (~~Compiler~~ and~~/or~~ ~~AirLink~~)		#[[UserAskedData]] => a specific command used for generating JSON datafiles when required by other modules (e.g. ''AirLink'', ''Extra Sensors'' and ''CustomLogs'')
	#[[Extra Sensors\|ExtraSensors]] => a command to generate the ExtraSensors module but which implicitly activates the compiler.
	#[[ChartsCompiler\|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.		#[[ChartsCompiler\|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.

			If you use modules but want the resulting server location outside of you main website location (e.g. in a subdirectory CUtils) then please create that directory and set your uploads for CUtils accordingly. To have your website find the specific realtime values (the JSON files) specifically generated for CUtils, than run the [[UserAskedData]] command and set the parameter where to locate those data. In the case as above:
			DoModular=true
			ModulePath=<path>
			''DoModular'' and the command ''Website'' are incompatibe

	== Javascript libraries ==		== Javascript libraries ==

HansR: /* The multiple module commands */

2023-02-21T16:03:44Z

The multiple module commands

← Older revision		Revision as of 16:03, 21 February 2023
Line 23:		Line 23:
	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:		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 Generator\|Website]] => generates the website which consists of all modules, the inclusion of the libraries is embedded in website's index.html.		#[[Website Generator\|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 AirLink)		#[[UserAskedData]] => a specific command used for generating JSON datafiles when required by other modules (Compiler and/or AirLink)
			#[[Extra Sensors\|ExtraSensors]] => a command to generate the ExtraSensors module but which implicitly activates the compiler.
	#[[ChartsCompiler\|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.		#[[ChartsCompiler\|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.

HansR: /* The list of modules */

2021-09-16T09:35:26Z

The list of modules

← Older revision		Revision as of 09:35, 16 September 2021
Line 18:		Line 18:
	#[[ChartsCompiler]]		#[[ChartsCompiler]]
	#[[Extra Sensors\|ExtraSensors]]		#[[Extra Sensors\|ExtraSensors]]
			#[[UserAskedData]]

	== The multiple module commands ==		== The multiple module commands ==

HansR: /* The list of modules */

2021-09-09T10:02:30Z

The list of modules

← Older revision		Revision as of 10:02, 9 September 2021
Line 17:		Line 17:
	#[[AirLink]] (before version 6.1 this was [[AirQuality]])		#[[AirLink]] (before version 6.1 this was [[AirQuality]])
	#[[ChartsCompiler]]		#[[ChartsCompiler]]
			#[[Extra Sensors\|ExtraSensors]]

	== The multiple module commands ==		== The multiple module commands ==

HansR: /* The list of modules */

2021-08-20T12:58:49Z

The list of modules

← Older revision		Revision as of 12:58, 20 August 2021
Line 15:		Line 15:
	#[[NOAA]]		#[[NOAA]]
	#[[Records - DayRecords\|DayRecords]]		#[[Records - DayRecords\|DayRecords]]
	#[[AirLink]]		#[[AirLink]] (before version 6.1 this was [[AirQuality]])
	#[[ChartsCompiler]]		#[[ChartsCompiler]]