Help:Ergebnisformat calendar

From semantic-mediawiki.org
Jump to: navigation, search
Ergebnisformat calendar
Gibt Seiten, die Datumsangaben enthalten, in einem Kalender aus
Weitere Informationen
Software: Semantic Result Formats
Verfügbar seit: 1.4.0
Verfügbar bis: aktuell unterstützt
Voraussetzungen: keine
Name: calendar
Standardmäßig aktiviert:
Gibt an, ob das Ergebnisformat standardmäßig mit Installation der betreffenden Softwareerweiterung aktiviert ist.
ja
Autoren: Yaron Koren
Kategorie(n): Zeit
Inhaltsverzeichnis

Das Ergebnisformat calendar wird dazu eingesetzt Abfrageergebnisse, (Spezial:Semantische Suche, eingebettete Abfragen), die Datumsangaben enthalten, in einem Kalender darzustellen. Es wird Semantic MediaWiki von der Softwareerweiterung Semantic Result Formats (SRF) bereitgestellt.

Parameter

Die folgende Tabelle gibt einen Überblick über die verfügbaren Parameter, beschreibt sie kurz und gibt deren Standardwerte mitsamt dem zugehörigen Eingabetyp an.

Parameter Typ Standard Beschreibung
lang Text no Der Sprachcode der Sprache, in der der Kalender angezeigt werden soll
template Text leer <srf-paramdesc-template>
userparam Text leer <srf-paramdesc-userparam>
color Text leer <srf-paramdesc-color>
colors Text leer Die für das jeweilige Datumsattribut zur Darstellung zu verwendende Farbe (Beispiel: „Startdatum=>green,Enddatum=>#09C“)
startmonth Text 12 Der Monat, der im Kalender zunächst angezeigt wird (Standard ist der aktuelle Monat)
startyear Text 2016 Das Jahr, das im Kalender zunächst angezeigt wird (Standard ist das aktuelle Jahr)

Nutzung

{{#ask:
[[Kategorie:Veranstaltung]]
[[Hat Datum::>{{#calendarstartdate:}}]]
[[Hat Datum::<{{#calendarenddate:}}]]
| ?Hat Datum
| format=calendar
}}

Als Ergebnis werden alle Seiten ausgegeben, auf denen zum Attribut „Hat Datum“ ein Wert hinterlegt wurde, der zwischen den mit #calendarstartdate und #calendarenddate festgelegten Datumsangaben liegt. Dem Attribut muss dabei der Datentyp Datum zugeordnet sein. Das mit der Ausgabeanweisung abgefragte Attribut „Hat Datum“ muss zudem in der vorausgehenden Abfrageanweisung zum Filtern genutzt werden. Die Parserfunktionen #calendarstartdate und #calendarenddate stehen dabei für den ersten sowie letzten Tag des jeweils im Kalender ausgewählten Monats. Es handelt sich also um einen dynamischen Filter.

Hinweise zum Erstellen der Abfrage
  • Die beiden Parserfunktionen #calendarstartdate und #calendarenddate müssen wie im Beispiel gezeigt angegeben werden, also auch den folgenden Doppelpunkt sowie die geschweiften Klammern haben.
  • Die beiden Komparatoren < und > bedeuten, unabhängig von der Festlegung für das Wiki mit der Parameter $smwStrictComparators stets „kleiner als oder gleich zu“ sowie „größer als oder gleich zu“.
  • Innerhalb der Ausgabeanweisung kann auch der Parameter „sort=“ genutzt werden, bspw. „sort=Hat Datum“, so dass die Datumsangaben auch sortiert werden können.

Anzeigeparameter

Die Farbe in der die ausgegebenen Kalendereinträge angezeigt werden solle, kann mit dem Parameter „color=“ angegeben werden:
| color=red
Die Softwareerweiterung Semantic Compound Queries ermöglicht zusätzliche Farbgebungen je Termingruppe.
Der Parameter „template=“, bspw. „template=<Name der Vorlage> kann dazu genutzt werden, die Anzeige der einzelnen Einträge weiter anzupassen:
| template=<Name der Vorlage>
Weitergehende Informationen hierzu sind auf der Hilfeseite zum Ergebnisformat template vorhanden.

Der Parameter „limit=“, bspw. „limit=150“ kann dazu genutzt werden, die Anzeige der einzelnen Einträge auf die jeweils angegebene Anzahl zu beschränken:

| Limit=150
Standardmäßig beträgt dieser Wert 20. Problemlos können allerdings Werte bis 500 angegeben werden. Darüber liegende Werte sind erst nach Anpassung der Konfigurationsparameters $smwgQMaxInlineLimit in der Datei LocalSettings.php möglich.
Seit SRF 1.6.0 kann für die Darstellung des Kalenders auch der Anfangstag der Woche festgelegt werden, der standardmäßig der Sonntag ist. Diese Einstellung wird für das gesamte Wiki in der Datei LocalSettings.php mit dem Konfigurationsparameter $srfgFirstDayOfWeek unterhalb der Aktivierungszeile zur Softwareerweiterung SRF vorgenommen. Für ein deutschsprachiges Wiki gibt man also
$srfgFirstDayOfWeek = 'Montag';
an. Es ist wichtig, daß dabei das deutsche Wort des Tages genutzt wird.

Beispiel

Ein Beispiel zur Nutzung dieses Ergebnisformates auf der Seite mit dem Kalender auf Discourse DB einsehbar.



Diese Dokumentationsseite gilt für alle SMW-Versionen von 1.6.0 bis zur aktuellsten Version.
      Andere Sprachen: enfrzh-hans

Help:Calendar format de 1.6.0