RRZE Answers

Allgemeines

RRZE Answers bündelt die Funktionen der früheren Plugins RRZE FAQ, RRZE Glossary und RRZE Synonym in einem einzigen Plugin. Damit können häufig gestellte Fragen (FAQ), Glossareinträge und Platzhalter zentral verwaltet und auf verschiedenen FAU-Webseiten einheitlich dargestellt werden.

Vorteile von RRZE Answers

  • Zentrale Verwaltung von Wissen
    Fragen & Antworten, Glossar-Einträge und Platzhalter werden an einer zentralen Stelle gepflegt und können an vielen Stellen wiederverwendet werden.

  • Flexible Darstellung
    Inhalte können u. a. als Akkordeon, A–Z-Register, Tab-Navigation, Tagcloud oder Grid-Ansicht ausgegeben werden – per Block, Shortcode oder Widget. GitHub

  • Synchronisation über Domains hinweg
    Inhalte können zwischen verschiedenen FAU-Webauftritten geteilt und synchronisiert werden (z. B. zentrale FAQs auf mehreren Projektseiten). GitHub

  • REST-API-Unterstützung
    Alle Einträge sind über die WordPress REST-API abrufbar und können von anderen Anwendungen genutzt werden. GitHub

  • SEO-Unterstützung
    FAQ- und Glossar-Einträge werden mit strukturierten Daten (schema.org) ausgezeichnet und können so die Sichtbarkeit in Suchmaschinen verbessern. GitHub

Was kann RRZE Answers?

RRZE Answers ermöglicht unter anderem:

  • Anlegen und Verwalten von:

    • FAQ-Einträgen

    • Glossar-Einträgen

    • Platzhaltern (Begriffe, Konstanten, Abkürzungen)

  • Gruppierung und Filterung nach Kategorien, Schlagwörtern (Tags) und optional Domains

  • Anzeige der Inhalte über:

    • Gutenberg-Blöcke

    • Shortcodes

    • Widgets

  • Synchronisation von Einträgen anderer FAU-Webseiten über:

    • Einstellungen → RRZE Answers → Domains

    • Einstellungen → RRZE Answers → Import GitHub

Typische Einsatzszenarien

  • FAQ-Seite für einen Lehrstuhl, eine Einrichtung oder ein Projekt

  • Glossar für technische Begriffe, Abkürzungen oder Studiengangs-Vokabular

  • Zentrale Platzhalter für sich häufig ändernde Inhalte, z. B.:

    • Links auf Portale

    • Telefonnummern / E-Mail-Adressen

    • Standardformulierungen

Seite 2: Answers aktivieren

Titel: Answers aktivieren

Plugin aktivieren

Gehen Sie wie folgt vor, um das Plugin zu aktivieren:

  1. Navigieren Sie im WordPress-Backend zu Dashboard → Plugins.
  2. Suchen Sie in der Liste der verfügbaren Plugins nach RRZE Answers.
  3. Klicken Sie auf Aktivieren.
  4. Nach der Aktivierung finden Sie:
    • neue Inhaltstypen (z. B. „FAQ“, „Glossary“, „Placeholders“ – je nach Übersetzung)
    • einen neuen Einstellungsbereich unter Einstellungen → RRZE Answers.

Optional kannst du hier ein Screenshot-Bild einfügen (z. B. vom Backend-Menü nach der Aktivierung).

Erste Kontrolle

Nach der Aktivierung empfiehlt es sich:

  • in der linken Seitenleiste zu prüfen, ob die neuen Menüpunkte sichtbar sind,
  • unter Einstellungen → RRZE Answers einmal alle Tabs aufzurufen (z. B. Allgemein, Domains, Import usw., je nach Version),
  • bei Bedarf Test-Einträge für FAQ und Glossar anzulegen.

Deaktivieren und Entfernen

  • Das Deaktivieren des Plugins über Dashboard → Plugins → Deaktivieren entfernt die Funktionen aus der Ausgabe, lässt aber alle Inhalte in der Datenbank bestehen.
  • Ein späteres erneutes Aktivieren bindet alle bestehenden Einträge wieder ein.

Seite 3: FAQ erstellen und anzeigen

Titel: FAQ erstellen und anzeigen

RRZE Answers bietet einen eigenen Inhaltstyp für häufig gestellte Fragen (FAQ). FAQ-Einträge können kategorisiert, verschlagwortet und auf unterschiedlichen Seiten als Akkordeon oder Liste ausgegeben werden. GitHub

FAQ-Eintrag anlegen

  1. Gehen Sie im Backend zu FAQ → Erstellen (oder den entsprechenden Menüpunkt).
  2. Tragen Sie im Editor die Frage als Titel und die Antwort im Inhaltsbereich ein.
  3. Weisen Sie dem Eintrag bei Bedarf zu:
    • Kategorien (z. B. „Studium“, „Technik“, „Organisation“)
    • Tags / Schlagwörter (feinere Stichworte)
    • Domain (falls Sie mit mehreren Websites synchronisieren)
  4. Veröffentlichen Sie den Eintrag.

