Verweise (Referenzen)

Verweise sind Zeiger in Form von Adressen auf Mediendokumente (wie PDF-Dateien oder Hilfetexte), sowie Formulare oder auch (externe) Internetseiten.

Ein Verweis wird dabei in Form einer Adresse in einem Formular gespeichert. Wenn ein Formular aufgerufen wird, dann werden die Verweise aufgelöst, sodass anstelle der hinterlegten Adresse das eigentliche Medium bzw. ein Link zu einem bestimmten Formular oder einer externen Internetseite erscheint. Teilweise wird anstelle des Begriffs Verweis auch der Begriff Referenz verwendet. 

Je nach Art des Dokuments, auf das verwiesen wird, nach der Funktionalität, die der Verweis erfüllen soll, sowie nach Art des Absatzes, in den der Verweis eingebettet werden soll, müssen Verweise unterschiedlich gesetzt werden.

Allgemeines zur Auswahl von Verweisen

Dokumente können über die Suche (genauer Name), durch eine Auswahl von (zuvor gesetzten) Lesezeichen oder durch Auswahl einer der zuletzt gesetzten Dokumente gefunden werden, ohne dass sich durch den kompletten Struktur-Baum geklickt werden muss. Innerhalb des Strukturbaums wird dann zu demjenigen Dokument gesprungen, das der Suche bzw. Auswahl entspricht (es ist allerdings weiterhin ein Auswahl anderer Dokumente, die in der Nähe liegen möglich).

Für bestimmte Arten von Verweisen (Verweis auf Bilder, Hilfetexte, Seiten...) gibt spezielle Dokumente, die für einen solchen Verweis infrage kommen. Beispielsweise kann für ein Verweis auf ein Bild kein Text-Dokument ausgewählt werden.

Wenn ein Verweis über einen Setzen-Button innerhalb eines Absatzes gesetzt wird, so werden im Auswahlfenster, das sich nach Klick auf Setzen öffnet, in der Regel nur solche Dokumente (oder Seiten) zur Auswahl gestellt, die für die betreffende Verweisart in Frage kommen (Bei Hilfe-Text nur Text-Dokumente etc.). Alle anderen Dokumentarten sind im Strukturbaum ausgegraut und können nicht ausgewählt werden.

Achtung: Wenn ein übergeordnetes Dokument im Strukturbaum ausgegraut ist, wird damit angezeigt, dass dieses nicht der geforderten Dokumentart entspricht. Trotzdem kann es Unterdokumente besitzen, die der geforderten Dokumentart entsprechen. Die Unterdokumente werden dann nicht ausgegraut dargestellt.

Ziel-Dokument finden

Der Strukturbaum im Auswahlmenü  (Dokumentart Text gefordert)

Der Überordner Text ist ausgegraut, weil er nicht von der Dokumentart Text ist. Das Unterdokument (von der Dokumentart Text) ist auswählbar.

Bilder in Formularen

Bilder können auf Formularseiten eingebettet werden (Standard-Formularseiten, Abschlussseiten, Fehlerseiten). 

Im ersten Schritt fügt man ein Textblock-Element (Textblock, Textblock: Banner ....) im Formular an der gewünschten Position ein. Im Absatz findet sich dann eine Zeile Bild mit einem Button Setzen. 

Klickt man auf diesen Button, so öffnet sich ein Auswahlmenü, das alle Medienordner, die innerhalb Site-Ebene (Globus-Icon) eigebettet sind, auflistet. Mit Klick auf einen dieser Order, stehen drei Aktionen zur Verfügung:

  1. Ein neuen Medienordner anlegen
  2. Ein Bild in einem vorhandene Medienordner hochladen
  3. Ein vorhandenes Bild auswählen

Bilder müssen in einem gängigen Bilddateiformat (bspw. .jpg, .png) zur Verfügung stehen, damit sie in openforms hochgeladen werden können und auf sie in einer Strecke referenziert werden kann. Das Bild muss in openforms als Medien-Datei angelegt worden sein, damit ein Verweis auf dieses gesetzt werden kann.

Hat man ein Bild ausgewählt, so kann man verschiedene Optionen für die Darstellung des Bildes innerhalb der Strecke auswählen.

TextfeldBeschreibung
AltText, der angezeigt wird, wenn das Bild nicht geladen werden kann (Alt-Attribut). Das Feld sollte nicht leer und sinnvoll gefüllt sein.
KurzbeschreibungBeschreibung des Bildes, die - je nach Style Klasse - angezeigt wird, wenn über das Bild fährt. In der Regel ist die Beschreibung nur im HTML-Code zu sehen.
Ausführliche BeschreibungAusführlichere Beschreibung des Bildes. In der Regel nicht im Frontend zu sehen.
Style KlasseWenn das Bild ein besonderes Layout haben soll, so kann man hier (sofern in einem genutzten Stylesheet vorhanden) die entsprechende Style Klasse angeben.
BedingungVia OGNL kann man eine Bedingung formulieren, wann das Bild angezeigt werden soll.

