Help System - Revision history

HansR: /* Operation */

2025-08-27T07:40:18Z

Operation

← Older revision		Revision as of 07:40, 27 August 2025
Line 13:		Line 13:
	The ''CutilsCharts.def'' for the ChartsCompiler is described [[ChartsCompiler\|on the ChartsCompiler page]].		The ''CutilsCharts.def'' for the ChartsCompiler is described [[ChartsCompiler\|on the ChartsCompiler page]].

	The ''CUhelptexts.txt'' file resides in the utils directory an will be created when it does not exist: run CumulusUtils once without an argument. It ~~has~~ the ~~following~~ ~~default~~ ~~content:~~		The ''CUhelptexts.txt'' file resides in the utils directory an will be created when it does not exist: run CumulusUtils once without an argument. A default CUhelptexts-default-for-use.txt exists in the distribution you can use that file by renaming it to ''CUhelptexts.txt'' or by using those texts in your own ''CUhelptexts.txt''. This is relevant if you use translations

			It has the following default content:

	HT_DailyRain = " "		HT_DailyRain = " "

HansR: /* Operation */

2022-10-08T04:21:12Z

Operation

← Older revision		Revision as of 04:21, 8 October 2022
Line 11:		Line 11:
	# The charts in the menu ''Graphs'' assemble the Info text from the ''file CUhelptexts.txt'' where the website owner has his help texts.		# The charts in the menu ''Graphs'' assemble the Info text from the ''file CUhelptexts.txt'' where the website owner has his help texts.

	The CutilsCharts.def for the ChartsCompiler is described [[ChartsCompiler\|~~elsewhere~~]].		The ''CutilsCharts.def'' for the ChartsCompiler is described [[ChartsCompiler\|on the ChartsCompiler page]].

	The CUhelptexts.txt file resides in the utils directory ~~and~~ has the following default content:		The ''CUhelptexts.txt'' file resides in the utils directory an will be created when it does not exist: run CumulusUtils once without an argument. It has the following default content:

	HT_DailyRain = " "		HT_DailyRain = " "

HansR: /* Other remarks */

2022-10-08T04:19:01Z

Other remarks

← Older revision		Revision as of 04:19, 8 October 2022
Line 52:		Line 52:
	The ''Info'' keyword in the ChartsCompiler will eventually be unified with the CUhelptexts.txt file system when an unambiguous merge can be constructed.		The ''Info'' keyword in the ChartsCompiler will eventually be unified with the CUhelptexts.txt file system when an unambiguous merge can be constructed.

			When errors have been made or the default tag names have been changed and the system no longer works, just remove the CUhelptexts.txt file and rerun CumulusUtils without argument.

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

HansR: /* Operation */

2022-10-08T04:17:45Z

Operation

← Older revision		Revision as of 04:17, 8 October 2022
Line 7:		Line 7:

	= Operation =		= Operation =
	~~There~~ are currently two ~~technical~~ systems:		Technically there are currently two systems:
	# The charts generated through the [[ChartsCompiler]] have the [[Charts_Definition_Language_(CDL)#Info_specifier\|keyword Info in CDL]]		# The charts generated through the [[ChartsCompiler]] have the [[Charts_Definition_Language_(CDL)#Info_specifier\|keyword Info in CDL]]
	# The charts in the menu ''Graphs'' assemble the Info text from the ''file CUhelptexts.txt'' where the website owner has his help texts.		# The charts in the menu ''Graphs'' assemble the Info text from the ''file CUhelptexts.txt'' where the website owner has his help texts.

	The CutilsCharts.def for the ChartsCompiler is described elsewhere.		The CutilsCharts.def for the ChartsCompiler is described [[ChartsCompiler\|elsewhere]].

	The CUhelptexts.txt file resides in the utils directory and has the following default content:		The CUhelptexts.txt file resides in the utils directory and has the following default content:
Line 37:		Line 37:
	HT_ClashOfAverages = " "		HT_ClashOfAverages = " "

	The structure is <code><tag> = " <free text> "</code> ; The spaces are obligatory.		The structure is <code><tag> = " <free text> "</code> ; The spaces are obligatory, the tag names are fixed and must not be changed by the user.

	The spaces are obligatory for the parser to recognize the structure of the file and a space between the double quote and the free text between the quotes is also obligatory. The user can write any HTML formatted text between the quotes, in principle of any length (though some restraint is advisable).		The spaces are obligatory for the parser to recognize the structure of the file and a space between the double quote and the free text between the quotes is also obligatory. The user can write any HTML formatted text between the quotes, in principle of any length (though some restraint is advisable).

HansR: /* Output */

2022-10-07T17:45:22Z

Output

← Older revision		Revision as of 17:45, 7 October 2022
Line 44:		Line 44:

	= Output =		= Output =
	The helptexts are assembled in the ~~website~~ ''~~index~~.~~html~~''.		The helptexts are assembled in the different charts files (e.g. ''graphsrain.txt'' and ''cumuluscharts.txt'').

	= Inifile parameters =		= Inifile parameters =

HansR: /* Operation */