Wiederhole diesen Vorgang für alle FAQ, die angezeigt werden sollen.

FAQ im Block-Editor anzeigen

Im Block-Editor steht ein eigener RRZE FAQ Block zur Verfügung. GitHub

  1. Öffnen oder erstellen Sie eine Seite, auf der Ihre FAQ erscheinen sollen.
  2. Fügen Sie einen neuen Block hinzu und suchen Sie nach „RRZE FAQ“.
  3. Wählen Sie den Block aus.

In den Block-Einstellungen auf der rechten Seite können Sie u. a.:

  • einzelne FAQ per ID auswählen,
  • nach Kategorien oder Tags filtern,
  • die Ausgabeform konfigurieren:
    • Akkordeon
    • A–Z-Register
    • Tabs
    • Tagcloud / Grid
  • entscheiden, ob Titel, Akkordeon-Funktion oder Registereinblendung sichtbar sein sollen,
  • Sortierung und Reihenfolge festlegen (z. B. nach Titel, ID oder Sortierfeld). GitHub

FAQ per Shortcode anzeigen

Alternativ können Sie FAQ über Shortcodes in klassischen Inhalten anzeigen. Unterstützt werden u. a. folgende Varianten: GitHub

[faq id="456,123"]

RRZE Answers

RRZE Answers

RRZE Answers

Wichtige Attribute:

  • id – konkrete FAQ-IDs, kommasepariert
  • category – eine oder mehrere Kategorienslugs
  • tag – eine oder mehrere Tag-Slugs
  • domain – Filterung nach Domain(s), falls verwendet
  • glossary – Gruppierungs- / Darstellungsart (z. B. category, tag, a-z, tabs, tagcloud)
  • hide – ausblendbare Elemente, z. B. accordion, title, glossary
  • masonry – Grid-Layout aktivieren (true / false)
  • class – zusätzliche CSS- / Fakultätsklassen (z. B. fau, med, nat)
  • sort – Sortierfeld (title, id, sortfield)
  • order – Sortierrichtung (asc, desc)
  • hstart – Startebene der Überschrift (Standard: 2)

Best Practices für FAQ

  • Gruppieren Sie FAQ nach Themenbereichen (Kategorien), nicht nach Zielgruppen.
  • Verwenden Sie möglichst klare, suchmaschinenfreundliche Fragestellungen.
  • Nutzen Sie strukturierte Ausgabeformen (Akkordeon, Register), damit lange Listen übersichtlich bleiben.
  • Binden Sie zentrale FAQs möglichst über Synchronisation/Domain-Import ein, statt sie auf jeder Seite neu zu pflegen.

Seite 4: Glossar erstellen und anzeigen

Titel: Glossar erstellen und anzeigen

Mit dem Glossar-Modul von RRZE Answers können Fachbegriffe, Abkürzungen und wichtige Termini zentral verwaltet und als A–Z-Register, Tabs oder Liste ausgegeben werden. GitHub

Glossar-Eintrag anlegen

  1. Gehen Sie im Backend zu Glossary → Erstellen (oder entsprechende Bezeichnung).
  2. Vergeben Sie einen aussagekräftigen Titel für den Begriff.
  3. Tragen Sie im Inhaltsbereich die Definition bzw. Erklärung ein.
  4. Optional:
    • ordnen Sie Kategorien und Tags zu,
    • pflegen Sie zusätzliche Felder, falls vorhanden (z. B. Sprache, Synonyme).
  5. Veröffentlichen Sie den Eintrag.

Glossar im Block-Editor anzeigen

Im Block-Editor steht ein RRZE Glossary Block zur Verfügung. GitHub

  1. Öffnen Sie die Seite, auf der das Glossar erscheinen soll.
  2. Fügen Sie den Block „RRZE Glossary“ ein.
  3. Konfigurieren Sie in den Block-Einstellungen:
    • Auswahl bestimmter Einträge oder Filter über Kategorien / Tags
    • Anzeige als:
      • alphabetisches Register (A–Z)
      • Tabs
      • Tagcloud
    • Ein-/Ausblenden von Elementen wie Titel, Register oder Akkordeon
    • Standardverhalten (z. B. Einträge beim Laden geöffnet, „alle ausklappen“-Link)
    • Sortierung und Überschriftenebene.

Glossar per Shortcode anzeigen

Beispiele für Glossar-Shortcodes: GitHub

[glossary id="123,456"]

Wichtige Attribute:

  • register – gibt Gruppierung und Darstellungsart an, z. B.:
    • category
    • tag
    • a-z
    • tabs
    • tagcloud
  • category – eine oder mehrere Kategorien
  • tag – eine oder mehrere Tags
  • id – konkrete Glossar-IDs
  • hide – z. B. accordion, title, register
  • show – z. B. expand-all-link, load-open
  • class – zusätzliche CSS-Klassen
  • sort, order, hstart – analog zum FAQ-Shortcode

