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

MINOR oEmbed documentation

Browse Source
This commit is contained in:
Ingo Schommer 2012-06-08 18:30:31 +02:00
parent c0b3512fd4
commit 86bdd167cc
2 changed files with 32 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/en/reference/image.md
View File

@ -2,15 +2,21 @@
## Introduction ## Introduction
Represents an image object, inheriting all base functionality from the [file](api:file) class with extra functionality Represents an image object through the `[api:Image]` class, inheriting all base functionality from the `[api:File]` class with extra functionality including resizing.
including resizing.
## Usage ## Usage
### Form Fields ### Managing images through form fields
* `[api:Image]`. Designed to provide a complex image uploader for the CMS. Images can be uploaded like any other file, through `[api:FileField]`.
* `[api:FileField]` and `[api:UploadField]`. Allows upload of images (through limiting file extensions with `setAllowedExtensions()`). More advanced usage is possible through `[api:UploadField]`,
which provides thumbnails, a detail view of the image properties,
and management of relationships to other DataObject instances.
Allows upload of images through limiting file extensions with `setAllowedExtensions()`.
### Inserting images into the WYSIWYG editor
See [Topics: Rich Text Editing](/topics/rich-text-editing).
### Resizing Images in PHP ### Resizing Images in PHP

21
docs/en/topics/rich-text-editing.md
View File

@ -43,6 +43,27 @@ Example: Remove some buttons for more advanced formatting
// File: mysite/_config.php // File: mysite/_config.php
HtmlEditorConfig::get('cms')->removeButtons('tablecontrols', 'blockquote', 'hr'); HtmlEditorConfig::get('cms')->removeButtons('tablecontrols', 'blockquote', 'hr');
## Image and Media Insertion
The `[api:HtmlEditorField]` API also handles inserting images and media
files into the managed HTML content. It can be used both for referencing
files on the webserver filesystem (through the `[api:File]` and `[api:Image]` APIs),
as well as hotlinking files from the web.
## oEmbed: Embedding media through external services
The ["oEmbed" standard](http://www.oembed.com/) is implemented by many media services
around the web, allowing easy representation of files just by referencing a website URL.
For example, a content author can insert a playable youtube video just by knowing
its URL, as opposed to dealing with manual HTML code.
oEmbed powers the "Insert from web" feature available through `[api:HtmlEditorField]`.
Internally, it makes HTTP queries to a list of external services
if it finds a matching URL. These services are described in the `Oembed.providers` configuration.
Since these requests are performed on page rendering, they typically have a long cache time (multiple days). To refresh a cache, append `?flush=1` to a URL.
To disable oEmbed usage, set the `Oembed.enabled` configuration property to "false".
## Recipes ## Recipes
### Customizing the "Insert" panels ### Customizing the "Insert" panels