page-Objekt
Das page-Objekt erlaubt den Zugriff auf die Eigenschaften einer einzelnen Seite.
- absoluteUrl
- active
- anyAreaArticles()
- areas
- articles
- articlesInArea()
- attribute()
- containers()
- description
- extension
- extraMenu
- getAttribute
- hasArea()
- id
- isSpecialPage()
- keywords
- lastChange
- level
- name
- nofollow
- objectId
- objectIdUri
- pages
- paragraphs()
- parentPage
- parentPageId
- pathToRoot
- projectFolder
- searchTerms
- setAttribute
- target
- title
- type
- url
- value()
- valueExpanded()
- valueRaw()
- visible
- cssBackgroundImageSimple
- cssBackgroundImage
- areaCssClass
- areaInlineCss
absoluteUrl
Syntax: page.absoluteUrl
Die absolute URL der Seite, komplett mit der öffentlichen Web-URL.
active
Syntax: page.active
Boolescher Wert, der angibt, ob die Seite aktiv oder inaktiv ist.
Inaktive Seiten werden nicht erstellt und nicht auf den Webserver kopiert, sind also physikalisch nicht vorhanden. Wir eine ehemals aktive Seite deaktiviert, wird sie beim nächsten Veröffentlichungs-Vorgang vom Webserver gelöscht.
anyAreaArticles()
Syntax: page.anyAreaArticles(name)
Boolescher Wert, der angibt, ob es im Bereich mit dem angegebenen Namen (z.B. "news") Artikel zum Anzeigen gibt.
areas
Syntax: page.areas
Liefert eine Liste aller auf der Seite verfügbaren Bereichsnamen.
Beispiel:
<$
var areas = page.areas;
for ( var i=0; i<areas.count; ++i ) {
var area = areas.item(i);
// Gibt z.B. "Standard" aus.
context.write(area);
}
$> articles
Syntax: page.articles
Ermittelt eine Liste mit 0..n Artikel-Objekten vom Typ article, aus allen Spalten in allen Absätzen der Seite.
Über die Liste kann mit einer for-Schleife iteriert werden:
countist die aktuelle Anzahl von Artikeln in der Liste.item(index)liefert den Artikel am angegebenen Index (0-basiert).
articlesInArea()
Syntax: page.articlesInArea(name)
Ermittelt eine Liste mit 0..n Artikel-Objekten vom Typ article, aus allen Spalten in allen Absätzen im angegebenen Bereich mit dem Namen name in der Seite.
Über die Liste kann mit einer for-Schleife iteriert werden:
countist die aktuelle Anzahl von Artikeln in der Liste.item(index)liefert den Artikel am angegebenen Index (0-basiert).
attribute()
Syntax: page.attribute(name, fallBack = null)
Liest ein Seiten-Attribut mit dem angegebenen Namen. Ist das Attribut nicht vorhanden, dann wird der Standardwert aus dem fallBack-Parameter zurückgegeben.
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.
containers()
Syntax: page.containers(areaName : string, hideEmpty : bool = false)
Ermittelt eine Liste mit 0..n Container-Objekten vom Typ container, dem Bereich areaName.
Über die Liste kann mit einer for-Schleife iteriert werden:
countist die aktuelle Anzahl von Containern in der Liste.item(index)liefert den Conteiner am angegebenen Index (0-basiert).
description
Syntax: page.description
Liefert die Beschreibung der Seite.
Beispiel:
<meta name="description" content="<$= page.description $>" /> Gibt die Seitenbeschreibung als HTML-Meta-Tag aus.
extension
Syntax: page.extension
Der Dateityp der Seite. Z.B. ".html" oder ".php".
extraMenu
Syntax: project.extraMenu : extraMenu
getAttribute
Syntax: page.getAttribute( attributeName : string, fallback : object = null ) : object
hasArea()
Syntax: page.hasArea(name)
Ermittelt, ob es auf der Seite einen Bereich mit dem angegebenen Namen gibt.
id
Syntax: page.id
Die interne Datenbank-ID der Seite.
isSpecialPage()
Syntax: page.isSpecialPage(type : string) : bool
Prüft, ob die Seite eine spezielle Seite ist.
Mögliche Werte für type:
- "legal": Die Impressum-Seite.
keywords
Syntax: page.keywords
Liefert die Keywords der Seite.
Beispiel:
<meta name="keywords" content="<$= page.keywords $>" /> Gibt die Keywords als HTML-Meta-Tag aus.
lastChange
Syntax: page.lastChange
Liefert das Datum der letzten Änderung an der Seite.
level
Syntax: page.level
Liefert die Verschachtelungstiefe als ganze Zahl.
Der Projektordner hat immer den Wert 0, die Hauptseiten haben der Wert 1, deren untergeordnete Seiten den Wert 2, usw.
name
Syntax: page.name
Der Name der Seite, so wie er im Menü erscheint.
nofollow
Syntax: page.nofollow : boolean
objectId
Syntax: page.objectId : string
objectIdUri
Syntax: page.objectIdUri : string
pages
Syntax: page.pages
Ermittelt eine Liste mit 0..n Seiten-Objekten vom Typ page, aller direkt untergeordneten Seiten.
Über die Liste kann mit einer for-Schleife iteriert werden:
countist die aktuelle Anzahl von Seiten in der Liste.item(index)liefert die Seite am angegebenen Index (0-basiert).
paragraphs()
Syntax: page.paragraphs(areaName)
Ermittelt eine Liste mit 0..n Absatz-Objekten vom Typ paragraph, dem Bereich areaName.
Über die Liste kann mit einer for-Schleife iteriert werden:
countist die aktuelle Anzahl von Absätzen in der Liste.item(index)liefert den Absatz am angegebenen Index (0-basiert).
parentPage
Syntax: page.parentPage
Gibt die übergeordnete Seite zurück. Liefert null, wenn die Seite bereits die oberste ist.
Beispiel:
<p><$= page.parentPage.name $></p> parentPageId
Syntax: page.parentPageId
Die ID der übergeordneten Seite.
Eine Hauptseite liefert die ID des Projektordners zurück.
pathToRoot
Syntax: page.pathToRoot
Der relative Pfad der Seite zum Stammordner der Website. Z.B. "../../".
projectFolder
Syntax: page.projectFolder
Liefert das Projektordner-Objekt vom Typ projectFolder, zu dem die Seite gehört.
searchTerms
Syntax: page.searchTerms
Liefert eine Leerzeichen-getrennte Zeichenfolge von allen Suchbegriffen dieser Seite.
Dies beinhaltet den Volltext der einzelnen Artikel sowie der Felder der Seite selbst.
setAttribute
Syntax: page.setAttribute( attributeName : string, value : object )
target
Syntax: page.target
Falls der Benutzer in den Seiteneigenschaften eine alternative URL hinterlegt hat und ein Linkziel ("Target"), dann liefert diese Eigenschaft das Linkziel als Zeichenfolge zurück, z.B. "_blank".
title
Syntax: page.title
Liefert den Titel der Seite.
Hat der Benutzer keinen Titel angegeben, wird stattdessen der Wert der Eigenschaft name zurückgegeben.
type
Syntax: page.type
Gibt an, ob es sich um eine Seite oder einen Projektordner handelt.
Mögliche Rückgabewerte sind:
pageprojectFolder
url
Syntax: page.url
Liefert die relative URL einer Seite zur aktuellen Seite.
Falls der Benutzer in den Seiteneigenschaften eine alternative URL hinterlegt hat, dann wird diese zurückgegeben.
value()
Syntax: page.value(key, fallBack = null)
Liefert einen vom Benutzer eingegebenen/ausgewählten Wert der Seite.
key- Der Name des Werts, der gelesen werden soll. Das entspricht den"name"-Einträgen der"fields"-Liste in der JSON-Datei der Seitenvorlage.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: page.valueExpanded(key, fallBack = null)
Verhält sich analog zur value()-Funktion mit dem Unterschied, dass etwaige im zurückgegeben Wert enthalten Skript-Aufrufe und Platzhalter bereits ersetzt ("expandiert") sind.
valueRaw()
Syntax: page.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.
visible
Syntax: page.visible
Boolescher Wert, der angibt, ob die Seite im Menü auf der Website sichtbar ist oder nicht.
Seiten, die nicht im Menü sichtbar sind, werden ganz normal erstellt und veröffentlicht. Sie müssen manuell innerhalb eines Artikels verlinkt werden, damit sie für Website-Besucher erreichbar sind.
cssBackgroundImageSimple
Syntax: page.cssBackgroundImageSimple(key) : cssBackgroundImageSimple
cssBackgroundImage
Syntax: page.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.
areaCssClass
Syntax: page.areaCssClass( areaName : string ) : string
areaInlineCss
Syntax: page.areaInlineCss( areaName : string ) : string