Event::getByKey

Aus iTrack
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→‎type)
(Änderung 37510 von 119.252.88.23 (Diskussion) rückgängig gemacht.)
 
(87 dazwischenliegende Versionen von 20 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
__NOTOC__
+
{|class="function"
−
{|class="toc overview"
+
 
|+Übersicht
 
|+Übersicht
 
!Modul
 
!Modul
−
|[[Events|Event]]
+
|[[Integration von Events|Event]]
 
|-
 
|-
 
!Name
 
!Name
Zeile 15: Zeile 14:
 
|-
 
|-
 
!HTML-ID
 
!HTML-ID
−
|<code>#event</code>
+
|<code>#page</code> (opt.)
 
|-
 
|-
−
!CSS
+
!HTML-Klasse
−
|nein
+
|<code>.event</code><br /><code>.pages</code> (opt.)<br /><code>.selector</code> (opt.)<br /><code>.stats</code> (opt.)
 
|-
 
|-
−
!JavaScript
+
!Technik
−
|keine
+
|[[#CSS-Definitionen|CSS]]<br />[[#JavaScript|JavaScript]]
 
|-
 
|-
 
!Parameter
 
!Parameter
−
|<code>[[#display|display]]<br />[[#file|file]]<br />[[#num|num]]<br />[[#theme|theme]]<br />[[#top|top]]<br />[[#type|type]]<hr />[[#depth|depth]] (obsolet)<br />[[#state|state]] (obsolet)</code>
+
|<code>[[#css|css]]<br />[[#display|display]]<br />[[#file|file]]<br />[[#items|items]]<br />[[#limit|limit]]<br />[[#link|link]]<br />[[#offset|offset]]<br />[[#priority|priority]]<br />''sort''<br />[[#theme|theme]]<br />[[#top|top]]<br />'''[[#type|type]]'''</code>
 
|}
 
|}
−
Ausgabe einer Liste von Events anhand eines Schlüssels
+
Ausgabe einer Gruppe von Events als Liste anhand eines Musters
 +
 
 +
<!--HTML-ID <code>#page</code> und JavaScript werden für die Seitenauswahl eingesetzt.-->
  
 
==Parameter==
 
==Parameter==
 +
====css====
 +
{| class="parameter"
 +
|+Übersicht
 +
!Bedeutung
 +
|Einbindung von CSS
 +
|-
 +
!Verwendung
 +
|optional
 +
|-
 +
!Typ
 +
|Integer
 +
|-
 +
!Werte
 +
|<code>0<br />1</code>
 +
|-
 +
!Standard
 +
|<code>1</code>
 +
|}
 +
<div>
 +
Folgende Konstanten stehen zur Verfügung:
 +
*<code>0</code><br />Ausgabe ohne CSS
 +
*<code>1</code><br />Ausgabe mit CSS
 +
</div>
 +
 +
<!--
 +
====depth====
 +
Anzahl der übergeordneten Gliederungs-Ebenen (Integer).
 +
obsolet
 +
 +
-->
 +
 
====display====
 
====display====
−
{| class="toc overview"
+
{| class="parameter"
 
|+Übersicht
 
|+Übersicht
 
!Bedeutung
 
!Bedeutung
 
|Darstellungsmodus
 
|Darstellungsmodus
 
|-
 
|-
−
!Typ
+
!Verwendung
 
|optional
 
|optional
 
|-
 
|-
−
!Wert
+
!Typ
 
|Integer
 
|Integer
 +
|-
 +
!Werte
 +
|<code>EVT_SHORT<br />EVT_SUMMARY<br />EVT_COMPLETE</code>
 
|-
 
|-
 
!Standard
 
!Standard
−
|<code>EVT_COMPLETE</code>
+
|<code>EVT_SUMMARY</code>
 
|}
 
|}
−
Darstellungsmodus
+
<div>
−
 
+
 
Folgende Konstanten stehen zur Verfügung:
 
Folgende Konstanten stehen zur Verfügung:
 
*<code>EVT_SHORT</code><br />kurze Darstellung
 
*<code>EVT_SHORT</code><br />kurze Darstellung
 
*<code>EVT_SUMMARY</code><br />kurze Darstellung mit Zusammenfassung
 
*<code>EVT_SUMMARY</code><br />kurze Darstellung mit Zusammenfassung
 
*<code>EVT_COMPLETE</code><br />komplette Darstellung
 
*<code>EVT_COMPLETE</code><br />komplette Darstellung
 +
Bei der Darstellung <code>EVT_COMPLETE</code> enthält die Ausgabe eine Seitenstatistik sowie ggf. eine Möglichkeit zur Seitenauswahl. Diese Darstellungsart sollte daher nur einmal pro Seite vorkommen.
 +
</div>
  
 
====file====
 
====file====
−
{| class="toc overview"
+
{| class="parameter"
 
|+Übersicht
 
|+Übersicht
 
!Bedeutung
 
!Bedeutung
−
|Pfad zur Masterdatei
+
|DateiPfad
 
|-
 
|-
−
!Typ
+
!Verwendung
 
|optional
 
|optional
 
|-
 
|-
−
!Wert
+
!Typ
 
|String
 
|String
 +
|-
 +
!Werte
 +
|gültige URL-Zeichen
 
|-
 
|-
 
!Standard
 
!Standard
 
|<code>null</code>
 
|<code>null</code>
 
|}
 
|}
−
Pfad zur Masterdatei
+
<div>
−
 
+
In Abhängigkeit des Parameters <code>[[#display|display]]</code> hat dieser Parameter zwei Bedeutungen:
 +
*<code>display = EVT_COMPLETE</code><br />Pfad zur Datei, die die Übersicht der Events dieses Typs anzeigt. Wenn angegeben, wird der Link <code>Übersicht...</code> angezeigt.
 +
*sonstige Werte<br />Pfad zur Datei, die ggf. das Event vollständig anzeigt (MasterDatei). Wenn angegeben, wird der Link <code>mehr...</code> angezeigt.
 
Es sind absolute sowie relative Pfadangaben möglich.
 
Es sind absolute sowie relative Pfadangaben möglich.
  
−
====num====
+
Der Linktext wird vorgegeben oder kann mit <code>[[#link|link]]</code> bestimmt werden.
−
{| class="toc overview"
+
</div>
 +
 
 +
====items====
 +
{| class="parameter"
 
|+Übersicht
 
|+Übersicht
 
!Bedeutung
 
!Bedeutung
−
|Event-Anzahl
+
|Anzahl SeitenItems
 
|-
 
|-
−
!Typ
+
!Verwendung
 
|optional
 
|optional
 
|-
 
|-
−
!Wert
+
!Typ
 
|Integer
 
|Integer
 +
|-
 +
!Werte
 +
|pos. Zahlen
 
|-
 
|-
 
!Standard
 
!Standard
 
|<code>0</code>
 
|<code>0</code>
 
|}
 
|}
−
Event-Anzahl
+
<div>
 +
Anzahl der Events, die auf einer Seite dargestellt werden
 +
</div>
  
 +
====limit====
 +
{| class="parameter"
 +
|+Übersicht
 +
!Bedeutung
 +
|Max. Anzahl anzuzeigender Events
 +
|-
 +
!Verwendung
 +
|optional
 +
|-
 +
!Typ
 +
|Integer
 +
|-
 +
!Werte
 +
|pos. Zahlen
 +
|-
 +
!Standard
 +
|<code>0</code>
 +
|}
 +
<div>
 
Maximale Anzahl der anzuzeigenden Events. 0 für alle.
 
Maximale Anzahl der anzuzeigenden Events. 0 für alle.
 +
</div>
  
−
====priority====
+
====link====
−
{| class="toc overview"
+
{| class="parameter"
 
|+Übersicht
 
|+Übersicht
 
!Bedeutung
 
!Bedeutung
−
|EventPriorität
+
|Linktext
 +
|-
 +
!Verwendung
 +
|optional
 
|-
 
|-
 
!Typ
 
!Typ
 +
|String
 +
|-
 +
!Werte
 +
|Text
 +
|-
 +
!Standard
 +
|<code>null</code>
 +
|}
 +
<div>
 +
Wenn Sie bei diesem Parameter einen Text angeben, wird dieser als Link angezeigt. Vorraussetzung ist, daß ein Link mit <code>[[#file|file]]</code> definiert ist.<br />'''experimentell'''
 +
</div>
 +
 +
====offset====
 +
{| class="parameter"
 +
|+Übersicht
 +
!Bedeutung
 +
|Ausgabeversatz
 +
|-
 +
!Verwendung
 
|optional
 
|optional
 
|-
 
|-
−
!Wert
+
!Typ
 
|Integer
 
|Integer
 +
|-
 +
!Werte
 +
|pos. Zahlen
 +
|-
 +
!Standard
 +
|<code>0</code>
 +
|}
 +
<div>Verwenden Sie diesen Parameter, wenn die Ausgabe von Items erst an der Stelle <code>offset</code> beginnen soll.</div>
 +
 +
====priority====
 +
{| class="parameter"
 +
|+Übersicht
 +
!Bedeutung
 +
|Priorität
 +
|-
 +
!Verwendung
 +
|optional
 +
|-
 +
!Typ
 +
|Integer
 +
|-
 +
!Werte
 +
|<code>EVT_NORMAL<br />EVT_HIGH</code>
 
|-
 
|-
 
!Standard
 
!Standard
 
|<code>EVT_NORMAL</code>
 
|<code>EVT_NORMAL</code>
 
|}
 
|}
−
EventPriorität
+
<div>
 +
Über die Priorität bestimmen Sie, ob besondere Events verwandter Gliederungen angezeigt werden sollen.
  
−
Bei hoher Priorität werden auch Events der nächsttieferen Gliederungs-Ebene sowie der Schwester-Verbände derselben Ebene angezeigt. Dies ist bei der Darstellung der Gesamtübersicht äußerst empfehlenswert.
+
Wenn Sie für die Priorität <code>EVT_HIGH</code> einstellen, werden auch Events der direkt untergeordneten Gliederungen sowie anderer Gliederungen der eigenen Region. Voraussetzung ist dabei, daß auch die Events eine hohe Priorität haben.
  
−
:<u>'''Beispiel:'''</u><br />Bei der FDP Unterfranken werden so auch Events der Kreisverbände sowie z.B. der JuLis Unterfranken angezeigt.
+
Folgende Konstanten stehen zur Verfügung:
 +
*<code>EVT_NORMAL</code><br />normale Priorität
 +
*<code>EVT_HIGH</code><br />hohe Priorität
 +
</div>
  
−
Zur Auswahl stehen die Werte:
+
====sort====
−
'''NICHT AKTUELL'''
+
{| class="parameter"
−
  EVT_NORMAL..............Priorität normal
+
|+Übersicht
−
  EVT_HIGH................Priorität hoch
+
!Bedeutung
 +
|Sortierung
 +
|-
 +
!Verwendung
 +
|optional
 +
|}
 +
<div>
 +
Bestimmt die Sortierung der Ausgabe.<br />'''Noch nicht implementiert'''
 +
</div>
 +
 
 +
<!--
 +
====state====
 +
Status
 +
obsolet
 +
:Ist kein Status gesetzt, werden ausschließlich nicht interne Events abgezeigt.<br />Ist der Status auf intern gesetzt, erhält man ausschließlich die Internen. Dies ist derzeit bei Events im Mitgliederbereich der Fall.
 +
:Zur Auswahl stehen die Werte:
 +
  NORMAL..............normal  
 +
  INTERN..............intern
 +
-->
  
 
====theme====
 
====theme====
−
{| class="toc overview"
+
{| class="parameter"
 
|+Übersicht
 
|+Übersicht
 
!Bedeutung
 
!Bedeutung
 
|Thema
 
|Thema
 
|-
 
|-
−
!Typ
+
!Verwendung
 
|optional
 
|optional
 
|-
 
|-
−
!Wert
+
!Typ
 
|Integer
 
|Integer
 +
|-
 +
!Werte
 +
|siehe [[Verwaltung|Verwaltungsbereich]]
 
|-
 
|-
 
!Standard
 
!Standard
 
|<code>0</code>
 
|<code>0</code>
 
|}
 
|}
−
Thema
 
−
 
 
Themen spezifizieren ein Event inhaltlich. Sie sind hierarchisch geordnet.
 
Themen spezifizieren ein Event inhaltlich. Sie sind hierarchisch geordnet.
  
−
Die aktuell gültigen Werte finden Sie Verwaltungsbereich unter dem Menupunkt <code>Events &rarr; Konstanten</code>.
+
Die aktuell gültigen Werte finden Sie im Verwaltungsbereich unter dem Menupunkt <code>Events &rarr; Konstanten</code>.
 
<!--
 
<!--
 
Zur Auswahl stehen die Werte:
 
Zur Auswahl stehen die Werte:
Zeile 149: Zeile 286:
  
 
====top====
 
====top====
−
{| class="toc overview"
+
{| class="parameter"
 
|+Übersicht
 
|+Übersicht
 
!Bedeutung
 
!Bedeutung
−
|übergeordneten Gliederungs-Ebenen
+
|Anzahl übergeordneter<br />Gliederungs-Ebenen
 
|-
 
|-
−
!Typ
+
!Verwendung
 
|optional
 
|optional
 
|-
 
|-
−
!Wert
+
!Typ
 
|Integer
 
|Integer
 +
|-
 +
!Werte
 +
|pos. Zahlen
 
|-
 
|-
 
!Standard
 
!Standard
 
|<code>0</code>
 
|<code>0</code>
 
|}
 
|}
 +
<div>
 
Anzahl der übergeordneten Gliederungs-Ebenen
 
Anzahl der übergeordneten Gliederungs-Ebenen
  
 
Hiermit wird festgelegt, bis zu welcher übergeordneten Ebene Events angezeigt werden.
 
Hiermit wird festgelegt, bis zu welcher übergeordneten Ebene Events angezeigt werden.
 
Beispiel: Eine 1 bei der FDP Unterfranken zeigt auch Events der FDP Bayern mit an.
 
Beispiel: Eine 1 bei der FDP Unterfranken zeigt auch Events der FDP Bayern mit an.
 +
</div>
  
 
====type====
 
====type====
−
{| class="toc overview"
+
{| class="parameter"
 
|+Übersicht
 
|+Übersicht
 
!Bedeutung
 
!Bedeutung
 
|EventTyp
 
|EventTyp
 
|-
 
|-
−
!Typ
+
!Verwendung
−
|erforderlich
+
|<span class="required">erforderlich</span>
 
|-
 
|-
−
!Wert
+
!Typ
 
|Integer
 
|Integer
 +
|-
 +
!Werte
 +
|siehe [[Verwaltung|Verwaltungsbereich]]
 
|-
 
|-
 
!Standard
 
!Standard
 
|<code>0</code>
 
|<code>0</code>
 
|}
 
|}
−
EventTyp
+
<div>
−
 
+
 
EventTypen bestimmen die grundlegende Darstellung eines Events (so haben z.B. News eine andere HTML-Struktur als Termine). Sie sind hierarchisch geordnet. Auf der obersten Ebene finden Sie die HauptTypen, die im Wesentlichen die Darstellung festlegen.
 
EventTypen bestimmen die grundlegende Darstellung eines Events (so haben z.B. News eine andere HTML-Struktur als Termine). Sie sind hierarchisch geordnet. Auf der obersten Ebene finden Sie die HauptTypen, die im Wesentlichen die Darstellung festlegen.
  
−
Die aktuell gültigen Werte finden Sie Verwaltungsbereich unter dem Menupunkt <code>Events &rarr; Konstanten</code>.
+
Die aktuell gültigen Werte finden Sie im Verwaltungsbereich unter dem Menupunkt <code>Events &rarr; Konstanten</code>.
 +
</div>
 
<!--
 
<!--
 
Zur Auswahl stehen die Werte:
 
Zur Auswahl stehen die Werte:
Zeile 248: Zeile 393:
 
===Bedeutung der Parameter===
 
===Bedeutung der Parameter===
 
-->
 
-->
−
----
 
−
----
 
−
----
 
  
−
====state====
+
==Fehlermeldungen==
−
Status
+
''keine''
−
:'''obsolete'''
+
−
:Ist kein Status gesetzt, werden ausschließlich nicht interne Events abgezeigt.<br />Ist der Status auf intern gesetzt, erhält man ausschließlich die Internen. Dies ist derzeit bei Events im Mitgliederbereich der Fall.
+
−
:Zur Auswahl stehen die Werte:
+
−
NORMAL..............normal
+
−
INTERN..............intern
+
  
−
====depth====
+
==Technik==
−
Anzahl der übergeordneten Gliederungs-Ebenen (Integer).
+
===HTML-Struktur===
−
:'''obsolete'''
+
 
 +
===CSS-Definitionen===
 +
;<nowiki>#</nowiki>page
 +
:Seitennavigation
 +
;.event
 +
:Liste der Events
 +
;.pages
 +
:Anzeige der Seitenzahlen
 +
;.selector
 +
:Auswahl der Seitenzahlen
 +
;.stats
 +
:Seitenstatistik
 +
 
 +
===JavaScript===
 +
<code>initPage</code>
  
 
[[Category:Webmaster]]
 
[[Category:Webmaster]]
 
[[Category:Module]]
 
[[Category:Module]]
 
[[Category:Events]]
 
[[Category:Events]]

Aktuelle Version vom 13. Januar 2012, 21:18 Uhr

Übersicht
Modul Event
Name getByKey
URL http://lib.itrack.de/event/?getByKey
HTML-TAG UL
HTML-ID #page (opt.)
HTML-Klasse .event
.pages (opt.)
.selector (opt.)
.stats (opt.)
Technik CSS
JavaScript
Parameter css
display
file
items
limit
link
offset
priority
sort
theme
top
type

Ausgabe einer Gruppe von Events als Liste anhand eines Musters


Inhaltsverzeichnis

[Bearbeiten] Parameter

[Bearbeiten] css

Übersicht
Bedeutung Einbindung von CSS
Verwendung optional
Typ Integer
Werte 0
1
Standard 1

Folgende Konstanten stehen zur Verfügung:

  • 0
    Ausgabe ohne CSS
  • 1
    Ausgabe mit CSS


[Bearbeiten] display

Übersicht
Bedeutung Darstellungsmodus
Verwendung optional
Typ Integer
Werte EVT_SHORT
EVT_SUMMARY
EVT_COMPLETE
Standard EVT_SUMMARY

Folgende Konstanten stehen zur Verfügung:

  • EVT_SHORT
    kurze Darstellung
  • EVT_SUMMARY
    kurze Darstellung mit Zusammenfassung
  • EVT_COMPLETE
    komplette Darstellung

Bei der Darstellung EVT_COMPLETE enthält die Ausgabe eine Seitenstatistik sowie ggf. eine Möglichkeit zur Seitenauswahl. Diese Darstellungsart sollte daher nur einmal pro Seite vorkommen.

[Bearbeiten] file

Übersicht
Bedeutung DateiPfad
Verwendung optional
Typ String
Werte gültige URL-Zeichen
Standard null

In Abhängigkeit des Parameters display hat dieser Parameter zwei Bedeutungen:

  • display = EVT_COMPLETE
    Pfad zur Datei, die die Übersicht der Events dieses Typs anzeigt. Wenn angegeben, wird der Link Übersicht... angezeigt.
  • sonstige Werte
    Pfad zur Datei, die ggf. das Event vollständig anzeigt (MasterDatei). Wenn angegeben, wird der Link mehr... angezeigt.

Es sind absolute sowie relative Pfadangaben möglich.

Der Linktext wird vorgegeben oder kann mit link bestimmt werden.

[Bearbeiten] items

Übersicht
Bedeutung Anzahl SeitenItems
Verwendung optional
Typ Integer
Werte pos. Zahlen
Standard 0

Anzahl der Events, die auf einer Seite dargestellt werden

[Bearbeiten] limit

Übersicht
Bedeutung Max. Anzahl anzuzeigender Events
Verwendung optional
Typ Integer
Werte pos. Zahlen
Standard 0

Maximale Anzahl der anzuzeigenden Events. 0 für alle.

[Bearbeiten] link

Übersicht
Bedeutung Linktext
Verwendung optional
Typ String
Werte Text
Standard null

Wenn Sie bei diesem Parameter einen Text angeben, wird dieser als Link angezeigt. Vorraussetzung ist, daß ein Link mit file definiert ist.
experimentell

[Bearbeiten] offset

Übersicht
Bedeutung Ausgabeversatz
Verwendung optional
Typ Integer
Werte pos. Zahlen
Standard 0
Verwenden Sie diesen Parameter, wenn die Ausgabe von Items erst an der Stelle offset beginnen soll.

[Bearbeiten] priority

Übersicht
Bedeutung Priorität
Verwendung optional
Typ Integer
Werte EVT_NORMAL
EVT_HIGH
Standard EVT_NORMAL

Über die Priorität bestimmen Sie, ob besondere Events verwandter Gliederungen angezeigt werden sollen.

Wenn Sie für die Priorität EVT_HIGH einstellen, werden auch Events der direkt untergeordneten Gliederungen sowie anderer Gliederungen der eigenen Region. Voraussetzung ist dabei, daß auch die Events eine hohe Priorität haben.

Folgende Konstanten stehen zur Verfügung:

  • EVT_NORMAL
    normale Priorität
  • EVT_HIGH
    hohe Priorität

[Bearbeiten] sort

Übersicht
Bedeutung Sortierung
Verwendung optional

Bestimmt die Sortierung der Ausgabe.
Noch nicht implementiert


[Bearbeiten] theme

Übersicht
Bedeutung Thema
Verwendung optional
Typ Integer
Werte siehe Verwaltungsbereich
Standard 0

Themen spezifizieren ein Event inhaltlich. Sie sind hierarchisch geordnet.

Die aktuell gültigen Werte finden Sie im Verwaltungsbereich unter dem Menupunkt Events → Konstanten.

[Bearbeiten] top

Übersicht
Bedeutung Anzahl übergeordneter
Gliederungs-Ebenen
Verwendung optional
Typ Integer
Werte pos. Zahlen
Standard 0

Anzahl der übergeordneten Gliederungs-Ebenen

Hiermit wird festgelegt, bis zu welcher übergeordneten Ebene Events angezeigt werden. Beispiel: Eine 1 bei der FDP Unterfranken zeigt auch Events der FDP Bayern mit an.

[Bearbeiten] type

Übersicht
Bedeutung EventTyp
Verwendung erforderlich
Typ Integer
Werte siehe Verwaltungsbereich
Standard 0

EventTypen bestimmen die grundlegende Darstellung eines Events (so haben z.B. News eine andere HTML-Struktur als Termine). Sie sind hierarchisch geordnet. Auf der obersten Ebene finden Sie die HauptTypen, die im Wesentlichen die Darstellung festlegen.

Die aktuell gültigen Werte finden Sie im Verwaltungsbereich unter dem Menupunkt Events → Konstanten.


[Bearbeiten] Fehlermeldungen

keine

[Bearbeiten] Technik

[Bearbeiten] HTML-Struktur

[Bearbeiten] CSS-Definitionen

#page
Seitennavigation
.event
Liste der Events
.pages
Anzeige der Seitenzahlen
.selector
Auswahl der Seitenzahlen
.stats
Seitenstatistik

[Bearbeiten] JavaScript

initPage

Von „https://www.itrack.info/index.php?title=Event::getByKey&oldid=37515“
Meine Werkzeuge
Namensräume

Varianten
Aktionen
Navigation
Werkzeuge