article-Objekt

Eine Seite enthält 0..n Artikel. Benutzer von Zeta Producer geben ihre Daten in Artikeln ein, z.B. ein Text-Artikel, ein Bild-Artikel oder auch umfangreichere Artikel wie ein Gästebuch oder ein Veranstaltungskalender. Ein Artikel ist innerhalb eines paragraphColumn-Objekts definiert und dieses wiederum innerhalb eines paragraph-Objekts.

Die Artikel sind als Widgets definiert. In der JSON-Datei eines Widgets ist festgelegt, welche Werte der Benutzer eingeben kann; in der HTML-Datei eines Widgets ist festgelegt, wie diese eingegebenen Werte auf der erstellten HTML-Seite dargestellt werden.

Sie werden auf das article-Objekt hauptsächlich per Skripting innerhalb der HTML-Datei ("Partial") eines Widgets zugreifen.

active

Syntax: article.active

Boolescher Wert, der angibt, ob der Artikel sichtbar oder unsichtbar ist.

Ein unsichtbarer Artikel verhält sich wie ein gelöschter Artikel; er ist in der erstellten HTML-Seite nicht enthalten. Der Vorteil gegenüber dem Löschen ist, dass Sie den Artikel jederzeit wieder sichtbar machen können.

Die Eigenschaft active gibt sowohl dann false zurück, wenn der Artikel inaktiv/unsichtbar ist, als auch wenn dieser, aufgrund der konfigurierten Sichtbarkeit, zum Zeitpunkt des Erstellens der Seite nicht angezeigt wird.

area

Syntax: article.area

Der Name des Bereichs auf der Seite, in dem sich der Artikel befindet (bzw. die Spalte und der Absatz des Artikels).

Werte sind z.B. "standard" oder "news".

column

Syntax: article.column

Gibt ein paragraphColumn-Objekt mit der Spalte zurück, in dem sich der Artikel befindet.

cssBackgroundImage

Syntax: article.cssBackgroundImage(key) : cssBackgroundImage

Liefert ein articleCssBackgroundImage-Objekt für den angegebenen Schlüssel (String) zurück, sofern sich ein CSS-Hintergrund-Bild-Element an dieser Stelle befindet.

cssBackgroundImageSimple

Syntax: article.cssBackgroundImageSimple(key) : cssBackgroundImageSimple

cssClass

Syntax: article.cssClass

Der vom Benutzer im erweiterten Artikel-Bearbeiten-Dialogfenster eingegebene CSS-Klassen-Name.

Im Widget muss die Eingabe einer CSS-Klasse für den Benutzer manuell aktiviert werden, damit dieser die CSS-Klasse eingeben kann.

Beispiel:

<div class="<$= article.cssClass $>">
</div>

Verfügbar ab Version 13

getOverviewArticles

Syntax: article.getOverviewArticles(additionalFilterCondition)

Gibt eine Liste von article-Objekten zurück, sofern der aktuelle Artikel ein Article-Übersichts-Artikel ist.

Die Angabe des Filters ist optional.

headline

Syntax: article.headline

Die Überschrift des Artikels. Dieser Wert kann leer sein, wenn der Benutzer keine Überschrift eingegeben hat.

headlineAlign

Syntax: article.headlineAlign

Die horizontale Ausrichtung der Überschrift Artikel.

Mögliche Werte sind:

  • left - Linksbündig.
  • center - Zentriert.
  • right - Rechtsbündig.

headlineColor

Syntax: article.headlineColor

Die Farbe der Überschrift des Artikels als fertig zu benutzende Farbcode-Zeichenfolge. Wenn keine Farbe ausgewählt ist, wird eine leere Zeichenfolge zurückgegeben.

Zurückgegebene Werte können z.B. #3345F8 sein, oder auch rgba(215, 40, 40, 0.9), falls der Benutzer einen Transparenzwert in der Farbe definiert hat.

headlineLevel

Syntax: article.headlineLevel

Die Überschriften-Ebene des Artikels. Mögliche Werte sind h1, h2, h3 (entspricht den Überschriften-Tags H1, H2, H3).

id

Syntax: article.id

Die interne Datenbank-ID des Artikels.

inlineCss

Syntax: article.inlineCss

