PerfektesChaos: +

2022-12-15T16:30:43Z

← Nächstältere Version		Version vom 15. Dezember 2022, 18:30 Uhr
Zeile 42:		Zeile 42:
	Das Kürzel ist Bezeichner für eine Gruppe, etwa <code>"A"</code> oder <code>"SG"</code>.		Das Kürzel ist Bezeichner für eine Gruppe, etwa <code>"A"</code> oder <code>"SG"</code>.

	Kürzel dürfen recht frei gewählt werden, unter ~~zwei~~ Bedingungen:		Kürzel dürfen recht frei gewählt werden, unter einigen Bedingungen:
	* ~~erstes~~ Zeichen ~~darf nicht~~ <code>-</code> sein		* Die Zeichen <code>#</code> <code>.</code> und Leerzeichen dürfen nicht enthalten sein.
	* ~~erstes~~ Zeichen darf nicht <code>#</code> sein		* Erstes Zeichen darf nicht <code>-</code> sein.
			Bei den Kürzeln sind Groß- und Kleinschreibung signifikant.
	Kürzel werden wie vorgefunden als Spaltenüberschriften von Tabellen verwendet.
			* Jedoch dürfen keine zwei Kürzel sich gleichen, wenn Groß- und Kleinschreibung ignoriert werden.

	== Objekt ==		== Objekt ==

PerfektesChaos: Setup

2022-12-05T21:14:10Z

Setup

Neue Seite

{{LuaModuleDoc}}

Das Objekt (etwa als JSON-Seite) hat die auf dieser Seite beschriebene Struktur.