Seite 5: Platzhalter & Abkürzungen (Placeholders)

Titel: Platzhalter & Abkürzungen

Platzhalter (Placeholders) dienen dazu, wiederkehrende oder zentrale Inhalte an einer Stelle zu pflegen und an vielen Stellen einzusetzen – z. B. Abkürzungen, Standardlinks oder Bezeichnungen. GitHub

Platzhalter anlegen

  1. Gehen Sie im Backend zum entsprechenden Menüpunkt (z. B. Placeholders).
  2. Legen Sie einen neuen Platzhalter an:
    • Titel / Name des Platzhalters
    • Inhalt (z. B. Text, Link, Abkürzungserklärung)
  3. Veröffentlichen Sie den Platzhalter.

Platzhalter über Shortcodes einbinden

RRZE Answers bietet verschiedene Shortcodes, um Platzhalter und Abkürzungen einzusetzen: GitHub

[placeholder id="123"]

[placeholder slug=“bildungsministerium“]

  • id – ruft einen konkreten Platzhalter über die ID auf.
  • slug – ruft einen Platzhalter über den Slug auf.

  • Aktuelle WCAG-Version

    2.2

    Aktuelle PHP Version

    8.2

    Aktuelle WordPress Version

    6.8

    Customizer button anpassen

    Customizer

     gibt Abkürzungen als <abbr>-Tag mit Titel, Sprache und ggf. Aussprache aus.

Beispielausgabe:

<abbr title="Universal Resource Locator" lang="en">URL</abbr>

Wenn kein id– oder slug-Attribut übergeben wird, können alle Platzhalter ausgegeben werden (z. B. als Übersichtsliste).

Platzhalter im Editor auswählen

Der Editor stellt ein eigenes Menü für Platzhalter bereit, aus dem heraus vorhandene Einträge ausgewählt und direkt in den Text eingefügt werden können. GitHub

Seite 6: Blöcke & Widgets

Titel: Blöcke & Widgets

FAQ-Block

  • zeigt eine FAQ-Liste mit Filterung nach Kategorien, Tags, IDs oder Domains
  • bietet verschiedene Darstellungsarten (Akkordeon, A–Z etc.)
  • kann per Block-Einstellungen umfangreich konfiguriert werden (Titel, Sortierung, Layout). GitHub

Glossary-Block

  • zeigt Glossar-Einträge mit Register, Tabs oder Tagcloud
  • eignet sich für umfangreiche Begriffssammlungen. GitHub

Widgets

RRZE Answers stellt darüber hinaus Widgets bereit, mit denen z. B. zufällige oder bestimmte FAQ- oder Glossar-Einträge in Sidebars oder Widget-Bereichen angezeigt werden können. GitHub

Typische Einsatzmöglichkeiten:

  • „Frage des Tages“ in der Sidebar
  • Kurzes Glossar im Footer
  • Hinweisbox mit immer gleicher FAQ auf vielen Unterseiten

Seite 7: Shortcodes

Titel: Shortcodes

Hier kannst du im Prinzip das zusammenfassen, was oben schon angerissen ist – sauber gegliedert:

  1. FAQ-Shortcodes (mit Attributtabelle)
  2. Glossary-Shortcodes
  3. Placeholder-Shortcodes
  4. Code-Beispiele für häufige Anwendungsfälle:
    • gesamte FAQ-Kategorie ausgeben
    • nur bestimmte IDs
    • Glossar mit A–Z-Register
    • Liste aller Platzhalter

Die in der README dokumentierten Shortcodes und Attribute kannst du hier noch einmal als Referenz bündeln. GitHub

Seite 8: Synchronisation & Domains

Titel: Synchronisation & Domains

RRZE Answers kann Inhalte von anderen FAU-Webseiten einbinden, damit z. B. zentrale FAQ-Sammlungen mehrfach verwendet werden. GitHub

Domains einrichten

  1. Öffnen Sie im Backend Einstellungen → RRZE Answers → Domains.
  2. Tragen Sie die externe Domain ein, von der Sie Inhalte beziehen möchten (z. B. https://www.anleitungen.rrze.fau.de).
  3. Speichern Sie die Einstellungen.

Inhalte importieren

  1. Wechseln Sie zu Einstellungen → RRZE Answers → Import.
  2. Wählen Sie aus, welche Inhaltsarten (FAQ, Glossar, Placeholders) und Kategorien importiert werden sollen.
  3. Starten Sie den Import.

Importierte Einträge können wie lokale Einträge verwendet und über Blöcke, Widgets und Shortcodes angezeigt werden. GitHub

Seite 9: Einstellungen

Titel: Einstellungen

Auf der Einstellungsseite von RRZE Answers können Sie u. a.:

  • Domains zur Synchronisation konfigurieren,
  • Import-Einstellungen verwalten,
  • ggf. REST-API- / technische Parameter anpassen