tonyair
/
silverstripe-iframe
mirror of https://github.com/silverstripe/silverstripe-iframe
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
silverstripe-iframe/README.md

46 lines
2.2 KiB
Markdown
Raw Normal View History

Add user docs
2013-02-27 05:09:14 +01:00
# IFrame module
update readme and docs for SS4 specific infos
2017-11-22 22:47:30 +01:00
[![Build Status](https://travis-ci.org/silverstripe/silverstripe-iframe.svg?branch=master)](https://travis-ci.org/silverstripe/silverstripe-iframe)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/silverstripe/silverstripe-iframe/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-iframe/?branch=master)
[![codecov](https://codecov.io/gh/silverstripe/silverstripe-iframe/branch/master/graph/badge.svg)](https://codecov.io/gh/silverstripe/silverstripe-iframe)
[![Version](http://img.shields.io/packagist/v/silverstripe/iframe.svg?style=flat)](https://packagist.org/packages/silverstripe/silverstripe-iframe)
[![License](http://img.shields.io/packagist/l/silverstripe/iframe.svg?style=flat)](LICENSE.md)
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/)
and do not want to to re-enable it in for a single/specific use-case.
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
update readme and docs for SS4 specific infos
2017-11-22 22:47:30 +01:00
* 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).
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.