De:TSrefDataTypes
In der TSRef (Referenz für TypoScript (Liste TypoScript)) finden sich hinter den Objektnamen immer noch die Erklärungen, von welchem Typ (Data type:) die Elemente sein müssen.
So erwartet z.B. die Funktion stdWrap für die Eigenschaft setCurrent einen Datentyp "string /stdWrap". Das bedeutet der Eigenschaft muss entweder ein String, ein stdWrap oder beides zugewiesen werden. Es ist also möglich einen Wert zu definieren, auf den dann eine stdWrap Funktion angewendet wird. Wird jedoch eine stdWrap Funktion verwendet die selber Daten zurück gibt (z.B. .field), so wird der ursprünglich Wert damit überschrieben.
Diese Tabelle versucht zu erklären, welche Typen es gibt und welche Eigenschaften diese haben. Die Datentypen hängen von der Implementierung ab und gerade bei Extensions können Datentypen anders definiert sein.
Alles was hier noch nicht zu finden ist, findest du weiterhin unter http://typo3.org/documentation/document-library/references/doc_core_tsref/current/view/2/2/
tag
Ein normales HTML-Tag, so wie es später im Code der Seite auftauschen soll.
#Format <tag>
#Beispiel <body style="color:red;">
align
Legt die Ausrichtung fest, in dem das HTML-Attribute align gesetzt wird.
#Format right # rechts left # links center # zentriert
#default left
#Beispiel left
resource
- Eine Referenz auf eine Datei die im Resourcen-Feld des Templates eingefügt wurde. Wenn das Template kopiert wurde, wurde an den Dateinamen eine Nummer angehängt, bzw. diese hochgezählt (toplogo01.gif). Über den asterisk (*) in der Referenzierung wird sichergestellt, dass die Datei weiterhin referenziert bleibt.
- Wenn der Wert ein "/" enthält, dann ist es eine Referenz auf eine Datei im File-System. Dann können keine Wildcards verwendet werden.
# Beispiel # Aus dem Ressourcen-Feld # Standardmäßig fügt TYPO3 Dateien in den Ressourcen eine fortlaufende Nummer hinzu # mit * wird der höchste Wert genommen. toplogo*.gif # aus dem Filesystem fileadmin/picture.gif
imgResource
- Eine imgResource ist eine resource (siehe oben) wie in $TYPO3_CONF_VARS["GFX"]["imagefile_ext"] definiert mit zusätzlichen Eigenschaften
- Oder ein GIFBUILDER-object
# Beispiel
# "file" ist vom Typ imgResource:
file = toplogo*.gif
file.width = 200
# GIFBUILDER:
file = GIFBUILDER
file {
... (GIFBUILDER-Eigenschaften)
}
HTML
Ganz normales Html - wird so wie angegeben auch ausgegeben. Kann aber ggf. durch weitere Tools und Einstellungen noch verändert werden (z.B.: tidy)
#Beispiel # <strong>Hallo Welt</strong>
target
Betrifft den target in einem a-Tag. Typisch _top für die ganze Seite, _blank für eine neue Seite page für den Inhalts-Frame in einer TYPO3-Seite
#Beispiel _blank
imageExtension
Eine der Datei-Endungen aus $TYPO3_CONF_VARS["GFX"]["imagefile_ext"] (localconf.php). Standard ist pdf,gif,jpg,jpeg,tif,bmp,ai,pcx,tga,png. Der Wert "web" ist ein Sonderfall, damit wird sichergestellt, dass das Bild in ein web-Format (gif or jpg) konvertiert wird.
#Beispiel jpg,gif,png
degree
z.B. um Bilder oder Texte zu drehen, -90 bis 90, keine Kommazahlen!
#Beispiel -90 # um 90 Grad nach links drehen.
posint
posint / int+ Eine positive Ganze Zahl größer gleich 0. Keine Kommazahlen!
# Beispiel 200
int
Positive oder negative ganze Zahl (Integer) http://php.net/manual/en/language.types.integer.php In manchen Funktionen (z.B. imageLinkWrap) kann der Zahl ein "m" hinten angestellt werden. Das m steht dann für maximal und bedeutet, dass die Proportionen beim Skallieren nicht verändert werden.
# Beispiel
# In diesem Beispiel ist die Höhe fix 600px, die Breite wird entsprechend angepasst, aber maximal 800px
1.imageLinkWrap {
# Ob Zusätze wie m oder c erlaubt sind, steht in der Beschreibung der einzelnen Funktionen
width = 800m
height = 600
....
}
int+
Analog zu int, nur mit der Einschränkung, dass die Zahl größer gleich 0 sein muss, negative Zahlen sind also nicht erlaubt.
string
str / string / value Es wird eine Zeichenkette erwartet. Zahlen werden ebenfalls als Zeichen interpretiert.
boolean
1 ist wahr, 0 ist falsch, alle nicht leeren Strings sind true
Der Default-Wert hängt immer mit der Funktion zusammen, die einen boolean erwartet.
# Beispiel .ATagBeforeWrap=1
rotation
Gradzahlen, nur ganze Zahlen (integer) von 0 bis 0 - 360
# Beispiel 270
x,y,w,h
xy ist der Versatz von der Ecke oben rechts, w,h sind width/height (Breite/Höhe)
#Beispiel .XY=10,10
HTML-color
#Format red #ffeeff
Es können benannte Farben oder Farben in der hexadezimalen Schreibweise angegeben werden. Weiterführende Informationen: http://de.selfhtml.org/html/allgemein/farben.htm
GraphicColor
#Format
red (HTML-Farbe)
#ffeecc (HTML-Farbe)
255,0,255 (RGB)
red : *0.8 ("red" wird um den Faktor 0,8 abgedunkelt)
#ffeecc : +16 (aus "ffeecc" wird #fffedc, 16 wird addiert, Hexdezimales System beachten!)
Neben der normalen Farbauszeichnung kann auch eine Komma getrennte Liste mit RGB-Werten (Ganzzahlen von 0 bis 255) angegeben werden. Es können zusätzliche mathematische Modifikatoren verwendet werden. + oder - werden addiert oder subtrahiert. Ein * multipliziert die Werte mit dem Faktor, der Faktor darf dann auch eine Kommazahl (0.5 Punkt, stat Komma) sein.
page_id
Entweder kann das Schlüsselwort _this_ verwendet werden, oder eine Zahl (int = Integer = Ganze Zahl) die auf eine Seite verweist.
#Format: (int) this
beispiel = HTML beispiel.value = Diese Seite # Eine bestimmte Seite auswählen beispiel.value.typolink.parameter = 100 # die aktuelle Seite auswählen, via getText beispiel.value.typolink.parameter.data = TSFE:id # die aktuelle Seite auswählen beispiel.value.typolink.parameter = this
pixels
Gibt die Anzahl der Pixel (Ganze Zahl) an.
#Format: (int)
# Beispiel: file = toplogo.gif # Dieses Bild auf eine Breite von 200px skalieren. file.width = 200
Erwartet wird eine Ganze Zahl.
list
Eine Liste mit verschiedenen Elementen, Komma getrennt.
#Format: element1,element2,element3
20 = HMENU 20.special = directory # listet alle direkten Unterseiten von den Seiten 35 und 36 20.special.value = 35, 56
margins
Setzt die Seitenabstände im Uhrzeigersinn. Zuerst Links, dann oben, dann rechts und dann unten. (links,oben,rechts,unten)
#Format: links,oben,rechts,unten
# Abstand nach links 10, nach oben 0 nach rechts 0 und nach unten 5 10,0,0,5
wrap
Diese Eigenschaft wird benutzt, um den Inhalt z.B. mit HTML-Tags zu umschließen.
#Format: ... | ...
# Beispiel: page.40 = HTML page.40.value = Hallo page.40.value.wrap = <h1>| Welt!</h1> # ergibt: <h1>Hallo Welt!</h1>
Die Pipe (|) wird verwendet um den String in links und rechts aufzuteilen. Der linke Part wird vor den Inhalt geschrieben, der rechte Part dahinter. Wenn keine Pipe (|) angegeben ist, dann wird der ganze Wrap als linkter Teil verwendet und komplett vor den Inhalt geschrieben.
linkWrap
Ein Wrap um einen Link herum. Wird z.B. beim IMAGE Objekt für die Eigenschaft linkWrap verwendet.
#Format:
<.. {0-9}.> | </...>
#Beispiel
# Dies erzeugt einen Link zur root-seite der Webseite:
# <A H-R-E-F="?id={0}"> | </A>
Achtung: der erzeugte Link wird nicht durch die typolink Funktion erzeugt und übernimmt z.B. nicht die via config.linkVars definierten Parameter und muss daher auch per Hand an simulated static documents oder realurl angepasst werden. Falls das Objekt stdWrap ermöglicht, sollte die typolink Funktion bevorzugt werden.
Englischer Originaltext:
{x}; x is an integer (0-9) and points to a key in the PHP-array rootLine. The key is equal to the level the current page is on measured relatively to
the root of the website.
If the key exists the uid of the level that key pointed to is inserted instead of {x}.
Thus we can insert page_ids from previous levels.
case
Groß- oder Kleinschreibung erzwingen.
# Format: upper lower
# Beispiel: page.40 = HTML page.40.value = teXt # upper = Großbuchstaben, lower = Kleinbuchstaben page.40.value.case = upper # Ergebnis: TEXT
space
Abstand in Pixel vor und nach einem Element setzen. Wird mit dem clear.gif erzeugt. Anstelle dessen sollte inzwischen CSS verwendet werden.
# Format: (int)|(int)
# Beispiel: # fünf Pixel Abstand davor, fünf Pixel Abstand danach 5 | 5
date-conf
Konfiguration der Ausgabe eines Datums.
# Format: (string) [PHP Funktion Date()] date-conf benutzt die gleichen Konfigurationswerte wie die PHP-Funktion Date()
# Beispiel: d.m.y (= z.B. 07.11.84)
a - "am" oder "pm" A - "AM" oder "PM" d - Tag, numerisch, zweistellig (ggf. mit vorangestellter Null) D - Wochentag, abgekürzt; z.B. "Mon" F - Monat als Text, ausgeschrieben (Januar) h - Stunde, numerisch, 12-Stunden-Format H - Stunde, numerisch, 24-Stunden-Format i - Minuten, numerisch j - Tag, numerisch, ein- bis zweistellig (ohne vorangestellte Null) l (kleines 'L') - Wochentag, ausgeschrieben; z.B. "Montag" m - Monat als Zahl M - Monat als Text, abgekürzt; z.B. "Jan" s - Sekunden S - Endung für englische Ordnungszahlen; z.B. "th", "nd" (wie "fourth", "second") U - Anzahl der Sekunden seit 1.1.1970 Y - Jahr, vierstellig; 1999 w - Wochentag, numerisch, 0 = Sonntag y - Jahr, zweistellig; 99 z - Tage seit Jahresbeginn, numerisch; z.B. "299"
strftime-conf
# Beispiel Datum "01.12.1990" = %d.%m.%Y Zeit "23:06" = %H:%M
%a - Wochentag, abgekürzt; "Mon"
%A - Wochentag, ausgeschrieben; "Montag"
%b - Monatsname, abgekürzt; "Jan"
%B - Monatsname, ausgeschrieben; "Januar"
%c - bevorzugte Datums- und Uhrzeitsformatierung für die aktuelle Sprache
%C - Jahrhundert, zweistellig (d.h. vierstelliges Jahr geteilt durch 100, Anzeige der ersten beiden Ziffern)
%d - Tag, numerisch, zweistellig; "01" bis "31"
%D - Abkürzung für %m/%d/%y
%e - Tag, numerisch, zweistellig (mit Leerzeichen statt vorangestellter Null); " 1" bis "31")
%h - Synonym für %b
%H - Stunde, 24-Stunden-Format; "00" bis "23"
%I - Stunde, 12-Stunden-Format; "01" bis "12"
%j - Tage seit Jahresbeginn, numerisch; "01" bis "365" (ggf. "366")
%m - Monat, numerisch; "01" bis "12"
%M - Minute, numerisch: "00" bis "59"
%n - neue Zeile
%p - Tagesabschnitt; "am" oder "pm"
%r - Zeit mit Tagesabschnitt; z.B. 12:00 a.m.
%R - Zeit im 24-Stunden-Format; z.B. 23:00
%S - Sekunde, numerisch; "00" bis "59"
%t - Tabulator
%T - aktuelle Uhrzeit, Synonym zu %H:%M:%S
%u - Wochentag als Zahl von 1 bis 7, 1 = Montag
%U - Wochennummer des aktuellen Jahres, Zählung startet mit dem ersten Sonntag der ersten Woche (Wochenstart = Sonntag)
%V - Die ISO 8601:1988 Wochennummer des aktuellen Jahres als Zahl (01 bis 53), Zählung startet mit der ersten Woche,
die mindestens vier Tage hat (Wochenstart = Montag)
%W - wie %V nur Zählung ab dem ersten Montag der ersten Woche (Wochenstart = Montag)
%w - Wochentag als Zahl, 0 = Sonntag
%x - Bevorzugte Datumseinstellung der aktuellen Sprache (nur Datum, keine Uhrzeit)
%X - Bevorzugte Uhrzeiteinstellung der aktuellen Sprache (nur Uhrzeit, kein Datum)
%y - Jahr, numerisch, zweistellig; "00" bis "99"
%Y - Jahr, numerisch, vierstellig; z.B. "2003"
%Z - Zeitzone
%% - das Zeichen "%"
UNIX-time
Anzahl der Sekunden seit dem 1.1.1970
# Beispiel 955144722 # Ergibt: 04.07.2000 23:58
path
Pfadangabe, relativ zu dem Root-Verzeichnis.
# Beispiel fileadmin/stuff/ uploads/test/
<tag>-data
# Beispiel: <frameset>-data: row könnte lauten '150,*'
<tag>-params
# Beispiel: <frameset>-params könnte lauten: 'border="0" framespacing="0"'
De:TSref/getText
Via De:TSref/getText können Inhalte aus verschiedenen internen Feldern eingelesen werden.
dir
Gibt alle Dateien eines Verzeichnisses in einer Kommagetrennten Liste zurück. Parameter ermöglichen es, die Liste einzuschränken oder eine Sortierung vorzugeben.
# Format pfad/ | Dateiendungen | Sortierung | Sortierreihenfolge umkehren | vollen Pfad zurückgeben. # Dateiendungen * - alle jpg,gif,png - ansonsten kommagetrennte Liste # Die Sortierung kann erfolgen nach: name - name size - Dateigröße ext - Dateierweiterung date - Datum # Sortierreihenfolge umkehren r - Umkehren, leer lassen wenn nicht # vollen Pfad zurückgeben true - mit fileadmin/files/ vorangestellt false - ohne Pfad ausgeben
# Beispiel fileadmin/files/ | pdf,gif,jpg | name | r | true # mit vollem Pfad ausgegeben, nach namen sortiert, bei Z beginnend und nur Dateien mit den Endungen pdf,gif oder jpg.
Hinweis: Der Wert der config-option "lockFilePath" muss mit dem ersten Teil des Pfades übereinstimmen.
The value of config-option "lockFilePath" must equal the first part of the path. Daher muss der Pfad unterhalb von lockFilePath zu finden sein.
function-name
Beschreibt eine Funktion oder die Methode einer Klasse die aufgerufen werden soll. Weitere Informationen werden beim [De:TSref/cObject|cObject]] USER beschreiben
Die Klasse bzw. die Funktion sollte ggf. mit dem Prefix "user_" anfangen - Klassen Methoden betrifft das nicht. Das kann von der Einstellung der TYPO3_CONF_VARS beeinflusst werden.
Die Funktion oder Methode wird normalerweise mit zwei Parametern aufgerufen:
- $conf: enthält die Werte aus der TS Config die der Funktion als Parameter übergeben wurden.
- $content : Inhalt der von der Funktion verarbeitet werden kann und zurückgegeben werde.
Wenn eine Methode in einer Klasse aufgerufen wird, wird überprüft (wenn ein USER oder USER_INT Objekt verwendet wird) ob eine Klasse mit dem selben Namen mit einem Prefix "ux_" existiert. Wenn dem der Fall ist, wird diese erweiterte Klasse instantiiert. Weitere Informationen zu diesem Thema in [Inside TYPO3].
# Beispiel Funktion: user_reverseString # Methode in der Klasse user_stringReversing->reverseString # Es können Variablen übergeben werden, wie und ob diese ausgewertet werden, ist # von der Implementierung der Funktion abhängig. user_stringReversing.variable = Hallo Welt
Data types: Object types
Parameter können neben einfachen Datentypen auch noch komplexere Objekte enthalten.
cObject
frameObj
Zum Aufbau von Frames
HMENU
Zum Aufbau von Menüs
- GMENU Grafisches Menü
- TMENU Textmenü
- IMGMENU Bildermenü
- JSMENU Javascript Menü
- .sectionIndex
- .alternativeSortingFields
GIFBUILDER
- TEXT - Vorsicht, dieses Text Objekt ist nicht das cObject TEXT.
- Shadow
- Outline
- Emboss
- Box
- Image
- Effect
