1,651
edits
Help System: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Operation
m (→Operation) |
m (→Operation) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
= Operation = | = Operation = | ||
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 | The ''CutilsCharts.def'' for the ChartsCompiler is described [[ChartsCompiler|on the ChartsCompiler page]]. | ||
The CUhelptexts.txt file resides in the utils directory | 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 = " " | ||
| 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). | ||
| Line 44: | Line 44: | ||
= Output = | = Output = | ||
The helptexts are assembled in the | The helptexts are assembled in the different charts files (e.g. ''graphsrain.txt'' and ''cumuluscharts.txt''). | ||
= Inifile parameters = | = Inifile parameters = | ||
| 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]] | ||
