The access to the help.txt file happens by keywords. There are some predefined keywords that must be contained in the help.txt, e.g. the keyword START. But you can also introduce additional keywords in order to create new manual pages. Keywords always stand at the beginning of a line and are lead by a '#' character.
Some of the keywords mark phrase collections. These are the keywords ADVHELP, IMPHELP, FEATUREHELP, GOVHELP, TECHAGE, SPECIALMODEL and JOBHELP. Each line below such a keyword contains a different phrase. The lines are numbered within such phrase collections, so a correct line structure is essential. For example, the 4th line after IMPHELP must always be the description for the Colossus.
In contrast, for all the other keywords, the line structure is ignored. The complete text until the next '#' character will be interpreted as a single phrase. This also applies to every keyword that you introduce.
These advanced formattings apply to both collection and non-collection keywords. A '\' character forces a line break in the manual text. All additional formattings are indicated by a special character sequence following to a '\' and apply to all following text until the next '\' or until the end of the phrase. Combining different formattings is not possible.
The available formattings are:
|-||Text appears as listed item.|
|!||Text appears highlighted.|
|!!||Text appears highlighted and with a decorated start letter.|
|$||Text is used as manual page title.|
|:X||Text appears as link to a manual page, which is described under the keyword X. This can be a predefined keyword or one that you introduced.|
|::A||Text appears as link to list of all advances.|
|::Ax||Text appears as link to advance No. x. See file protocol.pas from the game source code for advance numbers, e.g. ::A50 links to the manual page about Metallurgy, because adMetallurgy=50.|
|::B||Text appears as link to list of all city improvements.|
|::B201||Text appears as link to list of all national projects and colony ship parts.|
|::B202||Text appears as link to list of all wonders.|
|::Bx||Text appears as link to building No. x. This can be a city improvement, national project or wonder. See file protocol.pas from the game source code for building numbers, e.g. ::B50 links to the manual page about the Sewer System, because imSewer=50.|
|::T||Text appears as link to list of all terrain types.|
|::Tx||Text appears as link to certain terrain type. x is the number of the base terrain type, optionally +12 for the first special terrain or +24 for the second one. See file protocol.pas from the game source code for terrain numbers, e.g. ::T22 links to the manual page about Wine, because fHills=10, 10+12=22.|
|::F||Text appears as link to list of all unit features.|
|::Fx||Text appears as link to unit feature No. x. See file protocol.pas from the game source code for feature numbers, e.g. ::F21 links to the manual page about Stealth, because mcStealth=21.|
|::J||Text appears as link to list of all terrain improvements.|
|::G||Text appears as link to list of all government forms.|
|::S||Text appears as link to list of all special units.|
|::E1||Text appears as link to AI development manual on hard disk.|
|::E2||Text appears as link to project homepage.|
|::E3||Text appears as link to email contact.|
|::C||Text appears as link to credits page.|
|@X||Displays image with file name X.bmp, which must be located in the help folder. Note that one manual page can only contain one image.|
|@@x||Generates a b/w illustration from icon No. x from icons.bmp.|
|&LOGO||Displays C-evo logo.|
|&TECHFORMULA||Displays correct research cost formula for current difficulty level.|
|&TREATIES||Displays list of possible nation treaties.|
|&EXPERIENCE||Displays list of possible unit experience levels.|
|&MODERN||Displays list of modern resources.|
Meaning of the colors:
Blue - No restrictions
Green - Character Sequence must be seperated from following text by a blank.
Red - Character Sequence must not be followed by any text.
Within the manual, there is a visual distinction between a content reference and a cross reference. It is desirable to have exactly one content reference to every manual page, while all other references are cross references. The table above shows the syntax of cross references. The content reference syntax is the same but with a ";" character in the beginning instead of a ":".
Small icons can be placed inside the text using one of the following %-sequences:
You must use double % for phrases that contain %d or %s.