1. Migration and Compatibility

The VC Story Plugin is designed to be partly backward compatible with previous versions of VC Story. However, users should ensure that their story configurations are updated to match the latest action types and capabilities.

1.1. Migration Steps

To migrate your existing VC Story configurations to the latest version, follow carefully these steps:

  1. Review Existing Stories: Check your current story configurations for compatibility with the new action types.

  2. Update Action Types: Replace any deprecated action types with their new equivalents as defined in the latest documentation.

  3. Test Stories: After updating, thoroughly test each story to ensure all actions function as expected.

  4. Adjust Visuals: If necessary, update the HTML content to align with any new design standards or capabilities introduced in the latest version.

  5. Backup: Always keep a backup of your original story files before making any changes.

  6. Documentation Review: Consult the latest documentation for any additional changes or new features that may enhance your stories.

Please read the below migration example carefully and follow the steps.

1.1.1. Migration Example

Once you followed Story Creation Steps, you can migrate your existing stories as follows:

  1. backup 'items.json' in your new story folder.

  2. copy 'items.json' from your old story folder to the new one.

  3. open 'items.json' in a text editor.

  4. check & replace check the action types against the new ones and replace them if necessary. More information about the new action types can be found in the Story actions reference page.

  5. save 'items.json' and close the text editor.

  6. open the new index.html file from new story folder.

  7. open the old index.html file from old story folder

    • copy the content of the <nav> section from the old index.html file and paste it into the new index.html file, replacing the existing <nav> section.

    • copy the content of the <section id="story-box"> section from the old index.html file and paste it into the new index.html file, replacing the existing <section id="story-box"> section.

      <div id="story-frame" class="tour">
  <!-- Content Tour -->

  <div id="tour-frame" style="display: block; /*overflow: hidden;*/">
    <nav class="tour-top-navi">
    <!-- Place here your html content from old story from <nav> section to display all buttons -->
    </nav>
    <div id="story-box" class="ui-scroll-content">
        <!-- Place here your html content from old story from story section -->
    </div>
  <!-- End of: Content Tour -->
</div>

  8. save the new index.html file and close the text editor.

  9. check the story in the VC Story Plugin to ensure everything works as expected.

2. Not longer supported

The following features of older version of VC Story are no longer supported in the latest version of the VC Story Plugin or have been replaced by new features:

2.1. Welcome screen

The welcome full screen is not longer supported. Instead, the start settings of the module can be used to create a welcome screen. However this screen cannot be displayed full screen. To be able to create the same functionality as before, meaning "Start Tour", the button provided by the screen can be used along with a so called "Callback action". Please add the below code in field Callback options:

[
  {
    "type": "ActivateStoryCallback"
  }
]

Further information about the Callback action can be found in the Story actions reference page.

2.2. Hide/Show Story

The Hide/Show Story button (at the left side of the story) is not longer supported. Instead, the story button in the map header can be used to hide or show the story.