Mit Klick auf den Button Medium setzen setzt man die Referenz auf das ausgewählte Bild mit den definierten Optionen.

Wenn das Feld Style Klasse leer ist, wird das Bild dynamisch an die Breite der Formularseite (bzw. Marginalie) angepasst. Dies bedeutet, dass das die reale Breite des Bildes (im Screenshot  1100 px) gedehnt bzw. gestaucht wird, bis es der zur Verfügung stehenden Breite der Formularspalte entspricht. Die Höhe (im Screenshot 471 px) wird proportional zur errechneten Breite angepasst.

Ein Verweis auf ein Bild in einem Textblock setzen


Bild auswählen und die Optionen für die Darstellung setzen

Hilfetexte

Hilfetexte können ebenfalls in Textblöcken, aber auch in andere Bausteinen wie Textfeldern gesetzt werden. 

Hierfür muss ein Text in einem Medienordner mit dem entsprechenden Hilfetext abgelegt worden sein.

Die Referenzierung erfolgt über den Button Setzen in der Zeile Hilfe des entsprechenden Absatzes.

Es öffnet sich ein Auswahlfenster, in dem das entsprechende Textdokument ausgewählt werden kann.

Nachdem ein Text ausgewählt worden ist, erscheint in "i-Icon" am Absatz im fertigen Formular. Klickt man auf dieses Icon erscheint der Hilfetext.


Hilfetexte über x-info

Zusätzlich gibt es die Möglichkeit, Hilfetexte an Unterabsätzen wie beispielsweise in Beschreibungen von Fragengruppen hinzuzufügen.

Wieder muss vorab ein Text in einem Medienordner mit entsprechendem Hilfetext abgelegt worden sein. Außerdem muss in einem übergeordneten Ordner (bspw. die Formularstrecke) auf den Text referenziert werden.

Hierfür geht man wie folgt vor:

  1. Im übergeordneten Ordner unter dem Tab Versionen auf den Tab Navigation wechseln. Hier in der Zeile Zusätzliche Verweise auf Setzen klicken.
  2. Den Hilfetext, der in einem Medienordner abgelegt ist, auswählen und im Textfeld Kontext eine Ankerbezeichnung (bspw. hilfetext) vergeben.
  3. In der Formularseite im entsprechenden Absatz an derjenigen Stelle, an der ein "i-Icon" erscheinen soll, x-info:<Ankerbezeichnung> (bspw. x-info:hilfetext) eingeben.

Einen Verweis auf einen Hilfetext setzen

Ansicht bei gesetztem Hilfetext (Beispiel Textfeld)

Zusätzlichen Verweis setzen (für x-info)

x-info im Absatz einfügen

Links (Verweise auf interne / externe Seiten)

Links auf interne und externe Seiten können ebenfalls in Textblöcken gesetzt werden. Die Links erscheinen dann als Liste unterhalb der gesetzten Überschrift und des Fließtextes.

Mit Klick auf Setzen  in der Zeile Verweis öffnet sich ein Auswahlfenster. Es wird zwischen internen und externen Links unterschieden. Hierfür stehen zwei Tabs im Auswahlfenster zur Verfügung.


Im Falle von internen Verweisen kann im Strukturbaum die Seite ausgewählt werden, auf die verlinkt werden soll. Der Link wird dann dynamisch gesetzt. Das bedeutet: Wenn die Seite, auf die verlinkt worden ist, verschoben wird, so ändert sich auch die Referenz, sodass die Seite (trotz neuer Adresse) weiterhin über den Link aufgerufen werden kann.


Bei externen Verweisen gibt es die Möglichkeit im Feld URL eine URL einzugeben. Externe Verweise sind nie dynamisch. Das bedeutet, dass sie in aller Regelmäßigkeit auf ihre Aktualität geprüft werden müssen.


Eigenschaften

FeldBeschreibung
KurzbeschreibungBezeichner für den Verweis (Link) auf der Formularseite
Ausführliche BeschreibungHat keine Auswirkungen auf die Ansicht des Link (einfach leer lassen).

Weitere Eigenschaften

FeldBeschreibung
Verweisart

