Skip to content

Commit f7f6328

Browse files
author
Andrew Welch
committed
Textlint fixes
1 parent e6eb26c commit f7f6328

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed

docs/docs/configuring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuring Transcoder
22

3-
The only configuration for Transcoder is in the `config.php` file, which is a multi-environment friendly way to store the default settings. Don't edit this file, instead copy it to `craft/config` as `transcoder.php` and make your changes there.
3+
The only configuration for Transcoder is in the `config.php` file, which is a multi-environment friendly way to store the default settings. Dont edit this file, instead copy it to `craft/config` as `transcoder.php` and make your changes there.
44

55
You will also need [ffmpeg](https://ffmpeg.org/) installed for Transcoder to work. On Ubuntu 16.04, you can do just:
66

docs/docs/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Transcoder Overview
22

3-
The Transcoder plugin allows you to transcode any video or animated gif (local or remote) to any size, bitrate, framerate, and save it out as a web-ready video in a variety of file formats.
3+
The Transcoder plugin allows you to transcode any video or animated GIF (local or remote) to any size, bitrate, framerate, and save it out as a web-ready video in a variety of file formats.
44

55
It can also transcode audio files to any bitrate & sample rate, to a variety of file formats. It can even extract audio tracks from video files.
66

docs/docs/using.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ You can also pass in an `Asset`:
3636
}) %}
3737
```
3838

39-
It will return to you a URL to the transcoded video if it already exists, or if it doesn't exist, it will return `""` and kick off the transcoding process (which can be quite lengthy for long videos).
39+
It will return to you a URL to the transcoded video if it already exists, or if it doesnt exist, it will return `""` and kick off the transcoding process (which can be quite lengthy for long videos).
4040

41-
In the array you pass in, the default values are used if the key/value pair does not exist:
41+
In the array you pass in, the default values are used if the key-value pair does not exist:
4242

4343
```
4444
{
@@ -52,7 +52,7 @@ In the array you pass in, the default values are used if the key/value pair does
5252

5353
These default values come from the `config.php` file.
5454

55-
If you want to have the Transcoder not change a parameter, pass in an empty value in the key/value pair, e.g.:
55+
To have the Transcoder not change a parameter, pass in an empty value in the key-value pair, for example:
5656

5757
```twig
5858
{% set transVideoUrl = craft.transcoder.getVideoUrl('/home/vagrant/sites/nystudio107/public/oceans.mp4', {
@@ -69,19 +69,19 @@ The `aspectRatio` parameter lets you control how the video aspect ratio is maint
6969

7070
![Screenshot](./resources/screenshots/oceans_20s_300w_200h_none.jpg)
7171

72-
`crop` scales the video up to maintain the original aspect ratio, and then crops it so that it's full-frame:
72+
`crop` scales the video up to maintain the original aspect ratio, and then crops it so that its full-frame:
7373

7474
![Screenshot](./resources/screenshots/oceans_20s_300w_200h_crop.jpg)
7575

7676
`letterbox` scales the video to fit the new frame, putting a letterboxed or pillarboxed border to pad it:
7777

7878
![Screenshot](./resources/screenshots/oceans_20s_300w_200h_letterbox.jpg)
7979

80-
You can control the color of the letterboxed area (it's `black` by default) via the `letterboxColor` option. It can be either a semantic color name, or a hexcode color, e.g.: `0xC0C0C0`
80+
You can control the color of the letterboxed area (its `black` by default) via the `letterboxColor` option. It can be either a semantic color name, or a hexcode color, for example: `0xC0C0C0`
8181

8282
The `sharpen` option determines whether an unsharp mask filter should be applied to the scaled video.
8383

84-
The file format setting `videoEncoder` is preset to what you'll need to generate `h264` videos, but it can also generate `webm` videos, or any other format that `ffmpeg` supports. See the `config.php` file for details
84+
The file format setting `videoEncoder` is preset to what youll need to generate `h264` videos, but it can also generate `webm` videos, or any other format that `ffmpeg` supports. See the `config.php` file for details
8585

8686
![Screenshot](./resources/screenshots/admin-cp-video-thumbnails.png)
8787

@@ -120,9 +120,9 @@ You can also pass in an `Asset`:
120120
}) %}
121121
```
122122

123-
It will return to you a URL to the transcoded audio file if it already exists, or if it doesn't exist, it will return `""` and kick off the transcoding process (which can be somewhat lengthy for long audio files).
123+
It will return to you a URL to the transcoded audio file if it already exists, or if it doesnt exist, it will return `""` and kick off the transcoding process (which can be somewhat lengthy for long audio files).
124124

125-
In the array you pass in, the default values are used if the key/value pair does not exist:
125+
In the array you pass in, the default values are used if the key-value pair does not exist:
126126

127127
```
128128
{
@@ -137,7 +137,7 @@ In the array you pass in, the default values are used if the key/value pair does
137137

138138
These default values come from the `config.php` file.
139139

140-
If you want to have the Transcoder not change a parameter, pass in an empty value in the key/value pair, e.g.:
140+
To have the Transcoder not change a parameter, pass in an empty value in the key-value pair, for example:
141141

142142
```twig
143143
{% set transVideoUrl = craft.transcoder.getVideoUrl('/home/vagrant/sites/nystudio107/public/trimurti.mp4', {
@@ -149,7 +149,7 @@ If you want to have the Transcoder not change a parameter, pass in an empty valu
149149

150150
The above example would cause it to not change the audio of the source audio file at all (not recommended for client-proofing purposes).
151151

152-
The file format setting `audioEncoder` is preset to what you'll need to generate `mp3` audio files, but it can also generate `aac`, `ogg`, or any other format that `ffmpeg` supports. See the `config.php` file for details
152+
The file format setting `audioEncoder` is preset to what youll need to generate `mp3` audio files, but it can also generate `aac`, `ogg`, or any other format that `ffmpeg` supports. See the `config.php` file for details
153153

154154
## Getting Transcoding Progress
155155

@@ -219,9 +219,9 @@ You can also pass in an `Asset`:
219219
}) %}
220220
```
221221

222-
It will return to you a URL to the thumbnail of the video, in the size you specify, from the timecode `timeInSecs` in the video. It creates this thumbnail immediately if it doesn't already exist.
222+
It will return to you a URL to the thumbnail of the video, in the size you specify, from the timecode `timeInSecs` in the video. It creates this thumbnail immediately if it doesnt already exist.
223223

224-
In the array you pass in, the default values are used if the key/value pair does not exist:
224+
In the array you pass in, the default values are used if the key-value pair does not exist:
225225

226226
```
227227
{
@@ -233,7 +233,7 @@ In the array you pass in, the default values are used if the key/value pair does
233233
}
234234
```
235235

236-
If you want to have the Transcoder not change a parameter, pass in an empty value in the key/value pair, e.g.:
236+
To have the Transcoder not change a parameter, pass in an empty value in the key-value pair, for example:
237237

238238
```twig
239239
{% set transVideoThumbUrl = craft.transcoder.getVideoThumbnailUrl('/home/vagrant/sites/nystudio107/public/oceans.mp4', {
@@ -259,7 +259,7 @@ The `aspectRatio` parameter lets you control how the video aspect ratio is maint
259259

260260
![Screenshot](./resources/screenshots/oceans_20s_300w_200h_letterbox.jpg)
261261

262-
You can control the color of the letterboxed area (it's `black` by default) via the `letterboxColor` option. It can be either a semantic color name, or a hexcode color, e.g.: `0xC0C0C0`
262+
You can control the color of the letterboxed area (its `black` by default) via the `letterboxColor` option. It can be either a semantic color name, or a hexcode color, for example: `0xC0C0C0`
263263

264264
The `sharpen` option determines whether an unsharp mask filter should be applied to the scaled thumbnail image.
265265

@@ -308,7 +308,7 @@ If you instead pass in `false` as the second parameter (or omit it), then `craft
308308
* `format` - information about the container file format
309309
* `streams` - information about each stream in the container; many videos have multiple streams, for instance, one for the video streams, and another for the audio stream. There can even be multiple video or audio streams in a container.
310310

311-
Here's example output from `craft.transcoder.getFileInfo()`:
311+
Heres example output from `craft.transcoder.getFileInfo()`:
312312

313313
```
314314
[
@@ -437,7 +437,7 @@ To generate a download URL for a file, do the following:
437437
{% set downloadUrl = craft.transcoder.getDownloadUrl('/some/url') %}
438438
```
439439

440-
When the user clicks on the URL, it will download the file to their local computer. If the file doesn't exist, `""` is returned.
440+
When the user clicks on the URL, it will download the file to their local computer. If the file doesnt exist, `""` is returned.
441441

442442
The file must reside in the webroot (thus a URL or URI must be passed in as a parameter, not a path), for security reasons.
443443

0 commit comments

Comments
 (0)