2022-10-07T17:43:12Z

Operation

← Older revision		Revision as of 17:43, 7 October 2022
Line 41:		Line 41:
	The spaces are obligatory for the parser to recognize the structure of the file and a space between the double quote and the free text between the quotes is also obligatory. The user can write any HTML formatted text between the quotes, in principle of any length (though some restraint is advisable).		The spaces are obligatory for the parser to recognize the structure of the file and a space between the double quote and the free text between the quotes is also obligatory. The user can write any HTML formatted text between the quotes, in principle of any length (though some restraint is advisable).

	All climate graphs have their own meaningful entry - e.g. HT_DailyRain means ~~Help~~ ~~Text~~ for the ~~Daily~~ ~~Rain~~ chart - and can have their own text. If no text is specified (only white space between the double quotes) the ''Info'' word will not appear in the chart.		All climate graphs have their own meaningful entry - e.g. HT_DailyRain means '''''H'''elp '''T'''ext for the '''D'''aily '''R'''ain'' chart - and can have their own text. If no text is specified (only white space between the double quotes) the ''Info'' word will not appear in the chart.

	= Output =		= Output =

HansR at 17:38, 7 October 2022

2022-10-07T17:38:21Z

@@ Line 2: / Line 2: @@
 CumulusUtils has a help system for the Charts (through the ChartsCompiler) and for the Climate Charts (Graphs menu choice).
-For the website viewer there is no difference: the small word ''info'' appears left of the hamburger menu if there is some Help info available. If it is not, the word Info won't appear.
+For the website viewer there is no difference: the small word ''info'' appears left of the hamburger menu in the chart and when clicked there is some Help info available through a popup modal  window. If it is not available, the word Info won't appear.
 For the owner of the Website is the task to write some information which makes the charts more clear for the viewer.
@@ Line 10: / Line 10: @@
 # The charts generated through the [[ChartsCompiler]] have the [[Charts_Definition_Language_(CDL)#Info_specifier|keyword Info in CDL]]
 # The charts in the menu ''Graphs'' assemble the Info text from the ''file CUhelptexts.txt'' where the website owner has his help texts.
 = Output =
 = Inifile parameters =
 = Other remarks =
 [[Category:CumulusUtils]]

HansR: /* Operation */

2022-10-07T17:16:26Z

Operation

← Older revision		Revision as of 17:16, 7 October 2022
Line 6:		Line 6:
	For the owner of the Website is the task to write some information which makes the charts more clear for the viewer.		For the owner of the Website is the task to write some information which makes the charts more clear for the viewer.

	= Operation =		= Operation =
			There are currently two technical systems:
			# The charts generated through the [[ChartsCompiler]] have the [[Charts_Definition_Language_(CDL)#Info_specifier\|keyword Info in CDL]]
			# The charts in the menu ''Graphs'' assemble the Info text from the ''file CUhelptexts.txt'' where the website owner has his help texts.

	= Output =		= Output =

HansR: /* Introduction */

2022-10-07T17:15:42Z

Introduction

← Older revision		Revision as of 17:15, 7 October 2022
Line 1:		Line 1:
	= Introduction =		= Introduction =
	CumulusUtils has a help system for the Charts (through the ChartsCompiler) and for the Climate Charts (Graphs menu choice). ~~For the website viewer there is no difference: the small word ''info'' appears left of the hamburger menu if there is some Help info available. If it is not, the word Info won't appear.~~		CumulusUtils has a help system for the Charts (through the ChartsCompiler) and for the Climate Charts (Graphs menu choice).

			For the website viewer there is no difference: the small word ''info'' appears left of the hamburger menu if there is some Help info available. If it is not, the word Info won't appear.
⚫	For the owner of the Website is the task to write some information which makes the charts more clear for the viewer.

		⚫	For the owner of the Website is the task to write some information which makes the charts more clear for the viewer.
	There are currently two technical systems:
	# The charts generated through the [[ChartsCompiler]] have the [[Charts_Definition_Language_(CDL)#Info_specifier\|keyword Info in CDL]]
	# The charts in the menu ''Graphs'' assemble the Info text from the ''file CUhelptexts.txt'' where the website owner has his help texts.

	= Operation =		= Operation =

HansR: /* Introduction */

2022-10-07T17:14:37Z

Introduction

← Older revision		Revision as of 17:14, 7 October 2022
Line 1:		Line 1:
	= Introduction =		= Introduction =
			CumulusUtils has a help system for the Charts (through the ChartsCompiler) and for the Climate Charts (Graphs menu choice). For the website viewer there is no difference: the small word ''info'' appears left of the hamburger menu if there is some Help info available. If it is not, the word Info won't appear.

			For the owner of the Website is the task to write some information which makes the charts more clear for the viewer.

			There are currently two technical systems:
			# The charts generated through the [[ChartsCompiler]] have the [[Charts_Definition_Language_(CDL)#Info_specifier\|keyword Info in CDL]]
			# The charts in the menu ''Graphs'' assemble the Info text from the ''file CUhelptexts.txt'' where the website owner has his help texts.

	= Operation =		= Operation =