Startseite › Kontextsensitives Hilfesystem

Kontextsensitives Hilfesystem

Was ist das?

Das Help Links-System verbindet automatisch Anwendungsseiten mit entsprechenden Dokumentationsabschnitten. Wenn Sie sich auf einer Seite mit konfigurierter Hilfe befinden, erscheint eine violette Hilfe-Schaltfläche (?) in der Kopfzeile.

Durch Klicken auf die Schaltfläche wird die entsprechende Dokumentation in einem neuen Tab geöffnet, sodass Sie schnell detaillierte Informationen zur Seitenfunktionalität erhalten.

Wie es funktioniert

Schritt 1: Routenerkennung

Wenn Sie eine Seite öffnen, erkennt das System ihre Symfony-Route (z.B. app_property_adjustments_index für die Anpassungsliste).

Schritt 2: Datenbankabfrage

Das System durchsucht die help_links-Tabelle nach einem Datensatz für diese Route. Wenn ein aktiver Link gefunden wird, wird der Dokumentationspfad abgerufen (z.B. /adjustments/service-provider).

Schritt 3: Button-Anzeige

Wenn ein Link gefunden wird und aktiv ist, wird in der Seitenkopfzeile eine violette Hilfe-Schaltfläche mit einem Fragezeichen-Symbol angezeigt.

Schritt 4: Dokumentation öffnen

Wenn Sie auf die Schaltfläche klicken, wird der entsprechende Bibliotheksabschnitt (z.B. /library/adjustments/service-provider) in einem neuen Browser-Tab geöffnet.

Wo befindet sich die Schaltfläche?

Die Hilfe-Schaltfläche befindet sich in der Seitenkopfzeile, normalerweise rechts von der Eigenschaftsmenü-Schaltfläche, vor Indikatoren und Aktionsschaltflächen. So sieht sie aus:

Welche Seiten werden unterstützt?

Das Help Links-System ist für alle Hauptanwendungsmodule konfiguriert. Die Hilfe-Schaltfläche ist auf folgenden Seiten verfügbar:

  • Saldokorrekturen (erstellen, anzeigen, bearbeiten)
  • Mietverträge
  • Dokumente
  • Ausgaben
  • Zahlungen
  • Strafen
  • Reparaturkompensationen
  • Kommunikationen
  • Zähler
  • Verstöße
  • Vermieter-Eigentum
  • Nachrichten
  • Vertragsverhandlungen
  • Kommerzielle Angebote
  • Fotos und Videos

API zur Verwaltung von Links

Das System bietet eine REST-API zur programmgesteuerten Verwaltung von Hilfe-Links. Alle Datenänderungsoperationen (Erstellen, Aktualisieren, Löschen) sind nur für Administratoren verfügbar.

GET /api/v1/help-links

Erhalten Sie eine Liste aller Hilfe-Links mit der Möglichkeit, nach Aktivitätsstatus zu filtern.

Abfrageparameter

  • is_active - Nach Aktivitätsstatus filtern (0 oder 1)

Antwortbeispiel

[
  {
    "id": 1,
    "route_name": "app_property_adjustments_index",
    "library_path": "/adjustments/service-provider",
    "full_library_url": "/library/adjustments/service-provider",
    "is_active": true
  }
]

GET /api/v1/help-links/by-route/{routeName}

Erhalten Sie einen Hilfe-Link für eine bestimmte Symfony-Route.

Anforderungsbeispiel

GET /api/v1/help-links/by-route/app_property_adjustments_index

Antwortbeispiel

{
  "id": 1,
  "route_name": "app_property_adjustments_index",
  "library_path": "/adjustments/service-provider",
  "full_library_url": "/library/adjustments/service-provider",
  "is_active": true
}

POST /api/v1/help-links

Erstellen Sie einen neuen Hilfe-Link.

Hinweis: Diese Operation ist nur für Benutzer mit der Rolle ROLE_ADMIN verfügbar.

Anfragekörper

{
  "route_name": "app_property_adjustments_index",
  "library_path": "/adjustments/service-provider",
  "is_active": true
}

PUT /api/v1/help-links/{id}

Aktualisieren Sie einen vorhandenen Hilfe-Link.

Hinweis: Diese Operation ist nur für Benutzer mit der Rolle ROLE_ADMIN verfügbar.

DELETE /api/v1/help-links/{id}

Löschen Sie einen Hilfe-Link.

Wichtig: Hinweis: Diese Operation ist nur für Benutzer mit der Rolle ROLE_ADMIN verfügbar.

Swagger-Dokumentation

Vollständige interaktive API-Dokumentation mit der Möglichkeit, Anfragen zu testen, ist in Swagger UI verfügbar:

Swagger-Dokumentation öffnen