PerfektesChaos: m

2019-12-12T13:25:34Z

← Nächstältere Version		Version vom 12. Dezember 2019, 15:25 Uhr
Zeile 86:		Zeile 86:
	*; qualifiers		*; qualifiers
	*: Permitted within <code>claims.values</code> only.		*: Permitted within <code>claims.values</code> only.
	*: Sequence table, of [[#Qualifier\|Qualifier]]		*: Sequence table, of [[#Qualifier\|Qualifier]] each.
	*; [[#example\|example]]		*; [[#example\|example]]
	*; [[#terminate\|terminate]]		*; [[#terminate\|terminate]]
Zeile 93:		Zeile 93:
	This is rather similar to <code>claims</code>.		This is rather similar to <code>claims</code>.
	* One single qualifier.		* One single qualifier.
	* ~~Sequence~~ table, with each element as mapping table of the following (mostly optional) components:		* Element of a sequence table, with each element as mapping table of the following (mostly optional) components:
	*; [[#subject\|subject]]		*; [[#subject\|subject]]
	*: Mandatory.		*: Mandatory.

PerfektesChaos: +

2019-12-11T21:35:22Z

Änderungen zeigen

PerfektesChaos: Setup

2019-12-11T12:00:25Z

Setup

Neue Seite

{{LuaModuleDoc}}
This page describes the data structure used for a '''WikidataScheme specification'''.
* The structure applies to both [[JavaScript Object Notation|JSON]] and [[Lua]] table.
A [[#root|root]] element is to be provided.

== Building blocks ==

=== EntityName ===
This can be either:
* A [[Wikidata]] entity ID, beginning with P, Q, L and followed by digits: <code>[[d:Q1|Q1]]</code><code></code>
* A symbolic name.
** This is required to be resolved by [[#NameResolver|NameResolver]].

=== NameResolver ===
This is a mapping table <code>resolve</code> in [[#root|root]] element which assigns:
* symbolic name
* mapping table as follows:
** assign a ''number'' to (at least) one of the components <code>P</code>, <code>Q</code>, <code>L</code>.
** Basically more than one component may be present, but the first one found in that order will be used.
The motivation to use a symbolic name is:
* The thematic description becomes more intuitive; described by self explaining words only.
* An entity used in several places may change pointer at once.
* The assignment may differ in development. Just apply another resolving map. Actually there are three different Wikibase installations available:
*# Productive Wikidata https://www.wikidata.org/
*# WMF test Wikidata
*# BETA Wikidata (wmflabs)
Naturally, all expected symbolic names are to be resolved, otherwise an error is shown in displayed table.

The [[../#JSON|JSON]] function may be used to resolve all symbolic names and generates pretty formatted JSON with entity IDs only.

=== TextVariant ===
This can be either:
* A ''string'', with [[Wikidata]] entity ID only, beginning with P, Q, L and followed by digits (label will be used)
* A ''string'', with constant text otherwise
* A mapping ''table'', which assigns an [[ISO 639]] / BCP47 key to a text ''string''.
** There should be always present at least: <syntaxhighlight lang="json" style="white-space:nowrap" inline>{ "en": "Fallback text" }</syntaxhighlight>
** In addition to language codes, the following two components are processed:
***; class
***: Sequence table (array) or ''string'' with class names for this text element
***; style
***: Mapping table or ''string'' with [[Cascading Style Sheets|CSS]] for this text element
The resulting strings may contain basic markup:
* For italic and bold, <code><nowiki>''</nowiki></code> and <code><nowiki>'''</nowiki></code> wikisyntax
* Internal links, with <code style="white-space:nowrap"><nowiki>[[double bracket]]</nowiki></code> syntax, beginning with global project prefix.
* External links, with <code style="white-space:nowrap"><nowiki>[single bracket]</nowiki></code> syntax, beginning with protocol ''http https ftp''.
* Whitelisted HTML elements, like ''span div bdi bdo code pre ul ol li dl dt dd em strong b i table caption tr th td''.

=== Entry ===
This is used for both <code>claims</code> and <code>qualifiers</code>.
* Both are a sequence table, with each element as mapping table of the following components:
*; subject
*: Property name, P-number or symbolic name resolved by [[#NameResolver|NameResolver]] as P-number.
*; intro
*: General description, introduction
*: [[#TextVariant|TextVariant]]
*; state
*: One of: <code>"required"</code>, <code>"suggested"</code>, <code>"deprecated"</code>, otherwise <code>"optional"</code>
*; values
*: Sequence table (array) of mapping tables. Each with the following components:
*:; q
*:: The one and only permitted value as item
*:: [[#EntityName|EntityName]] as Q-number.
*:: Must not be used together with <code>qlist</code>.
*:; qlist
*:: Sequence table (array) of items.
*::* [[#EntityName|EntityName]] as Q-number.
*::* Last element may be <code>true</code> which indicates that other items than explicitly mentioned are permitted as well.
*:: Must not be used together with <code>q</code>.
*; qualifiers
*: Permitted within <code>claims</code> only.
*: [[#Entry|Entry]]
*; example
*: Example value, text
*: [[#TextVariant|TextVariant]]
*; terminate
*: Final remarks
*: [[#TextVariant|TextVariant]]
*; class
*: Sequence table (array) or ''string'' with class names for entire unit
*; style
*: Mapping table or ''string'' with [[Cascading Style Sheets|CSS]] for entire unit

== {{Anker|root}} Root Element ==
Using all definitions of [[#Parts|parts ]], the specification is defined as follows:
* Mapping table created from the following components:
*; caption
*: Table or gadget title
*: [[#TextVariant|TextVariant]]
*; onLabel
*: Naming convention and expectations on label text
*: [[#TextVariant|TextVariant]]
*; onDesc
*: Formatting and expectations on description text
*: [[#TextVariant|TextVariant]]
*; onAlias
*: Formatting and expectations on aliases texts
*: [[#TextVariant|TextVariant]]
*; claims
*: Statements (actually mandatory)
*; footer
*: Terminating hints, remarks, legend
*: [[#TextVariant|TextVariant]]
*; id
*: ''string'', selector for entire table
*; class
*: Sequence table (array) or ''string'' with class names for entire table
*; style
*: Mapping table or ''string'' with [[Cascading Style Sheets|CSS]] for entire table
*; options
*: Mapping table, override local /config
*; resolve
*: Mandatory if symbolic names occurring.
*: [[#NameResolver|NameResolver]]
* While all components are optional a specification without <code>claims</code> is pointless.
* More components are permitted but not evaluated.

== JSON and Lua ==
* A ''mapping table'' in Lua is an ''object'' <code style="white-space:nowrap">{ }</code> in JSON.
* A ''sequence table'' in Lua is an ''Array'' <code style="white-space:nowrap">[ ]</code> in JSON.
* Both textual JSON and Lua tables may be provided.
* Lua specifications may be generated by general module call, or by providing a generating <code style="white-space:nowrap">mw.loadData()</code> page name.
* A number of specifications may be created programmatically, e.g. fundamentals of a human being, then forking into opera singer, rock & pop musisicians, composer, painter, writer, …

== Example ==
{{#rel2abs:../../GlobalSharing/Wikidata}}

Wikipedia:Lua/Modul/WikidataScheme/Specification - Versionsgeschichte

PerfektesChaos: m

PerfektesChaos: +

PerfektesChaos: Setup