Module:zh/data/dial/documentation

< Module:zh‎ | data‎ | dial
Documentation for Module:zh/data/dial. [edit]
This page contains usage information, categories, interwiki links and other content describing the module.

This module holds information used by Module:zh-dial-syn (backend for {{zh-dial}}) and Module:zh-dial-map (backend for {{zh-dial-map}}).

Required values edit

Every entry (dialectal location or register) in the table must contain the following properties:

key

The key value used in the data modules. These should be unique.

group
The group to which the dialectal location belongs.
Allowed values
Mandarin, Cantonese, Hakka, Huizhou, Gan, Jin, Jiuxing Yumin, Northern Min, Eastern Min, Southern Min, Puxian Min, Central Min, Shaojiang Min, Zhongshan Min, Southern Pinghua, Northern Pinghua, Waxiang, Wu, Xiang
Special values (not to be used by a variety)
Classical, Formal, Taxonomic

In addition, the following properties are required for a dialectal location:

chinese
The Chinese name of the location.
lat, long
The latitude and longitude of the location.

Optional values edit

The following values are optional:

english
The English name of the location. Defaults to the entry key.
link
The Wikipedia link for the location/variety. Defaults to english (if present), else the entry key.

Naming conventions edit

All dialectal locations in Mainland China are assumed to be the county- or prefecture-level seat unless otherwise specified. Place names should be converted to the current administrative division rather than the division at the time of fieldwork/documentation. Names also should be at the county level unless the location is part of the urban area (i.e. in an urban district) or no county level exists for the given prefecture-level division. All levels below the county level should be specified in brackets only when needed (i.e. when the location in question is not the county-/prefecture-level seat).