Scribe - Publish via HTML vs IFRAME

When creating and embedding documentation or instructional content, choosing between Scribe's HTML and iFrame versions can impact maintenance, accessibility, and real-time updates.

Overview

When creating and embedding documentation or instructional content, choosing between Scribe's HTML and iFrame versions can impact maintenance, accessibility, and real-time updates.

Comparison: HTML vs. iFrame

Feature	Scribe HTML	iFrame
Publishing Method	Generates an HTML file that must be manually updated.	Links to a live iFrame version that updates in real time.
Maintenance	Requires manual re-publishing to reflect changes.	Automatically updates without manual intervention.
Functionality	Static presentation with basic formatting.	Dynamic interface with scroll features, slides, and enhanced presentations.
User Experience	Good for standalone documentation that doesn’t need frequent updates.	Ideal for embedding interactive guides within a webpage.

When to Use Each Version

Use Scribe HTML When:

• You need a static document that doesn’t require frequent updates.

• You want a simple file to share or upload without dependency on external sources.

• Version control is important, and manual updates are acceptable.

Use iFrame When:

• The documentation needs real-time updates without manual intervention.

• You require scrolling functionality and interactive features (e.g., slides, presentations).

• The guide will be embedded within a website for seamless accessibility.

Steps to Implement Each Version

Scribe HTML Implementation

1. Generate the HTML version of your documentation in Scribe.

2. Download and save the HTML file to your local system.

3. Upload the file to TDX/website or designated storage location.

4. If updates are needed, regenerate and replace the existing HTML file manually.

iFrame Implementation

1. Copy the provided iFrame embed code from Scribe.

2. Paste the embed code into the desired webpage or application.

3. The iFrame will dynamically display updates without requiring manual uploads.

4. Ensure the webpage or application supports iFrame embedding for a smooth experience.

Additional Information 

Contact ITS if you need help in setting up the environment or check out this Scribe Service Catalog for more information