Skip to content

Commit 41a7d0a

Browse files
soul-wishkarawitan
authored andcommitted
Fix some typos and errors 📝 (mediaelement#2699)
1 parent 9993131 commit 41a7d0a

File tree

6 files changed

+32
-32
lines changed

6 files changed

+32
-32
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ In general, `MediaElement.js` supports **IE11+, MS Edge, Chrome, Firefox, Safari
4242

4343
## * IMPORTANT NOTE for Safari users (Jun 8, 2017)
4444

45-
Since Sierra version, `autoplay` policies have changed. You may experience an error if you try to execute `play` programatically or via `autoplay` attribute with MediaElement, unless `muted` attribute is specified.
45+
Since Sierra version, `autoplay` policies have changed. You may experience an error if you try to execute `play` programmatically or via `autoplay` attribute with MediaElement, unless `muted` attribute is specified.
4646

4747
For more information, read https://webkit.org/blog/7734/auto-play-policy-changes-for-macos/
4848

@@ -64,7 +64,7 @@ In order to successfully install `4.x` in an existing setup, you must consider t
6464

6565
2. By default, `MediaElement` has bundled native renderers, such as HLS, M(PEG)-DASH and FLV, as well as YouTube and Flash shims. **If you want to use any other renderer, you MUST refer to the `build/renderers` folder and add as many as you want**. Check `demo/index.html` for a better reference.
6666

67-
3. You **must** set up now the path for the Flash shims if they are not in the same folder as the JS files. To do this, set the path via the `pluginPath` configuration. In the same topic, if you need to support browsers with Javascript disabled, you **must** reference the correct Flash shim, since in `2.x` there was only a single Flash shim and in `3.x` it was split to target specific media types. Check the [Browsers with JavaScript disabled](docs/installation.md#disabled-javascript) section for more details.
67+
3. You **must** set up now the path for the Flash shims if they are not in the same folder as the JS files. To do this, set the path via the `pluginPath` configuration. In the same topic, if you need to support browsers with JavaScript disabled, you **must** reference the correct Flash shim, since in `2.x` there was only a single Flash shim and in `3.x` it was split to target specific media types. Check the [Browsers with JavaScript disabled](docs/installation.md#disabled-javascript) section for more details.
6868

6969
4. If you want to use Flash shims from a CDN, do the change related to `pluginPath` setting the CDN's URL, and also setting `shimScriptAccess` configuration as **`always`**.
7070

changelog.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@
171171
* Improved error system to catch more errors and present them to user @rafa8626
172172
* Removed `mediaelementplayer` bundles, as well as `jQuery` file, considered unnecessary @rafa8626
173173
* Added new middleware layer to allow interaction with other players @rafa8626
174-
* Used flex-box to reduce calculation via Javascript on control bar (https://github.com/mediaelement/mediaelement/pull/2261) @marcobiedermann and @rafa8626
174+
* Used flex-box to reduce calculation via JavaScript on control bar (https://github.com/mediaelement/mediaelement/pull/2261) @marcobiedermann and @rafa8626
175175
* Fixed issue with events not being unbound when player is destroyed and removed unnecessary callbacks from it @rafa8626
176176
* Added missing style for buffering element @rafa8626
177177
* Removed conditional to disable control bar when an error happens @rafa8626
@@ -515,7 +515,7 @@
515515

516516
*2.23.5 (2017/01/06)*
517517

518-
* Fixed typo that caused Wordpress support for translations to be broken (#1984) @rafa8626
518+
* Fixed typo that caused WordPress support for translations to be broken (#1984) @rafa8626
519519

520520
*2.23.4 (2016/10/21)*
521521

@@ -774,11 +774,11 @@
774774
* Add bower.json (https://github.com/mediaelement/mediaelement/pull/1188) @herby
775775
* i18n : add French translation (https://github.com/mediaelement/mediaelement/pull/1177) @kloh-fr
776776
* IE8 layout (Adding width and height to .me-plugin) @peterh-capella
777-
* Fixes #1113 - Youtube Playbutton on load hidden (https://github.com/mediaelement/mediaelement/pull/1140) @LOK-Soft
777+
* Fixes #1113 - YouTube Playbutton on load hidden (https://github.com/mediaelement/mediaelement/pull/1140) @LOK-Soft
778778
* setVideoSize : verify this.pluginElement before this.pluginElement.style (https://github.com/mediaelement/mediaelement/pull/1175) @bdecarne
779779
* VideoElement.as: fix duration on setSrc (https://github.com/mediaelement/mediaelement/pull/1127) @rounce
780780
* don't hide controls when they're being hovered over (https://github.com/mediaelement/mediaelement/pull/1121) @rounce
781-
* flash: send keydown events up to javascript (https://github.com/mediaelement/mediaelement/pull/1120) @rounce
781+
* flash: send keydown events up to JavaScript (https://github.com/mediaelement/mediaelement/pull/1120) @rounce
782782
* Restore IE6 compatibility for 100% (https://github.com/mediaelement/mediaelement/pull/1021) @ryokenau
783783
* Added playback speed (HTML5 only), fixed caption's auto-size when fullscreen (https://github.com/mediaelement/mediaelement/pull/1027) @cheng-shiwen
784784
* Cleaned up playback speed (https://github.com/mediaelement/mediaelement/pull/1249) @matthillman
@@ -813,7 +813,7 @@
813813
* Fixed display of volume control on non-mobile touch devices (https://github.com/mediaelement/mediaelement/pull/1093) @OwenEdwards
814814
* Calculate correctly the video player height for 100% (https://github.com/mediaelement/mediaelement/pull/1083) @LeResKP
815815
* restore focus after click on the controls (https://github.com/mediaelement/mediaelement/pull/1094) @rounce
816-
* Support youtu.be URL for youtube source (https://github.com/mediaelement/mediaelement/pull/1135) @clkao
816+
* Support youtu.be URL for YouTube source (https://github.com/mediaelement/mediaelement/pull/1135) @clkao
817817
* Make slider work on touch devices (https://github.com/mediaelement/mediaelement/pull/1033) @Singularetantum
818818
* add Simplified Chinese translation (https://github.com/mediaelement/mediaelement/pull/1065) @michaeljayt
819819
* Fixed the reference to `media` in the bigPlay control creation. (https://github.com/mediaelement/mediaelement/pull/1111) @nuzzio
@@ -824,7 +824,7 @@
824824

825825
* Removed breaking `hasTouch` detection
826826
* Fixed IE detection https://github.com/mediaelement/mediaelement/pull/1018
827-
* fix play() on ipad does not start playing and double click issue (https://github.com/mediaelement/mediaelement/pull/918) @fbuecklers
827+
* fix play() on iPad does not start playing and double click issue (https://github.com/mediaelement/mediaelement/pull/918) @fbuecklers
828828
* added scale=default to Flash for better 100% https://github.com/mediaelement/mediaelement/pull/963
829829
* Add code fences for GHFM https://github.com/mediaelement/mediaelement/pull/975
830830
* i18n improvements https://github.com/mediaelement/mediaelement/pull/1025
@@ -842,15 +842,15 @@
842842
*2.12.1 (2013/08/26)*
843843

844844
* Remove all `console.log` statements in `Builder.py` @mediaelement
845-
* More i18n fixes for Wordpress https://github.com/mediaelement/mediaelement/pull/940 @SergeyBiryukov
845+
* More i18n fixes for WordPress https://github.com/mediaelement/mediaelement/pull/940 @SergeyBiryukov
846846
* Fix touch detection in QtWebKit https://github.com/mediaelement/mediaelement/pull/939 @peterbrook
847847
* Added configuration option httpsBasicAuthSite fix sites using HTTPS basic authentication (benroy73) https://github.com/mediaelement/mediaelement/pull/937
848848
* Fixed backlight plugin error https://github.com/mediaelement/mediaelement/pull/932 @eviweb
849849
* Fix some wrong dates on the change log https://github.com/mediaelement/mediaelement/pull/930 @heartcode
850850
* Add a mejs-fullscreen css class on the root element https://github.com/mediaelement/mediaelement/pull/925 @fbuecklers
851851
* fix for ff switch between fullscreen and normal mode https://github.com/mediaelement/mediaelement/pull/924 @fbuecklers
852852
* Multiple fixes: old issue #548, current issues #754 and #902 https://github.com/mediaelement/mediaelement/pull/923 @peterh-capella
853-
* fix firefox detect 100% mode issue https://github.com/mediaelement/mediaelement/pull/919 @KaptinLin
853+
* fix Firefox detect 100% mode issue https://github.com/mediaelement/mediaelement/pull/919 @KaptinLin
854854
* Option to show the poster when the video is ended https://github.com/mediaelement/mediaelement/pull/891 @LeResKP
855855
* Fix for Chrome autoplaying when forcing Flash https://github.com/mediaelement/mediaelement/pull/889 @tjsnyder
856856
* Allow SWF to work over insecure domain https://github.com/mediaelement/mediaelement/pull/897 @sebablanco
@@ -879,7 +879,7 @@
879879

880880
*2.11.3 (2013/04/13)*
881881

882-
* Change to `getScriptPath` to allow querystring variables to be added (for Wordpress Core)
882+
* Change to `getScriptPath` to allow querystring variables to be added (for WordPress Core)
883883

884884
*2.11.2 (2013/04/12)*
885885

@@ -900,7 +900,7 @@ Fixes and updates
900900
* Protocol relative YouTube URLs for `iframe` API (https://github.com/mediaelement/mediaelement/pull/825) @dtsosie
901901
* Added aria-label to all button elements (https://github.com/mediaelement/mediaelement/pull/824) @Luzifer
902902
* Fixed preroll adclick URL (mediaelement)
903-
* Traditional chinese locale strings for i18n module (latzt) (https://github.com/mediaelement/mediaelement/pull/820)
903+
* Traditional Chinese locale strings for i18n module (latzt) (https://github.com/mediaelement/mediaelement/pull/820)
904904
* Allow captions on audio player (https://github.com/mediaelement/mediaelement/pull/819) @LeResKP
905905
* Fix incorrect path returned by `getScriptPath()` @Ciki
906906
* Overhauling hover div creation and placement (https://github.com/mediaelement/mediaelement/pull/813) @JeffreyATW
@@ -924,7 +924,7 @@ Fixes and updates
924924
* Properly clean up player when calling MediaElementPlayer.remove() (https://github.com/mediaelement/mediaelement/pull/779) @odnamrataizem
925925
* Add "mejs-shim" class to all shims to prevent improper resizing (https://github.com/mediaelement/mediaelement/pull/789) @JeffreyATW
926926
* Bug fix for the error "this.pluginApi.pauseMedia is not a function" when using the flash player and removing the dom element. https://github.com/mediaelement/mediaelement/pull/788 @Jmaharman
927-
* Make possible to open youtube links as audio only https://github.com/mediaelement/mediaelement/pull/784 @Seb33300
927+
* Make possible to open YouTube links as audio only https://github.com/mediaelement/mediaelement/pull/784 @Seb33300
928928
* Add a few basic Jasmine tests https://github.com/mediaelement/mediaelement/pull/781 @msgilligan
929929
* Add option to hide the video controls on load https://github.com/mediaelement/mediaelement/pull/780#issuecomment-14781622 @eResKP
930930
* @cc button can now be a toggle when there's just one track https://github.com/mediaelement/mediaelement/pull/793 @LeResKP
@@ -1023,7 +1023,7 @@ Fixes and updates
10231023
*2.8.1 (2012/04/19)*
10241024

10251025
* Flash fullscreen: video not fullsized
1026-
* Flash fullscreen: youtube controls not working
1026+
* Flash fullscreen: YouTube controls not working
10271027

10281028
*2.8.0 (2012/04/17)*
10291029

@@ -1202,12 +1202,12 @@ Fixes and updates
12021202
* added alwaysShowControls option (kaichen)
12031203
* forceful padding override on buttons
12041204
* started "ender" branch to experiment with removing jQuery dependency and baking in ender.js
1205-
* updated the use of `type` javascript option with src is present
1205+
* updated the use of `type` JavaScript option with src is present
12061206
* remove preload="none" hack for Chrome now that it supports it (note: Chrome still strangely fires a 'loadstart' event)
12071207
* added hooks for other jQuery compatible libraries like @ender.js(http://enderjs.com)
1208-
* Wordpress: if you don't specify a file extension, mejs will look for attached files and use them @video src="/wp-content/uploads/myfile"
1209-
* Wordpress: option to select a 'skin'
1210-
* Wordpress: option to select audio width/height
1208+
* WordPress: if you don't specify a file extension, mejs will look for attached files and use them @video src="/wp-content/uploads/myfile"
1209+
* WordPress: option to select a 'skin'
1210+
* WordPress: option to select audio width/height
12111211

12121212
*2.1.6 (2011/06/14) - 35.5kb*
12131213

@@ -1282,7 +1282,7 @@ Fixes and updates
12821282

12831283
* Whitespace cleanup on files
12841284
* Preventing flash/sl plugins from reinitializing when they are removed by another script
1285-
* Fixed IE JavaScript errors in Flash fallback (seen in Wordpress)
1285+
* Fixed IE JavaScript errors in Flash fallback (seen in WordPress)
12861286
* Added 'play' event to Silverlight to prevent errors
12871287

12881288
*2.0.5 (2011/01/25) - 31.7kb*
@@ -1315,7 +1315,7 @@ Fixes and updates
13151315

13161316
* Changed HTML escape method to encodeURICompnent
13171317
* Flash-based RMTP support (contributor: sylvinus)
1318-
* Fixed Wordpress loop bug
1318+
* Fixed WordPress loop bug
13191319
* Changed time popup to move with mouse instead of currentTime
13201320
* added enablePluginSmoothing (Flash)
13211321
* Added some "play" "playing" event duplication to Flash

docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ tracksAriaLive | boolean | `false` | By default, no WAI-ARIA live region - don't
134134
hideCaptionsButtonWhenEmpty | boolean | `true` | Option to remove the `[cc]` button when no `<track kind="subtitles">` are present
135135
toggleCaptionsButtonWhenOnlyOne | boolean | `false` | If true and we only have one track, change captions to toggle button
136136
startLanguage | string | _(empty)_ | Automatically turn on a `<track>` element. Note: Will not work when toggleCaptionsButtonWhenOnlyOne is set to `true`
137-
slidesSelector | string | _(empty)_ | Selector for slides; could be any valid Javascript selector (`#id`, `.class`, `img`, etc.)
137+
slidesSelector | string | _(empty)_ | Selector for slides; could be any valid JavaScript selector (`#id`, `.class`, `img`, etc.)
138138
tracksText | string | `null` | Title for Closed Captioning button for WARIA purposes
139139
chaptersText | string | `null` | Title for Chapters button for WARIA purposes
140140
muteText | string | `null` | Title for Mute button for WARIA purposes

docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ To get the default installation there are several different ways.
6969

7070
3. Through GIT: `git clone https://github.com/mediaelement/mediaelement.git`
7171

72-
4. Through NPM: `npm install mediaelement`
72+
4. Through npm: `npm install mediaelement`
7373

7474
5. Through BOWER: `bower install mediaelement`
7575

@@ -329,7 +329,7 @@ If you want to install any of them, refer to the new plugins repository clicking
329329
<link rel="stylesheet" href="/path/to/mediaelementplayer.min.css" />
330330
```
331331

332-
If you wish to install the sources in different directories (i.e., all Javascript files in a _js_, all CSS in a _styles_, Flash shims in _plugins_, etc.), add the following CSS update after the _mediaelementplayer.css_ reference (**only if the images are not in the same folder as the stylesheet**):
332+
If you wish to install the sources in different directories (i.e., all JavaScript files in a _js_, all CSS in a _styles_, Flash shims in _plugins_, etc.), add the following CSS update after the _mediaelementplayer.css_ reference (**only if the images are not in the same folder as the stylesheet**):
333333
```html
334334
<link rel="stylesheet" href="/path/to/mediaelementplayer.min.css" />
335335

docs/resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The following resources talk about a variety of topics that users of `MediaEleme
2323
## Code snippets
2424

2525
* [CSS Tricks: Video Source by Screen Size](https://css-tricks.com/video-source-by-screen-size/)
26-
* [Mute tab audio on tab unfocus in javascript/html](https://stackoverflow.com/questions/34506133/mute-tab-audio-on-tab-unfocus-in-javascript-html)
26+
* [Mute tab audio on tab unfocus in JavaScript/html](https://stackoverflow.com/questions/34506133/mute-tab-audio-on-tab-unfocus-in-javascript-html)
2727
* [MediaElementPlayer.js: use `AudioContext.decodeAudioData()`](https://gist.github.com/rafa8626/e6afe41dd00742a75c4d25cc387a7d61)
2828
* [Use of DRM with MediaElement](https://jsfiddle.net/f431r2zq/12/)
2929
* [MediaElementPlayer.js using Chromecast and dynamic sources](https://jsfiddle.net/Luuwnjfm/18/)

docs/usage.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* [Automatic start](#automatic)
55
* [Vanilla JavaScript](#vanilla)
66
* [jQuery](#jquery)
7-
* [NPM/Meteor](#npm-meteor)
7+
* [npm/Meteor](#npm-meteor)
88
* [RequireJS](#requirejs)
99
* [React](#react)
1010
* [Use Renderers](#renderers-usage)
@@ -78,7 +78,7 @@ You can avoid running any startup scripts by adding `class="mejs__player"` to th
7878
```
7979

8080
<a id="npm-meteor"></a>
81-
### NPM/Meteor
81+
### npm/Meteor
8282
```javascript
8383
// To import only MediaElement class
8484
import 'mediaelement/standalone';
@@ -117,7 +117,7 @@ import 'mediaelement'; // or import `mediaelement/standalone` if you only want t
117117
### RequireJS
118118
With `Require.js`, you will need the following setup if you are planning to use HLS, M(PEG)-DASH or FLV, given the way the packages are bundled.
119119

120-
To make it work, install via NPM any of the external libraries you will need (i.e., HLS.js).
120+
To make it work, install via npm any of the external libraries you will need (i.e., HLS.js).
121121
```
122122
npm install hls.js
123123
```
@@ -151,7 +151,7 @@ require(['path/to/hls'], function (Hls) {
151151
### React
152152
With `React.js`, you will need to install the external libraries the same way as `Require`.
153153

154-
Once installed through NPM, you will be able to create your component using `MediaElement`. As an example:
154+
Once installed through npm, you will be able to create your component using `MediaElement`. As an example:
155155

156156
**MediaElement.js**
157157
```javascript
@@ -299,7 +299,7 @@ module: {
299299
]
300300
}
301301
```
302-
* For other renderers that cannot be installed through NPM, such as YouTube, you might need to load their script through `componentDidMount` method:
302+
* For other renderers that cannot be installed through npm, such as YouTube, you might need to load their script through `componentDidMount` method:
303303
```javascript
304304
componentDidMount() {
305305
let loaded = false;
@@ -406,7 +406,7 @@ i.e., to call `FRAGMENT_PLAYING`, you need to write `onFragmentPlaying` on JS. T
406406
* `ogg` formats will not play consistently in all browsers so it is strongly recommended a MP3 fallback for audio, or MP4 for video.
407407
* `wav` and `webm` formats will only play on Browsers that support it natively since there is currently no Flash fallback to allow them to play in other browsers.
408408
* `flv` and `mpd` will not work on iOS since it doesn't support MSE; for `mpd` use a `m3u8` fallback.
409-
* Soundcloud can play with `html5` renderer using the following URL format: `https://api.soundcloud.com/tracks/XXX/stream?client_id=XXX`
409+
* SoundCloud can play with `html5` renderer using the following URL format: `https://api.soundcloud.com/tracks/XXX/stream?client_id=XXX`
410410

411411

412412
<a id="streching-modes"></a>
@@ -417,15 +417,15 @@ i.e., to call `FRAGMENT_PLAYING`, you need to write `onFragmentPlaying` on JS. T
417417
Mode | Setup
418418
---- | -------
419419
auto | Mode by default, this mode checks if there are any elements in the `video`/`audio` tag to turn the _responsive_ mode; if not, will set it up in _none_ mode.
420-
responsive | Can be turned on by setting `max-width: 100%` style (inline, or in the stylesheet), or `width="100%" height="100%"` attributes in the `video`/`audio` tag. In Javascript, set in the player's configuration `stretching: 'responsive'` (preferred) or `videoWidth: '100%' videoHeight: '100%'`.
420+
responsive | Can be turned on by setting `max-width: 100%` style (inline, or in the stylesheet), or `width="100%" height="100%"` attributes in the `video`/`audio` tag. In JavaScript, set in the player's configuration `stretching: 'responsive'` (preferred) or `videoWidth: '100%' videoHeight: '100%'`.
421421
fill | This mode will crop the video to adapt it to the dimensions of the parent container by only setting up `stretching: 'fill'`. It is encouraged to set up the parent's `height` to `100%` to make it work as expected.
422422
none | Use `width` and `height` attributes specified in the `video`/`audio` tags and no `max-width: 100%` or `width="100%" height="100%"` attributes; otherwise, use the `stretching: 'none'` configuration element to achieve this.
423423

424424

425425
<a id="grid"></a>
426426
## Responsive grid
427427

428-
Since `MediaElement` can adapt its size to be responsive, some might be tempted to use CSS or Javascript to create a responsive grid of videos.
428+
Since `MediaElement` can adapt its size to be responsive, some might be tempted to use CSS or JavaScript to create a responsive grid of videos.
429429

430430
So far, right now the best plugin to be used with `MediaElement` for this task has been [Flexr](http://flexrgrid.com/).
431431

0 commit comments

Comments
 (0)