silverstripe-iframe/README.md

# IFrame module

[![CI](https://github.com/silverstripe/silverstripe-iframe/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-iframe/actions/workflows/ci.yml)
[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)

## Introduction

The IFrame module provides an IFrame page type in the CMS which allows you to embed an IFrame into a page without
resorting to custom code in your templates or TinyMCE instance.
 
This can help if you have `iframe` disabled in TinyMCE's [valid_elements](https://www.tiny.cloud/docs-3x/reference/configuration/Configuration3x@valid_elements/)
and do not want to to re-enable it in for a single/specific use-case. It's also possible that using a Web Application
Firewall (WAF) may block page save requests that contain iframe elements in HTML content, which using this module would
circumvent.

Various attributes of the IFrame can be controlled from CMS fields, such as size and content that surrounds the
IFrame itself.

## Requirements

 * Silverstripe ^4.0

**Note:** For a Silverstripe 3.x compatible version, please use [the 1.x release line](https://github.com/silverstripe/silverstripe-iframe/tree/1.0).

## Installation

Install with Composer:

```
composer require silverstripe/iframe
```

After installation, ensure you run `dev/build?flush` in either your browser or via command line.

## Instructions

For usage instructions see the [user manual](docs/en/userguide/index.md).

## Contributing

### Translations

Translations of the natural language strings are managed through a third party translation interface, transifex.com. Newly added strings will be periodically uploaded there for translation, and any new translations will be merged back to the project source code.

Please use [https://www.transifex.com/projects/p/silverstripe-iframe](https://www.transifex.com/projects/p/silverstripe-iframe) to contribute translations, rather than sending pull requests with YAML files.
Add user docs 2013-02-27 05:09:14 +01:00			`# IFrame module`
Update build status badge 2021-01-21 04:36:05 +01:00
MNT Use GitHub Actions CI 2022-07-05 08:56:57 +02:00			`[![CI](https://github.com/silverstripe/silverstripe-iframe/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-iframe/actions/workflows/ci.yml)`
MNT Standardise modules 2022-08-01 00:08:57 +02:00			`[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)`
Add user docs 2013-02-27 05:09:14 +01:00
			`## Introduction`

DOCS Update readme and userguide to be a bit more specific about what this module does 2019-02-01 10:37:59 +01:00			`The IFrame module provides an IFrame page type in the CMS which allows you to embed an IFrame into a page without`
			`resorting to custom code in your templates or TinyMCE instance.`

			This can help if you have `iframe` disabled in TinyMCE's [valid_elements](https://www.tiny.cloud/docs-3x/reference/configuration/Configuration3x@valid_elements/)
Add note about possibility for a WAF to block requests containing iframes 2019-02-13 03:26:35 +01:00			`and do not want to to re-enable it in for a single/specific use-case. It's also possible that using a Web Application`
			`Firewall (WAF) may block page save requests that contain iframe elements in HTML content, which using this module would`
			`circumvent.`
DOCS Update readme and userguide to be a bit more specific about what this module does 2019-02-01 10:37:59 +01:00
			`Various attributes of the IFrame can be controlled from CMS fields, such as size and content that surrounds the`
			`IFrame itself.`
Add user docs 2013-02-27 05:09:14 +01:00
			`## Requirements`

MNT Standardise modules 2022-08-01 00:08:57 +02:00			`* Silverstripe ^4.0`
update readme and docs for SS4 specific infos 2017-11-22 22:47:30 +01:00
MNT Standardise modules 2022-08-01 00:08:57 +02:00			`Note: For a Silverstripe 3.x compatible version, please use [the 1.x release line](https://github.com/silverstripe/silverstripe-iframe/tree/1.0).`
Add user docs 2013-02-27 05:09:14 +01:00
			`## Installation`

DOCS Update readme and userguide to be a bit more specific about what this module does 2019-02-01 10:37:59 +01:00			`Install with Composer:`

			```
			`composer require silverstripe/iframe`
			```

			After installation, ensure you run `dev/build?flush` in either your browser or via command line.
Add user docs 2013-02-27 05:09:14 +01:00
			`## Instructions`

update readme and docs for SS4 specific infos 2017-11-22 22:47:30 +01:00			`For usage instructions see the [user manual](docs/en/userguide/index.md).`
Transifex support 2013-10-24 22:21:58 +02:00
			`## Contributing`

			`### Translations`

			`Translations of the natural language strings are managed through a third party translation interface, transifex.com. Newly added strings will be periodically uploaded there for translation, and any new translations will be merged back to the project source code.`

ENHANCEMENT: Addition of code coverage and badges 2016-02-24 15:03:05 +01:00			`Please use [https://www.transifex.com/projects/p/silverstripe-iframe](https://www.transifex.com/projects/p/silverstripe-iframe) to contribute translations, rather than sending pull requests with YAML files.`