specification of dictionaries

[petermr]

No description provided.

[petermr]

dictionary specification

dictionary name

• all names of dictionaries should be lowercase ([a-z][a-z_]+)
• the filename should be <dictionary_name>.xml
• the root of the dictionary (dictionary) must have a title attribute of dictionary_name,

Examples

• disease
  *test_trace

Not allowed

• disease2019
• testTrace

[petermr]

dictionary elements

dictionary

• this must be the single root element of the dictionary

dictionary attributes

• title. equal to dictionary_name
• date - latest date of editing. Should be created by machine

child elements

metadata

Descriptions of how the dictionary was created or edited, notes on usage, etc.
Mandatory, repeatable.

desc

Deprecated. replace by metadata

entry

Mandatory, repeatable.

entry

• describes a single term in the dictionary

attributes

term

Formal term (in EN) for the entry . [0-9a-zA-Z_-]. mandatory.

description

wikidataID

[(P|Q)\d+]

Example

Q1128437

wikidataURL

Normally the (single) resolvable URL

example

https://www.wikidata.org/wiki/Q1128437

wikipediaPage

The page of the EN-language wikipedia article (i.e. without http address). Note this will NOT have spaces (usually escaped with '_') and may have URL-encoded characters.

example

Contact_tracing

wikipediaURL

The address/URL of the EN-language wikipedia article

example

https://en.wikipedia.org/wiki/Contact_tracing

name

id

child elements

synonym

description

see_also

description

description of the term/entry (normally from Wikidata)

attributes

xml:lang

description in alternative languages

synonym

synonym of the term/entry (often from Wikidata)

xml:lang

description in alternative languages

related

Allowance for linking to related information, e.g. countrys for organizations. Not yet fully specified.

notes

• the language variants must be represented as child elements, not attributes.

[petermr]

WE WILL CONTINUE DETAILED PLANNING ON https://github.com/petermr/dictionary/wiki/ . Please use this Issue for general concerns and comments.