Projet

Général

Profil

Révision b433176d

Ajouté par Assos Assos il y a environ 4 ans

Weekly update of contrib modules

Voir les différences:

drupal7/sites/all/modules/colorbox/README.txt
1
Drupal colorbox module:
2
------------------------
3
Maintainers:
4
  Fredrik Jonsson (http://drupal.org/user/5546)
5
Requires - Drupal 7
6
License - GPL (see LICENSE)
7

  
1
CONTENTS OF THIS FILE
2
---------------------
3
   
4
 * Introduction
5
 * Features
6
 * Requirements
7
 * Installation
8
 * Configuration
9
 * Use the Views Colorbox Trigger field
10
 * Add a custom Colorbox style to your theme
11
 * Load images from custom links in a Colorbox
12
 * Load content in a Colorbox
13
 * Load inline content in a Colorbox
14
 * Drush
15
 * Image in Colorbox not displayed in Internet Explorer 8
16
 * Maintainers
17

  
18

  
19
INTRODUCTION
20
------------
8 21

  
9
Overview:
10
--------
11 22
Colorbox is a light-weight, customizable lightbox plugin for jQuery 1.4.3+.
12 23
This module allows for integration of Colorbox into Drupal.
13 24
The jQuery library is a part of Drupal since version 5+.
......
19 30
* Colorbox - http://www.jacklmoore.com/colorbox/
20 31

  
21 32

  
22
Features:
33
FEATURES:
23 34
---------
24 35

  
25
The Colorbox module:
36
The Colorbox:
26 37

  
27 38
* Excellent integration with Image field and Image styles
28 39
* Choose between a default style and 5 example styles that are included.
......
42 53
* Released under the MIT License.
43 54

  
44 55

  
45
Installation:
56
REQUIREMENTS
57
------------
58

  
59
This module requires the following modules:
60

  
61
 * Libraries API (https://www.drupal.org/project/libraries)
62

  
63

  
64
INSTALLATION
46 65
------------
47
1. Download and unpack the Libraries module directory in your modules folder
48
   (this will usually be "sites/all/modules/").
49
   Link: http://drupal.org/project/libraries
50
2. Download and unpack the Colorbox module directory in your modules folder
51
   (this will usually be "sites/all/modules/").
52
3. Download and unpack the Colorbox plugin in "sites/all/libraries".
66

  
67
 1. Download and unpack the Libraries module directory in your modules folder
68
    (this will usually be "sites/all/modules/").
69
    Link: http://drupal.org/project/libraries
70

  
71
 2. Download and unpack the Colorbox module directory in your modules folder
72
    (this will usually be "sites/all/modules/").
73

  
74
 3. Download and unpack the Colorbox plugin in "sites/all/libraries".
53 75
    Make sure the path to the plugin file becomes:
54 76
    "sites/all/libraries/colorbox/jquery.colorbox-min.js"
55
   Link: https://github.com/jackmoore/colorbox/archive/1.x.zip
56
   Drush users can use the command "drush colorbox-plugin".
57
4. Go to "Administer" -> "Modules" and enable the Colorbox module.
77
    Link: https://github.com/jackmoore/colorbox/archive/1.x.zip
78
    Drush users can use the command "drush colorbox-plugin".
79

  
80
 4. Go to "Administer" -> "Modules" and enable the Colorbox.
81

  
82
    Install as you would normally install a contributed Drupal module. See:
83
    https://drupal.org/documentation/install/modules-themes/modules-7 for
84
    further information.
58 85

  
86
    Note:
87
    If you download the Colorbox plugin using the makefile included you should 
88
    assurance that unzip command is available on your host.
59 89

  
60
Configuration:
90

  
91
CONFIGURATION
61 92
-------------
62
Go to "Configuration" -> "Media" -> "Colorbox" to find
63
all the configuration options.
93

  
94
 * Go to "Configuration" » "Media" » "Colorbox" to find all the configuration
95
   options.
64 96

  
65 97

  
66
Use the Views Colorbox Trigger field:
98
USE THE VIEWS COLORBOX TRIGGER FIELD
67 99
------------------------------------
68 100
TODO
69 101

  
70 102

  
71
Add a custom Colorbox style to your theme:
103
ADD A CUSTOM COLORBOX STYLE TO YOUR THEME
72 104
----------------------------------------
73 105
The easiest way is to start with either the default style or one of the
74
example styles included in the Colorbox JS library download. Simply copy the entire
75
style folder to your theme and rename it to something logical like "mycolorbox".
76
Inside that folder are both a .css and .js file, rename both of those as well to match
77
your folder name: i.e. "colorbox_mycolorbox.css" and "colorbox_mycolorbox.js"
106
example styles included in the Colorbox JS library download. Simply copy the
107
entire style folder to your theme and rename it to something logical like
108
"mycolorbox". Inside that folder are both a .css and .js file, rename both of
109
those as well to  match your folder name: i.e. "colorbox_mycolorbox.css" and
110
"colorbox_mycolorbox.js"
78 111

  
79 112
Add entries in your theme's .info file for the Colorbox CSS/JS files:
80 113

  
......
86 119
Make any CSS adjustments to your "colorbox_mycolorbox.css" file.
87 120

  
88 121

  
89
Load images from custom links in a Colorbox:
122
LOAD IMAGES FROM CUSTOM LINKS IN A COLORBOX
90 123
--------------------------------------------
91 124

  
92 125
Add the class "colorbox" to the link and point its href attribute to the image
93 126
you want to display in the Colorbox.
94 127

  
95 128

  
96
Load content in a Colorbox:
129
LOAD CONTENT IN A COLORBOX
97 130
---------------------------
98 131
Check the "Enable Colorbox load" option in Colorbox settings.
99 132

  
......
105 138
Other modules may activate this for easy Colorbox integration.
106 139

  
107 140

  
108
Load inline content in a Colorbox:
141
LOAD INLINE CONTENT IN A COLORBOX
109 142
----------------------------------
110 143
Check the "Enable Colorbox inline"  option in Colorbox settings.
111 144

  
......
118 151

  
119 152
It could e.g. look like this.
120 153

  
121
<a class="colorbox-inline" href="?width=500&height=500&inline=true#id-of-content">Link to click</a>
154
<a class="colorbox-inline" href="?width=500&height=500&inline=true#id-of-content">
155
  Link to click
156
</a>
122 157

  
123 158
<div style="display: none;">
124
<div id="id-of-content">What ever content you want to display in a Colorbox.</div>
159
  <div id="id-of-content">
160
    What ever content you want to display in a Colorbox.
161
  </div>
125 162
</div>
126 163

  
127 164
Other modules may activate this for easy Colorbox integration.
128 165

  
129 166

  
130
Drush:
167
DRUSH
131 168
------
132 169
A Drush command is provides for easy installation of the Colorbox
133 170
plugin itself.
......
139 176
recommended unless you know what you are doing.
140 177

  
141 178

  
142
Image in Colorbox not displayed in Internet Explorer 8:
179
IMAGE IN COLORBOX NOT DISPLAYED IN INTERNET EXPLORER 8
143 180
-------------------------------------------------------
144 181

  
145 182
If your theme has CSS like this (popular in responsive design):
......
155 192
  max-width: none;
156 193
}
157 194

  
195

  
196
MAINTAINERS
197
-----------
198

  
199
Current maintainers:
200
 * Fredrik Jonsson (frjo) - https://www.drupal.org/user/5546
201
 * Joe Wheaton (jdwfly) - https://www.drupal.org/user/298179
202
 * Renato Gonçalves (RenatoG) - https://www.drupal.org/user/3326031
203
 * Sam Becker (Sam152) - https://www.drupal.org/user/1485048
204
 * rsmylski - https://www.drupal.org/user/1324348
205
 * lsolesen - https://www.drupal.org/user/527206

Formats disponibles : Unified diff