2,005
edits
Help System: Difference between revisions
m
→Operation
m (→Operation) |
m (→Operation) |
||
| (4 intermediate revisions by the same user not shown) | |||
|
= Operation =
# 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 ''CutilsCharts.def'' for the ChartsCompiler is described
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_ClashOfAverages = " "
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).
= Output =
The helptexts are assembled in the
= Inifile parameters =
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]]
| |||