Skip to content

Location entry

Horațiu Mlendea edited this page Jan 18, 2021 · 20 revisions

Description

This entry represents a toponym (settlement, region, etc), a title (knightly order, religious orders, etc) or an administrative unit (kingdom, country, etc).

Example

  <LocationEntity>
    <!-- The unique identifier of the location entity -->
    <Id>exemplaria</Id> 

    <!-- List of game IDs of titles that will use the names of this location.
         Please keep it sorted first by game (alphabetically) and then by tier -->
    <GameIds> 
      <GameId game="CK2">b_exemplaria</GameId>
      <GameId game="CK2HIP">b_exemplaria</GameId>
      <GameId game="CK3">b_exemplaria</GameId>
      <GameId game="CK3">c_exemplaria</GameId>
    </GameIds>

    <!-- The list of fallback locations to take names from
         The order in which the IDs are put here is the order of priority (highest first) -->
    <FallbackLocations>
      <LocationId>fallback_primary</LocationId>
      <LocationId>fallback_secondary</LocationId>
    </FallbackLocations>

    <!-- Explicit names for this location, one line per language variant -->
    <Names>
      <Name language="Latin" value="Nomen" comment="It's in latin!" />
      <Name language="English_Old" value="Name in old english" />
      <Name language="English" value="Name in modern english" adjective="Nameian" />
    </Names>
  </LocationEntity>

Note: Since the location exemplaria in the example above does not have a Romanian name defined explicitly, one will be searched for within the fallback locations. So if there is a Romanian name in fallback_primary, it will be used also for exemplaria, and if not, the one from fallback_secondary if it exists, and so on.

Fields

  • Id
  • GeoNamesId (Optional)
  • WikidataId (Optional)
  • GameIds
  • FallbackLocations (Optional)
  • Names

Id

It is a unique identifier for a location

Conventions:

  • Should be human-friendly
  • Should provide enough identifying information
  • Should be all lowercase
  • Underscores should be used instead of spaces

Example:

<Id>visegrad_hungary</Id> <!-- "_hungary" to distinguish it from the one in Serbia -->

GeoNamesId

It is an optional field that holds the location's ID in the GeoNames database

GeoNames is a huge database that contains (among other things) alternative names in many languages for many locations around the world. The purpose of this field is to make it quick and easy to find that location in the database.

Example:

<GeoNamesId>2803448</GeoNamesId> <!-- the GeoNames location ID for Aalst -->

WikidataId

It is an optional field that holds the location's ID on Wikidata

Wikidata contains (among other things) alternative names in many languages for many locations around the world.

The purpose of this field is to make it quick and easy to find that location on the website.

Example:

<WikidataId>Q159818</WikidataId> <!-- the page for Travnik on Wikidata -->

GameIds

FallbackIds

It is an optional field that holds a list of IDs of other location entries whose names will be used for the current one for the languages that do not have one already explicitly defined.

Example: If the ardeal location does not have an english name, it can fallback to transylvania and use the english name from there instead. However, if both have a romanian name, then the one from ardeal (being the main title in this context) will be used.

Example:

<FallbackLocations>
  <LocationId>muntenia</LocationId> <!-- primary -->
  <LocationId>wallachia</LocationId> <!-- secondary -->
</FallbackLocations>

Names

It is a field that holds a list of name definitions.

Each name must have at least the language and value attributes.

Optionally, the adjective and the comment attributes can also be included.

Example 1:

<Name language="Catalan" value="Gran Valàquia" />

Example 2:

<Name language="Romanian" value="Muntenia" adjective="Muntenesc" comment="Wallachia in romanian" />
Clone this wiki locally