== JSON-Syntax ==
Es gelten die allgemeinen Regeln der [[JavaScript Object Notation]]:
* Zeichenketten werden in <code>"</code> eingeschlossen.
** Sie dürfen keine anderen <code>"</code> enthalten. Besser wären typografische Anführungszeichen, in HTML-Syntax Apostrophe <code>'</code>.
** Ansonsten gäbe es Escaping mittels <code>\"</code> oder ggf. <code>&qout;</code>.
** Zeilenumbrüche sind unzulässig (ohne besondere Maßnahmen).
* Zuweisungen bestehen aus einem Bezeichner, der in <code>"</code> einzuschließen ist, einem Doppelpunkt  <code>:</code> und dann dem Wert.
* Zugewiesene Werte können die folgenden Datentypen haben:
** Zeichenkette
** Anderes Objekt in <code style="white-space:nowrap">{ }</code>.
*** Benannte Komponenten <code style="white-space:nowrap">"X": "sowas"</code><code style="white-space:nowrap"></code> werden durch Kommata voneinander getrennt.
** Zahl, aus Ziffern (usw.)
** Array, geordnete Aufzählung in <code style="white-space:nowrap">[ ]</code>.
*** Elemente werden durch Kommata voneinander getrennt.
** Boolescher Wert, <code>true</code> oder <code>false</code>.
* Kommentare wie in [[JavaScript]] sind nicht möglich.
** Objekte können jedoch eine Komponente [[#comment|"comment"]] aufnehmen.

Für JSON im Wiki gilt:
* Der Quelltext wird nach Abspeicherung automatisch formatiert; es lohnen sich keine Mühen zum Layout.

Über die allgemeinen Regeln hinaus gilt für diese Anwendung:
* Eine leere Zeichenkette <code>""</code> wird in der Regel als nicht vorhandene Zuweisung betrachtet.
** Sie kann also „geparkt“ werden.
* In jedem Objekt ist einmalig eine Komponente <code style="white-space:nowrap">"comment": "Memo"</code> möglich. {{Anker|comment}} Sie wird nirgends ausgewertet und kann Hinweise für die spätere Quelltextbearbeitung aufnehmen.
* Bis auf den Typ Array ist die Reihenfolge der Elemente in einem Objekt bedeutungslos.
** Es empfiehlt sich jedoch, sie in immer gleicher Weise im Quelltext anzuordnen, damit sich alle durchfinden und nichts doppelt versucht wird. Diese Reihenfolge ergibt sich aus der Sortierung der Nicks, der Dokumentation auf dieser Seite hier sowie aus der Reihenfolge der Kürzel und der Chronologie.
* Ein Objekt kann eine Pflichtkomponente haben; das ist dann eine Zeichenkette. In einer Kurzfassung kann das Objekt durch allein diese Zeichenkette ersetzt werden, was inhaltlich gleichwertig ist.

=== Fehlersuche ===
* Wird vor dem Speichern eines geänderten Quelltextes die Vorschau genutzt, ergibt sich entweder eine tabellarische Struktur oder es erscheint eine unspezifische Fehlermeldung.
* Die Webseite [https://jsonlint.com/ jsonlint.com] und weitere erlauben eine genauere Online-Analyse.

=== Beispiele ===
Siehe Quelltext von [[MediaWiki:Gadget-markAdmins/userGroups.json]].

== Kürzel ==
Das Kürzel ist Bezeichner für eine Gruppe, etwa <code>"A"</code> oder <code>"SG"</code>.

Kürzel dürfen recht frei gewählt werden, unter zwei Bedingungen:
* erstes Zeichen darf nicht <code>-</code> sein
* erstes Zeichen darf nicht <code>#</code> sein
Kürzel werden wie vorgefunden als Spaltenüberschriften von Tabellen verwendet.

== Objekt ==
Dieses Objekt hat zwei Komponenten:
# [[#Benutzerkonten-Objekt|Benutzerkonten-Objekt]]
# [[#Kürzel-Objekt|Kürzel-Objekt]]

=== Benutzerkonten-Objekt ===
Es ist die Komponente <code>"accounts"</code> des Haupt-Objekts.
* Es ist ein Objekt.
* Es weist jedem Bezeichner eines Benutzerkontos (Nick) Eigenschaften zu.
* Die Groß- und Kleinschreibung des ersten Buchstabens ist signifikant, <code>Nicky</code> und <code>nicky</code> gelten als unterschiedliche Konten.
** Für die Darstellung wird exakt diese Schreibung benutzt.
* Die Reihenfolge im Quelltext sollte immer die lexikalische Reihenfolge sein, wie sie auch in Gesamtauflistungen erscheint, damit niemand verwirrt wird.
** Es sind gleichwertig: <code>ÄÖÜäöüß</code> und <code>AOUaouss</code> usw.
** Ansonsten gilt die [[American Standard Code for Information Interchange|ASCII]]-Reihenfolge.

=== Benutzerkonto-Element ===
Dieses wird einem Benutzerkonto zugewiesen.

''Es kann sein:''
; Zeichenkette
: Kürzel der Gruppe
: <code>"A"</code>
; Array
: Auflistung mehrerer Gruppenzugehörigkeiten in Amtsperioden
; Objekt
: [[#Benutzerkonto-Objekt|Benutzerkonto-Objekt]]

=== Benutzerkonto-Objekt ===
Dieses Objekt ist die vollständige Struktur für ein Benutzerkonto. Kurzformen als vereinfachtes [[#Benutzerkonto-Element|Benutzerkonto-Element]] sind gleichrangig.

''Die Komponenten können sein:''
; gender
: Zeichenkette, mit
:* <code>"f"</code> oder ''Frau'' oder ''female''; erster Buchstabe ohne Groß- und Kleinschreibung ist maßgeblich
:** Sollte insbesondere bei noch aktiven Benutzerkonten immer kongruent sein.
:** Bei historischen Benutzerkonten kann es nach persönlicher Kenntnis zugeordnet werden.
:* <code>"m"</code> oder ''Mann'' oder ''male''; erster Buchstabe ohne Groß- und Kleinschreibung ist maßgeblich – explizit männlich
:* Keine Angabe oder alles andere ist undefinierte Geschlechtszuordnung.
In den frühen Jahren der Wiki-Software gab es gar keine Geschlechtszuordnung, später weiblich und nicht-weiblich.
; groups
: ''Pflichtangabe''
: Gruppenzugehörigkeiten
: Wert kann sein:
:* Array mit Liste von Gruppenzugehörigkeiten (Kürzel oder [[#Gruppen-Objekt|Gruppen-Objekt]])
:** Die Reihenfolge ist für die Darstellung signifikant.
:** Dieselbe Gruppe kann in mehreren Mandatsperioden erscheinen.
:* Zeichenkette: Kürzel der Gruppe – <code>"A"</code>
:* [[#Gruppen-Objekt|Gruppen-Objekt]]
; alias
: ehemals / späterer Nick der Person; auch Zweitkonten
:* Zeichenkette: früherer Nick
:* [[#Alias-Objekt|Alias-Objekt]]; dort auch weitere Hinweise
:* Array mit mehreren Alias-Angaben
; real
: Klarname
; died
: Zeichenkette, mit <code>"+"</code> oder Datum oder <code>true</code>
; details
: Zeichenkette, ausführliche Zusatzinformationen als Wikitext
; page
: Benutzerseite abweichend von Standardseite, etwa in anderem Wiki

''Alternativ dazu ist möglich:''
; renamed
: Zeichenkette, mit neuem, aktuellen Konto, für das ein Eintrag definiert wurde

=== Gruppen-Objekt ===
Dieses Objekt ist die vollständige Struktur für eine Mandatsperiode in einer Funktion. Die Kurzform als reines Kürzel ist gleichrangig.

''Die Komponenten können sein:''
; code
: ''Pflichtangabe''
: Gruppen-Kürzel
; from
: Wahl oder Ernennung
: Wert kann sein:
:* Zeichenkette mit Datum (<code style="white-space:nowrap">JJJJ-MM-TT</code> bevorzugt und sicherer)
:* [[#Datumsobjekt|Datumsobjekt]]; dort auch mehr zu den Formaten
; to
: Ende, wie bei <code>from</code>
: Wert kann sein:
:* Zeichenkette mit Datum (<code style="white-space:nowrap">JJJJ-MM-TT</code> bevorzugt und sicherer)
:** <code>"-"</code> ist ein unbekanntes aber vorgefallenes Datum; wird nicht dargestellt
:** <code>"?"</code> oder <code>"???"</code> ist ein unbekanntes aber vorgefallenes Datum; wird sichtbar dargestellt
:* [[#Datumsobjekt|Datumsobjekt]]
:* <code>true</code> ist ein unbekanntes aber vorgefallenes Datum; wird nicht dargestellt
: Wenn kein Ende vermerkt wurde, oder das Ende in der Zukunft liegt, gilt die Funktionsausübung als noch aktiv.
; on
: Beginn einer Wahlperiode, die nicht mit der wahrgenommenen Amtszeit zusammenfällt
: Werte wie vor; etwa Zeichenkette
; off
: Ende einer Wahlperiode, die nicht mit der wahrgenommenen Amtszeit zusammenfällt
: Werte wie vor; etwa Zeichenkette
; state
: Status
:* <code>"member"</code> ''(Vorgabe)'' – Gruppenmitglied
:* <code>"ping"</code> – nur nachrichtlich
; info
: Kurze Standard-Info als Wikitext
; suffix
: Fußnote zur <code>info</code> als Wikitext

=== Datumsobjekt ===
Das Datumsobjekt kann verschiedenen Zeitpunkten zugeordnet werden. Die Kurzform ist die einfache Zeichenkette.

Als Format sollte immer <code style="white-space:nowrap">JJJJ-MM-TT</code> benutzt werden („ISO“), auch nur <code>JJJJ</code> oder <code style="white-space:nowrap">JJJJ-MM</code>. Andere Datumsnotationen werden in Tabellen auch gleichberechtigt dargestellt, jedoch in verschiedenen Software-Auswertungen nicht interpretiert.

''Die Komponenten können sein:''
; date
: ''Pflichtangabe''
: Zeichenkette, mit Datumsangabe
; sort
: Falls <code>date</code> nicht als konkretes Datum dargestellt werden kann („Herbst 2003“), kann hier ein ISO-Tag für die softwareseitige Auswertung angegeben werden.
; vsn
: Versionsnummer einer Seite, zur Bildung einer Verlinkung
:* ganze Zahl
:* Zeichenkette, auch mit <code>#fragment</code>
; log
: Logbuch-ID, zur Bildung einer Verlinkung (ganze Zahl)
; prefix
: fremdes Projekt, zur Bildung einer Verlinkung mit <code>vsn</code> usw. (Zeichenkette)
; page
: Wikilink-Zielseite, zur Bildung einer Verlinkung (Zeichenkette)

In der Reihenfolge <code>vsn</code> → <code>log</code> → <code>page</code> werden die Angaben für die Darstellung ausgewertet.
* Mehrfachangaben sind jedoch möglich.
Die Verlinkungen sind für Kandidatur-Wahl-Seiten, Erklärung der Rückgabe der Rechte, Kondolenzlisten usw. vorgesehen.

=== Alias-Objekt ===
Dieses Objekt ist die vollständige Struktur für einen alternativen Nick. Die Kurzform als reine Zeichenkette für ehemalige Konten ist gleichrangig.

''Die Komponenten können sein:''
; account
: ''Pflichtangabe''
: Zeichenkette, mit Nick
; later
: <code>true</code> – später
; link
: <code>true</code> – Verlinkung generieren
; suffix
: Fußnote; als Wikitext

=== Kürzel-Objekt ===
Dieses Objekt gibt optionale Zusatzinformationen für die Darstellung. Es ist die Komponente <code>"codes"</code> des Haupt-Objekts.

Es hat zwei optionale Komponenten:
* <code>"groups"</code> – Objekt, das den Gruppen-Kürzeln jeweils ein [[#Gruppe-Objekt|Gruppe-Objekt]] zuordnet
* <code>"order"</code> – [[#Reihenfolge|Reihenfolge]] der Gruppen

=== Gruppe-Objekt ===
Jede Gruppen-Komponente ist ein Gruppe-Objekt zum Kürzel und kann die folgenden Komponenten enthalten:
; support
: Zeichenkette, mit Kurzmemo/Tooltipp
; see
: Zeichenkette, mit Projektseite zur Verlinkung

=== Reihenfolge ===
Mit dem Array <code>order</code> können die Kürzel der Gruppen in eine logische Reihenfolge gebracht werden. Andernfalls würde alphabetische Sortierung erfolgen.

Wikipedia:Lua/Modul/UserGroups/Datenstruktur/de - Versionsgeschichte

PerfektesChaos: +

PerfektesChaos: Setup