Help System: Difference between revisions

82 bytes added ,  04:17, 8 October 2022
m
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).