PageRef Access Plugin (PageRef DAP)

Seiten referenzieren

Über das PageRef Access Plugin (PageRef DAP) können Seiten referenziert werden.
Die durch den Nutzer gewählten Referenzen auf Seiten können als HTML-Verweise ausgegeben werden.

Modul-Datei

pagerefdap-[version].fsm

Installieren des Moduls

Das Modul wird über den FirstSpirit ServerManager installiert, und zwar im Dialog „Servereigenschaften / Module“ über die Schaltfläche „Installieren“:

(Zu weiteren Informationen zur Installation von Modulen siehe auch Module (→Dokumentation für Administratoren).)

Remote-Projekt-Konfiguration

Remote-Projekte sind Projekte, aus denen Inhalte referenziert oder auch geladen werden können.

Damit Referenzen auf Seiten aus anderen FirstSpirit-Projekten möglich werden, muss das gewünschte Projekt als „Remote-Projekt“ in den Projekteigenschaften (FirstSpirit ServerManager) konfiguriert werden, z. B.:

Zur Konfiguration von Remote-Projekten allgemein siehe (Remote-Projekte (→Dokumentation für Administratoren)).

Web-Komponente "PageRef DAP for ContentCreator"

Über die Web-Komponente „PageRef DAP for ContentCreator“ kann das Plugin im ContentCreator verwendet werden.

Dazu muss die Web-Komponente dem betreffenden Projekt im Bereich „ContentCreator“ hinzugefügt werden („FirstSpirit ServerManager / Projekt-Eigenschaften / Web-Komponenten“).

Verwendung in Projekten

Ist das Modul installiert, kann es von der Komponente zur Auswahl von Referenzen, „FS_INDEX“, angesprochen werden, und zwar in

• FragmentCreator
• ContentCreator (Voraussetzung: Web-Komponente „PageRef DAP for ContentCreator“)

Der Redakteur kann eine oder mehrere Seitenreferenzen aus dem oder den konfigurierten Remote-Projekten auswählen.

Komponente "FS_INDEX"

Zur Referenzierung von Seitenreferenzen wird die Komponente „FS_INDEX“ verwendet.

Register „Formular“, Syntax-Beispiel:

<FS_INDEX name="links">
    <LANGINFOS>
      <LANGINFO lang="*" label="Page referencing / links"/>
      <LANGINFO lang="DE" label="Seitenreferenzen / Links"/>
    </LANGINFOS>
    <SOURCE name="FirstSpiritPageRefAccess/PageRefConnector">
      <PROJECT remote="pagerefs">
        <FOLDER uid="products"/>
      </PROJECT>
    </SOURCE>
</FS_INDEX>

SOURCE: Aktivierung der DAP-Funktionalität

Über das Tag SOURCE werden das FirstSpirit-Modul sowie die DataAccessPlugin-Komponente angegeben, und zwar über den Pflichtparameter name. In diesem Fall: „FirstSpiritPageRefAccess/PageRefConnector“.

jsonSupporting
Mithilfe dieses Attributs im Tag SOURCE kann die JSON-Ausgabe der FS_INDEX-Komponente um die Informationen der referenzierten Seitenreferenzen erweitert werden:

... jsonSupporting="yes"...

Standardmäßig ist dieses Attribut inaktiv (entspricht jsonSupporting="no").

PROJECT: Definition des Remote-Projekts

Damit Seitenreferenzen aus einem Remote-Projekt ausgewählt werden können, muss das Tag PROJECT angegeben werden. Über den Pflichtparameter remote muss dabei der symbolische Projektname des Remote-Projekts angegeben werden.

FOLDER: Beschränkung auf Ordner

Die Auswahl kann mithilfe des FOLDER-Tag auf Ordner des Remote-Projekts eingeschränkt werden. Sollen mehrere Ordner berücksichtigt werden, muss für jeden Ordner ein FOLDER-Tag angegeben werden. Der Name des betreffenden Ordners wird über den Parameter uid spezifiziert (Referenzname).

Zu weiteren Informationen zur Verwendung und Konfiguration von FS_INDEX siehe INDEX (→Online Dokumentation FirstSpirit).

Darstellung im FragmentCreator

Wurde die Konfiguration korrekt vorgenommen, erhält der Redakteur in einer Variante eine Möglichkeit, Seitenreferenzen auszuwählen:

Ausgabe (in FirstSpirit-Projekten)

Die durch den Redakteur gewählten Seitenreferenzen können in einem FirstSpirit-Projekt folgendermaßen ausgegeben werden:

$CMS_FOR(pageref, links.values())$<br />         
     <a href="$CMS_REF(pageref)$")$">
      $CMS_VALUE(pageref.uid)$  <br/>      
     </a>                     
$CMS_END_FOR$