tonyair/silverstripe-iframe
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-iframe synced 2024-10-22 11:05:51 +02:00
Code Issues Projects Releases Wiki Activity

DOCS Update readme and userguide to be a bit more specific about what this module does

Browse Source
This commit is contained in:
Robbie Averill 2019-02-01 12:37:59 +03:00
parent d9c629291f
commit 14837665b4
3 changed files with 30 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -7,8 +7,14 @@
## Introduction ## Introduction
The iframe module provides an IFrame page type that allows you to embed an IFrame into a page without resorting to The IFrame module provides an IFrame page type in the CMS which allows you to embed an IFrame into a page without
custom code. 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.
## Requirements ## Requirements
@ -18,8 +24,13 @@ custom code.
## Installation ## Installation
Run `composer require silverstripe/iframe`, then append dev/build?flush=all to the website URL in your Install with Composer:
browser. e.g. http://mysite.test/dev/build?flush=all
```
composer require silverstripe/iframe
```
After installation, ensure you run `dev/build?flush` in either your browser or via command line.
## Instructions ## Instructions

26
docs/en/userguide/index.md
View File

@ -1,5 +1,5 @@
title: IFrame page title: IFrame page
summary: Embed IFrames in your website without adding code summary: Embed IFrames in your website without adding custom code
# IFrame # IFrame
@ -8,29 +8,31 @@ summary: Embed IFrames in your website without adding code
* Create and modify an IFrame * Create and modify an IFrame
## Before we begin ## Before we begin
Make sure that your SilverStripe installation has the [IFrame](http://addons.silverstripe.org/add-ons/silverstripe/iframe) module installed. Make sure that your SilverStripe installation has the [IFrame](https://addons.silverstripe.org/add-ons/silverstripe/iframe) module installed.
This module provides a page type that you can use to embed IFrames in your website. This module provides a page type that you can use to embed IFrames in your website.
## Creating an IFrame ## Creating an IFrame
IFrame pages are created like any other page. When you create a new page, selected the **I Frame Page** from the list of available page types. IFrame pages are created like any other page. When you create a new page, select the **IFrame Page** from the list of
available page types.
There are a few new fields on an IFrame page. There are a few extra fields on an IFrame page which can help you to customise the IFrame that gets created on the
frontend of your website.
The most important is *Iframe URL*: this is the URL that wish you display inside the IFrame. This can be an absolute The most important is *IFrame URL*: this is the URL that wish you display inside the IFrame. This can be an absolute
path (ie, http://example.com/) or a relative path (ie, /about-us/). If it is a relative path then it will be assumed to path (e.g. `http://example.com/`) or a relative path (e.g. `/about-us/`). If it is a relative path then it will be assumed to
be from the root of your site (ie, http://mysite.com/about-us/). be from the root of your site (e.g `http://mysite.com/about-us/`).
*Auto height* will change the height of the IFrame to match the total height of the remote page. "Auto height" will change the height of the IFrame to match the total height of the remote page.
_This will only work if the remote page is hosted on the same domain._ _This will only work if the remote page is hosted on the same domain._
If you check *Auto width* the IFrame will take up the entire width of the content area that it is in. If you check "Auto width" the IFrame will take up the entire width of the content area that it is in.
You can manually set the height and width with the *Fixed height* and *Fixed width* fields. You can manually set the height and width with the "Fixed height" and "Fixed width" fields.
The Auto width/height options must not be enabled for these fields to work. The "Auto width/height" options must not be enabled for these fields to work.
The *Content* field has been broken up into three separate fields: one to display above the IFrame, one to display The "Content" field has been broken up into three separate fields: one to display above the IFrame, one to display
beneath the IFrame, and another to display instead of the IFrame if the user has disabled them. beneath the IFrame, and another to display instead of the IFrame if the user has disabled them.
## Known Issues ## Known Issues

2
license.md
View File

@ -1,4 +1,4 @@
Copyright (c) 2017, SilverStripe Limited Copyright (c) 2019, SilverStripe Limited
All rights reserved. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: