Issue #2232459: Added space and HTML tag opening to characters to break on when parsi...
[project/youtube.git] / README.txt
1 SUMMARY - YouTube Field
2 ========================
3 The YouTube field module provides a simple field that allows you to add a
4 YouTube video to a content type, user, or any entity.
5
6 Display types include:
7
8  * YouTube videos of various sizes and options.
9  * YouTube thumbnails with image styles.
10
11
12 REQUIREMENTS
13 -------------
14 All dependencies of this module are enabled by default in Drupal 7.x.
15
16
17 INSTALLATION
18 -------------
19 Install this module as usual. Please see
20 http://drupal.org/documentation/install/modules-themes/modules-7
21
22
23 USAGE
24 -------
25 To use this module create a new field of type 'YouTube video'. This field will
26 accept YouTube URLs of the following formats:
27
28  * http://youtube.com/watch?v=[video_id]
29  * http://youtu.be/[video_id]
30  * http://youtube.com/v/[video_id]
31  * http://youtube.com/embed/[video_id]
32  * http://youtube.com/?v=[video_id]
33
34 All formats listed above can also be provided without 'http://', with 'www.',
35 or with 'https://' rather than 'http://'. The last format can be provided with
36 additional parameters (ignored) and v does not have to be the first parameter.
37
38
39 CONFIGURATION
40 --------------
41 Global module settings can be found at admin/config/media/youtube.
42
43 The video output of a YouTube field can be manipulated in three ways:
44  * global parameters found on the configuration page mentioned above
45  * field-specific parameters found in that particular field's display settings
46  * Views settings for the specific field
47
48 The thumbnail of the YouTube image can also be used and can link to either the
49 content, the video on YouTube, or nothing at all.
50
51 To configure the field settings:
52
53  1. click 'manage display' on the listing of entity types
54  2. click the configuration gear to the right of the YouTube field
55
56
57 SUPPORT
58 --------
59 Please use the issue queue to report bugs or request support:
60 http://drupal.org/project/issues/youtube