Description file

The description file is needed and its file extension is .kgm. It should begin with <!DOCTYPE kgeographyMap>, followed by <map> and end with </map>.

Inside of those tags there should be:

  • <mapFile> and </mapFile>: the name of the file (without any path) containing the map image, e.g. europe.png.

  • <name> and </name>: the name of map, e.g. Europe.

  • <divisionsName> and </divisionsName>: the general name of divisions in this map, that is, Provinces, States, Countries, etc.

  • A <division> and </division> for each division in the map.

Each division has these tags:

  • <name> and </name>: the name of the division, e.g. Albania.

  • <capital> and </capital>: the name of the capital of the division, e.g. Tirana.

  • <ignore> and </ignore>: can be set to yes, allowClickMode, allowClickFlagMode and no. If this tag is set to yes then the division will be ignored when asking for divisions in that map. It is then as if this division does not exist in KGeography quiz modes. If this tag is set to allowClickMode then KGeography will ask for the division in the Location of ... mode but not in other quiz modes. If this tag is set to allowClickFlagMode then KGeography will ask for the division in the Location of ... mode and in the flag related quizes but not in other quiz modes. Setting this tag to no means the division will appear in all modes (browse and quizzes). This tag is optional and when there is no <ignore> tag that means as it is set to no. For example Algeria has this tag set to yes in the Europe map which means that Algeria will not be part of any quiz in the Europe map.

  • <flag> and </flag>: the file (without any path) containing the flag of the division, e.g. albania.png. This tag is optional. Not needed for the divisions whose <ignore> tag is set to yes.

  • <color> and </color>: the color the division has in the map.

  • <falseCapital> and </falseCapital>: There can be any number of falseCapital pairs, they are used to provide a list of false answers to the capital question instead of choosing the false answers amongst the other divisions capitals.

The color is defined using three tags:

  • <red> and </red>: red component of the color. Valid values are between 0 and 255.

  • <green> and </green>: green component of the color. Valid values are between 0 and 255.

  • <blue> and </blue>: blue component of the color. Valid values are between 0 and 255.

Tip

It is convenient to create 2 or 3 false divisions like Water, Frontier and Coast and set them with the <ignore> tag set to yes. Don't forget not to set color for any Frontier 0,0,0 in RGB. Please make it something like 1,1,1 so that a border outline comes while placing any division on the map.

Important

All names (capitals and divisions) must be in English.