Skip to content

Commit 8dfe4ee

Browse files
committed
doc: Update README.md
1 parent f0b718a commit 8dfe4ee

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,23 @@ However, if needed optional arguments may be left blank by not putting anything
124124

125125
* `{{#ev:service|id|||description}}`
126126

127+
Alternatively each parameter can be used in any order as a named parameter. The following parameter are available:
128+
* `id`
129+
* `dimensions`
130+
* `alignment`
131+
* `description`
132+
* `container`
133+
* `urlArgs`
134+
* `autoResize`
135+
* `vAlignment`
136+
* `width`
137+
* `height`
138+
* `cover`
139+
* `title`
140+
141+
**Do note** mixing named and unnamed parameters will require you to add all unnamed parameters (and blanks) in the previously mentioned order.
142+
E.g. using named id and unnamed description `{{#ev:service||||This is the Description|id=abc}}`/ `{{#ev:service|id=abc|||This is the Description}}`
143+
127144
## Examples
128145

129146
### Example #1
@@ -169,6 +186,11 @@ Using a local file as an embed thumbnail and specifying a title
169186

170187
{{#ev:youtube|pSsYTj9kCHE|cover=File:LocalFile.jpg|title=Title of the Embed}}
171188

189+
### Example #7
190+
Using named parameters
191+
192+
{{#ev:youtube|id=pSsYTj9kCHE|dimensions=320x320}}
193+
172194
## Supported Services
173195

174196
As of version 3.x, EmbedVideo supports embedding video content from the following services:
@@ -186,6 +208,9 @@ As of version 3.x, EmbedVideo supports embedding video content from the followin
186208
| [YouTube](http://www.youtube.com/) | `youtubeplaylist` - Playlists | PLY0KbDiiFYeNgQkjujixr7qD-FS8qecoP | https://www.youtube.com/embed/?listType=playlist&list=PLY0KbDiiFYeNgQkjujixr7qD-FS8qecoP |
187209
| [YouTube](http://www.youtube.com/) | `youtubevideolist` - Video List | pSsYTj9kCHE - urlargs=playlist=pSsYTj9kCHE,pSsYTj9kCHE | https://www.youtube.com/embed/pSsYTj9kCHE?playlist=pSsYTj9kCHE,pSsYTj9kCHE |
188210

211+
### New Services
212+
New services can be requested by using the following [link](https://github.com/StarCitizenWiki/mediawiki-extensions-EmbedVideo/issues/new?assignees=&labels=enhancement&template=embed-service-request.md&title=Embed+Service+Request%3A+Service+Name) or clicking `New Issue`.
213+
189214
# Configuration Settings
190215

191216
| Variable | Default Value | Description |

0 commit comments

Comments
 (0)