Media: Iframe - envris/White-Label-Help-Wiki GitHub Wiki

Brief description

The "Iframe" media type is for embedding 3rd party content to the site. This can include Departmental content hosted outside the site. This functionality is primarily intended to support the seamless integration of complex data visualisations provided by web-hosted visualisation tools, or bespoke interactive graphics created by the Department.

The iframe media can only be created by site administrators, but once created can be embedded into site content by any content editor.

---

Detailed description

The "Iframe" media type consists of 3rd party contents that are available to be embedded onto the content page throughout the White Label site.

To add new "iframe" media:

• Go to Content → Media → Add Media → iframe

The iframe media has these fields:

• Name: Enter the media name.
• Image: Upload an image (recommended: a screenshot of the content). This image will be used as a thumbnail when browsing the media. It will not be displayed in the front end.
• URL: The URL of the content to be embedded. The Data visualisation services should provide a "share" URL which should be used here (or it can be extracted from the "embed" code snippet).
• Aspect ratio: Set the aspect ratio of the iframe
• Caption(optional)
• Accessible description (optional)

The iframe can be added to the content using the Component Media or embed the Media entity from the rich text editor.

---

Technical description

The "Iframe" media type has the following fields:

• Name
• URL
• Caption
• Accessible Description
• Aspect Ration
• Image

Further customisation of the "Iframe" media type can be done via "/admin/structure/media/manage/iframe".