Bestimmt wie die verlinkte Seite geöffnet werden soll.

  1. Normal: Die Seite öffnet in einem Fenster, das die Fenstergröße wie der zur Zeit geöffnete Browser hat.
    Im Feld Fenster kann eingegeben werden, ob die Seite in demselben Tab geöffnet werden soll (Eingabe: _self) oder in einem neuen Tab (Eingabe: _blank).
  2. Eingebettet: Öffnet die Seite in einem überlagernden Fenster oder in einem Bereich innerhalb der Seite.
    Mit Auswahl von Modal wird ein die Seite in einem überlagernden Fenster angezeigt; mit Auswahl von i-Frame wird die Seite in einem Bereich des Formulars angezeigt.
    Über Breite / Höhe kann angegeben werden wie groß das eingebettete Fenster sein soll und über Horizontal Scrollen / Vertikal Scrollen, ob Scrollbalken im eingebetteten Fenster (horizontal oder vertikal) erscheinen sollen.
  3. PopUp-Fenster: Öffnet die Seite in einem PopUp-Fenster.
    Über Breite / Höhe kann die Größe des (initialen) Fensters angegeben werden. Setzt man die Checkbox Veränderbare Größe so ist es möglich, das PopUp-Fenster größer und kleiner zu ziehen. Außerdem kann man über die verschiedenen Checkboxen Menüleiste, Navigation ... einstellen, welche Elemente das Popupfenster haben soll.
Style KlasseUnter Angabe von im genutzten CSS definierten Klassen kann hier das Aussehen der Verlinkung geändert werden (in der Regel ist hier nichts einzugeben).
AbsatzWenn auf eine Sprungmarke innerhalb der Seite verlinkt werden soll, kann der Anker der Sprungmarke hier eingegeben werden. Mit Klick auf den Link wird dann zu dem hier angegebenen Absatz gesprungen.
Verweis-ParameterIm plist-Format ( z.B. {x-meinKey = "wert1"; x-meinZweiterKey="wert2"}) können hier GET-Parameter übergeben werden (d.h. die Parameter werden an die URL gehängt).
...per POST sendenDie Verweisparameter, die unter Verweis-Parameter  angegeben wurden, werden per POST versendet (also nicht in der URL). Dies funktioniert noch bei externen Verweisen. Die externen Seiten müssen dabei in der Lage sein, POST-Parameter zu empfangen.
KontextBezeichner, mit dem ein Verweis klassifiziert wird. Anwendungsfall z.B: Zusätzliche Verweise einer Version.
BedingungHier kann man einen OGNL-Befehl einfügen, der bestimmt, unter welchen Bedingungen der Verweis sichtbar sein soll.

Statische Verlinkungen

Neben der Möglichkeit Verweise dynamisch in Form von Verweislisten zu setzen, gibt es die Möglichkeit, Verweise (bspw. in Fließtext) mithilfe der Wiki-Synax zu setzen. Näheres dazu gibt es unter Textformatierung (Wiki-Syntax).

Link auf eine Seite setzen

Nicht aufgelöste Referenzen/ Nicht publizierte Referenzen / Referenziert von

Über das Dropdown Menü Workflow  gibt es die Möglichkeit, sich nicht aufgelöste Verweise bzw. nicht publizierte Referenzen anzeigen zu lassen. Beide Anzeigen beziehen sich dabei ausschließlich auf interne Verweise (auf Seiten, Dokumente, Bilder etc.).

Nicht aufgelöste Referenzen (Zeige nicht aufgelöste Referenzen) 

Wird eine Seite (Formularseite, Standard...) von einer Admin-Instanz exportiert und dann in eine andere Admin-Instanz importiert, so kann es passieren, dass bestimmte Seiten oder Dokumente, auf die innerhalb der Seite referenziert sind, in der Import-Admin-Instanz nicht vorhanden sind. In der Regel wird dies bereits beim Import in Form einer Fehlermeldung angezeigt.

Zusätzlich kann man sich auch über den oben angeführten Menüpunkt anzeigen lassen, ob es solche "nicht aufgelösten Verweise" gibt.

Nicht publizierte Referenzen (Zeige Referenzen zu unveröffentlichten Seiten)

Über diesen Menüpunkt kann man sich anzeigen lassen, ob es Seiten oder Dokumente gibt, auf die referenziert wird, die sich nicht im Zustand "In Produktion" befinden.

Referenziert von

Schließlich gibt es für jedes Dokument und für jede Seite die Möglichkeit, sich anzeigen zu lassen, ob eine andere (interne) Seite auf das- bzw. dieselbe referenziert. Hierfür geht man im Zustand "Inhalt bearbeiten" auf den Tab Dokumenteigenschaften. Unter der Überschrift referenziert von ist dann eine Auflistung zu sehen, welche Seiten auf das Dokument referenzieren.

Nicht aufgelöste Verweise / Nicht publizierte Referenzen 


Referenziert von