1. Migration und Kompatibilität

Das VC Story Plugin ist teilweise abwärtskompatibel zu früheren Versionen von VC Story. Es sollte jedoch sichergestellt werden, dass die Story-Konfigurationen an die neuesten Aktionstypen und Funktionen angepasst werden.

1.1. Migrationsschritte

Um bestehende VC Story-Konfigurationen auf die neueste Version zu migrieren, sind folgende Schritte sorgfältig zu befolgen:

  1. Vorhandene Stories prüfen: Die aktuellen Story-Konfigurationen auf Kompatibilität mit den neuen Aktionstypen überprüfen.

  2. Aktionstypen aktualisieren: Veraltete Aktionstypen durch die neuen Äquivalente ersetzen, wie in der aktuellen Dokumentation beschrieben.

  3. Stories testen: Nach der Aktualisierung jede Story gründlich testen, um sicherzustellen, dass alle Aktionen wie erwartet funktionieren.

  4. Optik anpassen: Falls erforderlich, den HTML-Inhalt an neue Designstandards oder Funktionen anpassen, die in der neuesten Version eingeführt wurden.

  5. Backup erstellen: Vor Änderungen immer eine Sicherung der Original-Story-Dateien anlegen.

  6. Dokumentation prüfen: Die aktuelle Dokumentation auf weitere Änderungen oder neue Funktionen prüfen, die die Stories verbessern können.

WICHTIG: Das folgende Migrationsbeispiel bitte sorgfältig lesen und die Schritte befolgen.

1.1.1. Migrationsbeispiel

Nachdem die Story-Erstellungsschritte durchgeführt wurden, kann die Migration bestehender Stories wie folgt erfolgen:

  1. 'items.json' sichern im neuen Story-Ordner.

  2. 'items.json' kopieren aus dem alten Story-Ordner in den neuen.

  3. 'items.json' öffnen in einem Texteditor.

  4. Prüfen & ersetzen: Die Aktionstypen überprüfen und ggf. anpassen. Weitere Informationen zu den neuen Aktionstypen finden sich auf der Seite Story Aktionen.

  5. 'items.json' speichern und den Texteditor schließen.

  6. Neue index.html aus dem neuen Story-Ordner öffnen.

  7. Alte index.html aus dem alten Story-Ordner öffnen

    • Den Inhalt des <nav>-Bereichs aus der alten index.html kopieren und in die neue index.html einfügen, wobei der bestehende <nav>-Bereich ersetzt wird.

    • Den Inhalt des <section id="story-box">-Bereichs aus der alten index.html kopieren und in die neue index.html einfügen, wobei der bestehende <section id="story-box">-Bereich ersetzt wird.

      <div id="story-frame" class="tour">
          <!-- Content Tour -->
      
          <div id="tour-frame" style="display: block; /*overflow: hidden;*/">
              <nav class="tour-top-navi">
              <!-- Hier den HTML-Inhalt aus dem alten Story-<nav>-Bereich einfügen, um alle Buttons anzuzeigen -->
              </nav>
              <div id="story-box" class="ui-scroll-content">
                      <!-- Hier den HTML-Inhalt aus dem alten Story-Bereich einfügen -->
              </div>
          <!-- End of: Content Tour -->
      </div>
  8. Die neue index.html speichern und den Texteditor schließen.

  9. Story im VC Story Plugin prüfen, um sicherzustellen, dass alles wie erwartet funktioniert.

2. Nicht mehr unterstützt

Die folgenden Funktionen älterer Versionen von VC Story werden in der neuesten Version des VC Story Plugins nicht mehr unterstützt oder wurden durch neue Funktionen ersetzt:

2.1. Willkommensbildschirm

Der Willkommens-Vollbildschirm wird nicht mehr unterstützt. Stattdessen kann die Start-Einstellung des Moduls verwendet werden, um einen Willkommensbildschirm zu erstellen. Dieser kann jedoch nicht mehr im Vollbild angezeigt werden. Um die gleiche Funktionalität wie zuvor zu erreichen, also "Tour starten", kann der vom Bildschirm bereitgestellte Button zusammen mit einer sogenannten "Callback-Aktion" verwendet werden. Folgender Code ist im Feld Callback-Optionen einzufügen:

[
    {
        "type": "ActivateStoryCallback"
    }
]

Weitere Informationen zur Callback-Aktion finden sich auf der Seite Story Aktionen.

2.2. Story ein-/ausblenden

Der Story ein-/ausblenden-Button (auf der linken Seite der Story) wird nicht mehr unterstützt. Stattdessen kann der Story-Button in der Kartenkopfzeile verwendet werden, um die Story ein- oder auszublenden.