Der vom Benutzer im erweiterten Artikel-Bearbeiten-Dialogfenster eingegebene Inline-CSS-Code.

Im Widget muss die Eingabe von Inline-CSS-Code für den Benutzer manuell aktiviert werden, damit dieser den Inline-CSS-Code eingeben kann.

Beispiel:

<div style="<$= article.inlineCss $>">
</div>

Verfügbar ab Version 13

inArea()

Syntax: article.inArea(name)

Prüft ob der Artikel sich in dem angegebenen Bereich (z.B. "news") befindet und gibt einen booleschen Wert zurück.

inherited

Syntax: article.inherited

Gibt an, ob der Artikel ein vererbter Artikel ist oder nicht. Gibt einen booleschen Wert zurück.

modifyDate

Syntax: article.modifyDate

Das Datum, an dem der Artikel zuletzt geändert wurde.

page

Syntax: article.page

Gibt ein page-Objekt mit der Seite zurück, in dem sich der Artikel befindet.

Beispiel:

<div class="article">
    <p>Die Seiten-ID ist <$= article.page.id $>.</p>
</div>

paragraph

Syntax: article.paragraph

Gibt ein paragraph-Objekt mit dem Absatz zurück, in dem sich der Artikel befindet.

render()

Syntax: article.render(makeAllRenderedUrlsAbsolute : object = null)

Generiert den HTML-Code des fertigen Artikels.

Diese Funktion nimmt das HTML-Template, das im Widget des Artikels definiert ist, ruft den Skript-Code darin auf, ersetzt alle Platzhalter und liefert das Ergebnis als Zeichenfolge zurück.

Beispiel:

<div class="article">
    <$= article.render() $>
</div>

tabular()

Syntax: article.tabular(key)

Liefert ein articleTabularData-Objekt für den angegebenen Schlüssel (String) zurück, sofern sich ein Tabellarisches-Daten-Element an dieser Stelle befindet.

url

Syntax: article.url

Die relative URL des Artikels. Das entspricht der URL der Seite, auf der sich der Artikel befindet sowie der Sprungmarke innerhalb der Seite, um direkt zum Artikel zu scrollen.

value()

Syntax: article.value(key, fallBack = null)

Liefert einen vom Benutzer eingegebenen/ausgewählten Wert des Artikels.

  • key - Der Name des Werts, der gelesen werden soll. Das entspricht den "name"-Einträgen der "fields"-Liste in der "widget.json"-Datei.
  • fallBack - Falls der Wert nicht gefunden wurde, kann optional beim Aufruf der Funktion ein Wert angegeben werden, der zurückgeliefert wird.

Der Rückgabewert ist kommt immer mit dem richtigen Datentyp zurück, also z.B. als boolescher Wert, ganze Zahl oder Fließkommazahl. Das kann wichtig bei der weiteren Verarbeitung im JavaScript werden, so dass Sie z.B. keinen parseInt()-Aufruf machen müssen.

valueExpanded()

Syntax: article.valueExpanded(key, fallBack = null, makeAllRenderedUrlsAbsolute : object = null)

Verhält sich analog zur value()-Funktion mit dem Unterschied, dass etwaige im zurückgegeben Wert enthalten Skript-Aufrufe und Platzhalter bereits expandiert sind.

valueRaw()

Syntax: article.valueRaw(key, fallBack = null)

Verhält sich analog zur value()-Funktion mit dem Unterschied, dass der Rückgabewert immer als Zeichenfolge zurückgegeben wird und der Datentyp nicht geändert wird.

Es werden also z.B. auch boolesche Werte und Zahlen immer als Zeichenfolge zurückgegeben.

widgetName

Syntax: article.widgetName

Der Name (uiname) des Widgets, das für den Artikel verwendet wird. Z.B. "Button" oder "Konfiguration / Warenkorb".

widgetValue()

Syntax: article.widgetValue(key, fallBack = null)

Liefert einen vom Benutzer eingegebenen/ausgewählten Wert aus den Settings des Widgets in der Datei "widget.json".

Der Rückgabewert ist kommt immer mit dem richtigen Datentyp zurück, also z.B. als boolescher Wert, ganze Zahl oder Fließkommazahl. Das kann wichtig bei der weiteren Verarbeitung im JavaScript werden, so dass Sie z.B. keinen parseInt()-Aufruf machen müssen.