-
Notifications
You must be signed in to change notification settings - Fork 5
/
readme.html
241 lines (232 loc) · 23.3 KB
/
readme.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<!doctype html>
<!-- saved from url=(0016)http://localhost -->
<html lang='en'>
<head>
<meta charset='utf-8'>
<title>Zen Colorbox 1.0 Read Me</title>
<meta content='width=device-width, initial-scale=1.0' name='viewport' />
<meta content='' name='description' />
<meta content='' name='author' />
<!-- Le styles -->
<link href='2_support_files/assets/css/bootstrap.min.css' rel='stylesheet' />
<link href='2_support_files/assets/css/zen_colorbox_support.css' rel='stylesheet' />
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<script src='http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js'></script>
<script src='2_support_files/assets/js/zen_colorbox_support.js'></script>
</meta>
</head>
<body>
<div class='container-fluid'>
<div class='row-fluid' id='header'>
<div class='span3' id='branding'>
<h3>Zen Colorbox 1.0</h3>
</div>
</div>
<div class='row-fluid' id='main-menu'>
<div class='subnav span12'>
<ul class='nav nav-tabs'>
<li>
<a href='#install'>Install</a>
</li>
<li>
<a href='#settings'>Settings</a>
</li>
<li>
<a href='#uninstall'>Uninstall</a>
</li>
<li>
<a href='http://www.zen-cart.com/showthread.php?196446-Zen-Colorbox' target='_blank'>Support</a>
</li>
<li>
<a href='#credits'>Credits</a>
</li>
</ul>
</div>
</div>
<div class='row-fluid' id='install'>
<h3 class='heading'>
Installation
<span class='one-point-five'>- 1.5</span>
<span class='one-point-three'>- 1.3.9</span>
</h3>
<div class='alert alert-danger backup-warning'>
<h3>BACKUP</h3>
<p>Be sure to make a backup of your <strong>database</strong> and you <strong>site files</strong> before you continue! <br> The <strong>BEST</strong> recommendation is to do this on a development version of your site. If you are serious about running your store it is always worth having a second version of the store so that you can experiment on that first. I know that this seems like a lot of work but it really is worth it and does not actually take that much time. <br>
<a class='btn btn-xs btn-danger' href='http://www.zen-cart.com/content.php?144-how-can-i-do-a-database-backup-with-phpmyadmin' target='_blank'>How?</a>
<button class='btn btn-xs btn-danger btn-dismiss-warning'>Dismiss</button>
</div>
<div class="alert alert-danger backup-warning">
<h3>BEFORE YOU INSTALL READ THIS!!!</h3>
<p>Some files that Zen-Colorbox modifies are core files. This means that Zen-Colorbox overwrites the existing files that Zen Cart uses. If your site has no modifications to these files then there are no problems. If your installation has existing modifications to you files then you will have to carefully merge the existing modifications with the modifications that Zen-Colorbox makes.</p>
<h2>Best Practice</h2>
<div class="boldemphasis">This is the way to go if you know that you have merges to do.</div>
<p>Read the installation instructions and see which Zen-Colorbox files are equivilant to which Zen Cart files. It is not a <strong>complex pattern!</strong> Then merge your modifications into the appropriate file in the Zen-Colorbox installation files.</p>
<p>For instance if you have existing modifications in<br>
YOUR_TEMPLATE/templates/tpl_modules_main_product_image.php<br><br>
merge them with the installation file<br>
Then install as normal.</p>
<a class='btn btn-xs btn-danger' href='http://www.zen-cart.com/content.php?228-understanding-the-override-system' target='_blank'>How?</a>
<button class='btn btn-xs btn-danger btn-dismiss-warning'>Dismiss</button>
</div>
<div class='row-fluid choose-version'>
To view the instructions, please choose your version of ZenCart by clicking the appropriate button:<br>
<button class='btn btn-sm btn-primary btn-one-point-five'><strong>Zen Cart 1.5</strong></button>
<button class='btn btn-sm btn-primary btn-one-point-three'><strong>Zen Cart 1.3.9</strong></button>
</div>
<ol class='install-steps'>
<li>
Rename the following folders to match <em>your</em> template folder.
<ul>
<li>1_Installer_Files/includes/modules/<strong class = "folder-name">YOUR_TEMPLATE</strong></li>
<li>1_Installer_Files/includes/templates/<strong class = "folder-name">YOUR_TEMPLATE</strong></li>
</ul>
</li>
<li class='one-point-five'>
Rename the following folder to match <em>your</em> admin folder.
<ul>
<li>1_Installer_Files/<strong class='folder-name'>YOUR_ADMIN</strong></li>
</ul>
</li>
<li class='one-point-three'>
<div class="alert alert-info">
You can safely ignore or delete the following folder (it is only used for Zen Cart 1.5)
<ul>
<li>1_Installer_Files/<strong class='folder-name'>YOUR_ADMIN</strong></li>
</ul>
</div>
</li>
<li>Using your FTP program; upload the <strong>includes</strong> <span class="one-point-five hide">and the (renamed) <strong>admin</strong></span> folder to your server (Note: All files make use of the overrides system, and should <strong>merge</strong> with your current files <strong>not</strong> replace.)</li>
<li class='one-point-three'>
<!-- TODO hilight this box for more attention -->
<a class='btn btn-xs btn-success' id='copy-install-sql-one-point-three'>Press this button</a>
to select the install sql.
</li>
<li class='one-point-five'>
<a class='btn btn-xs btn-success' id='copy-install-sql-one-point-five'>Press this button</a>
to select the install sql.
</li>
<textarea class='one-point-three' id='install-sql-one-point-three' readonly='readonly'>INSERT INTO `configuration_group` VALUES (NULL, 'Zen Colorbox', 'Configure Zen Colorbox settings', '0', '1');
UPDATE `configuration_group` SET `sort_order` = LAST_INSERT_ID() WHERE `configuration_group_id` = LAST_INSERT_ID();
SELECT @cgi := `configuration_group_id` FROM `configuration_group` WHERE `configuration_group_title` = 'Zen Colorbox';
INSERT INTO `configuration` (`configuration_id`, `configuration_title`, `configuration_key`, `configuration_value`, `configuration_description`, `configuration_group_id`, `sort_order`, `last_modified`, `date_added`, `use_function`, `set_function`) VALUES
(NULL, '<strong>Zen Colorbox</strong>', 'ZEN_COLORBOX_STATUS', 'true', '<br />If true, all product images on the following pages will be displayed within a lightbox:<br /><br />- document_general_info<br />- document_product_info<br />- page (EZ-Pages)<br />- product_free_shipping_info<br />- product_info<br />- product_music_info<br />- product_reviews<br />- product_reviews_info<br />- product_reviews_write<br /><br /><strong>Default: true</strong>', @cgi, 100, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, 'Overlay Opacity', 'ZEN_COLORBOX_OVERLAY_OPACITY', '0.6', '<br />Controls the transparency of the overlay.<br /><br /><strong>Default: 0.6</strong>', @cgi, 101, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''0'', ''0.1'', ''0.2'', ''0.3'', ''0.4'', ''0.5'', ''0.6'', ''0.7'', ''0.8'', ''0.9'', ''1''), '),
(NULL, 'Resize Duration', 'ZEN_COLORBOX_RESIZE_DURATION', '400', '<br />Controls the speed of the image resizing.<br /><br />Note: This value is measured in milliseconds.<br /><br /><strong>Default: 400</strong><br />', @cgi, 102, NOW(), NOW(), NULL, NULL),
(NULL, 'Initial Width', 'ZEN_COLORBOX_INITIAL_WIDTH', '250', '<br />If Enable Resize Animations is set to true, the lightbox will resize its width from this value to the current image width, when first displayed.<br /><br />Note: This value is measured in pixels.<br /><br /><strong>Default: 250</strong><br />', @cgi, 103, NOW(), NOW(), NULL, NULL),
(NULL, 'Initial Height', 'ZEN_COLORBOX_INITIAL_HEIGHT', '250', '<br />If Enable Resize Animations is set to true, the lightbox will resize its height from this value to the current image height, when first displayed.<br /><br />Note: This value is measured in pixels.<br /><br /><strong>Default: 250</strong><br />', @cgi, 104, NOW(), NOW(), NULL, NULL),
(NULL, 'Display Image Counter', 'ZEN_COLORBOX_COUNTER', 'true', '<br />If true, the image counter will be displayed (below the caption of each image) within the lightbox.<br /><br /><strong>Default: true</strong>', @cgi, 105, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''),'),
(NULL, 'Close on Overlay Click', 'ZEN_COLORBOX_CLOSE_OVERLAY', 'false', '<br />If true, the lightbox will close when the overlay is clicked.<br /><br /><strong>Default: false</strong>', @cgi, 106, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, 'Loop', 'ZEN_COLORBOX_LOOP', 'true', '<br />If true, Images will loop in both directions.<br /><br /><strong>Default: true</strong>', @cgi, 107, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, '<strong>Slideshow</strong>', 'ZEN_COLORBOX_SLIDESHOW', 'false', '<br />If true, Images will display as a slideshow.<br /><br /><strong>Default: false</strong>', @cgi, 200, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, ' Slideshow Auto Start', 'ZEN_COLORBOX_SLIDESHOW_AUTO', 'true', '<br />If true, your slideshow will auto start.<br /><br /><strong>Default: true</strong>', @cgi, 201, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, ' Slideshow Speed', 'ZEN_COLORBOX_SLIDESHOW_SPEED', '2500', '<br />Sets the speed of the slideshow <br /><br />Note: This value is measured in milliseconds.<br /><br /><strong>Default: 2500</strong>', @cgi, 202, NOW(), NOW(), NULL, NULL),
(NULL, ' Slideshow Start Text', 'ZEN_COLORBOX_SLIDESHOW_START_TEXT', 'start slideshow', '<br />Link text to start the slideshow.<br /><br /><strong>Default: start slideshow</strong>', @cgi, 203, NOW(), NOW(), NULL, NULL),
(NULL, ' Slideshow Stop Text', 'ZEN_COLORBOX_SLIDESHOW_STOP_TEXT', 'stop slideshow', '<br />Link text to stop the slideshow.<br /><br /><strong>Default: stop slideshow</strong>', @cgi, 204, NOW(), NOW(), NULL, NULL),
(NULL, '<strong>Gallery Mode</strong>', 'ZEN_COLORBOX_GALLERY_MODE', 'true', '<br />If true, the lightbox will allow additional images to quickly be displayed using previous and next buttons.<br /><br /><strong>Default: true</strong>', @cgi, 300, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''),'),
(NULL, ' Include Main Image in Gallery', 'ZEN_COLORBOX_GALLERY_MAIN_IMAGE', 'true', '<br />If true, the main product image will be included in the lightbox gallery.<br /><br /><strong>Default: true</strong>', @cgi, 301, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''),'),
(NULL, '<strong>EZ-Pages Support</strong>', 'ZEN_COLORBOX_EZPAGES', 'true', '<br />If true, the lightbox effect will be used for linked images on all EZ-Pages.<br /><br /><strong>Default: true</strong>', @cgi, 400, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''),'),
(NULL, ' File Types', 'ZEN_COLORBOX_FILE_TYPES', 'jpg,png,gif', '<br />On EZ-Pages, the lightbox effect will be applied to all images with one of the following file types.<br /><br /><strong>Default: jpg,png,gif</strong><br />', @cgi, 401, NOW(), NOW(), NULL, NULL);</textarea>
<textarea class='one-point-five' id='install-sql-one-point-five' readonly='readonly'>INSERT INTO `configuration_group` VALUES (NULL, 'Zen Colorbox', 'Configure Zen Colorbox settings', '0', '1');
UPDATE `configuration_group` SET `sort_order` = LAST_INSERT_ID() WHERE `configuration_group_id` = LAST_INSERT_ID();
SELECT @cgi := `configuration_group_id` FROM `configuration_group` WHERE `configuration_group_title` = 'Zen Colorbox';
INSERT INTO `configuration` (`configuration_id`, `configuration_title`, `configuration_key`, `configuration_value`, `configuration_description`, `configuration_group_id`, `sort_order`, `last_modified`, `date_added`, `use_function`, `set_function`) VALUES
(NULL, '<strong>Zen Colorbox</strong>', 'ZEN_COLORBOX_STATUS', 'true', '<br />If true, all product images on the following pages will be displayed within a lightbox:<br /><br />- document_general_info<br />- document_product_info<br />- page (EZ-Pages)<br />- product_free_shipping_info<br />- product_info<br />- product_music_info<br />- product_reviews<br />- product_reviews_info<br />- product_reviews_write<br /><br /><strong>Default: true</strong>', @cgi, 100, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, 'Overlay Opacity', 'ZEN_COLORBOX_OVERLAY_OPACITY', '0.6', '<br />Controls the transparency of the overlay.<br /><br /><strong>Default: 0.6</strong>', @cgi, 101, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''0'', ''0.1'', ''0.2'', ''0.3'', ''0.4'', ''0.5'', ''0.6'', ''0.7'', ''0.8'', ''0.9'', ''1''), '),
(NULL, 'Resize Duration', 'ZEN_COLORBOX_RESIZE_DURATION', '400', '<br />Controls the speed of the image resizing.<br /><br />Note: This value is measured in milliseconds.<br /><br /><strong>Default: 400</strong><br />', @cgi, 102, NOW(), NOW(), NULL, NULL),
(NULL, 'Initial Width', 'ZEN_COLORBOX_INITIAL_WIDTH', '250', '<br />If Enable Resize Animations is set to true, the lightbox will resize its width from this value to the current image width, when first displayed.<br /><br />Note: This value is measured in pixels.<br /><br /><strong>Default: 250</strong><br />', @cgi, 103, NOW(), NOW(), NULL, NULL),
(NULL, 'Initial Height', 'ZEN_COLORBOX_INITIAL_HEIGHT', '250', '<br />If Enable Resize Animations is set to true, the lightbox will resize its height from this value to the current image height, when first displayed.<br /><br />Note: This value is measured in pixels.<br /><br /><strong>Default: 250</strong><br />', @cgi, 104, NOW(), NOW(), NULL, NULL),
(NULL, 'Display Image Counter', 'ZEN_COLORBOX_COUNTER', 'true', '<br />If true, the image counter will be displayed (below the caption of each image) within the lightbox.<br /><br /><strong>Default: true</strong>', @cgi, 105, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''),'),
(NULL, 'Close on Overlay Click', 'ZEN_COLORBOX_CLOSE_OVERLAY', 'false', '<br />If true, the lightbox will close when the overlay is clicked.<br /><br /><strong>Default: false</strong>', @cgi, 106, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, 'Loop', 'ZEN_COLORBOX_LOOP', 'true', '<br />If true, Images will loop in both directions.<br /><br /><strong>Default: true</strong>', @cgi, 107, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, '<strong>Slideshow</strong>', 'ZEN_COLORBOX_SLIDESHOW', 'false', '<br />If true, Images will display as a slideshow.<br /><br /><strong>Default: false</strong>', @cgi, 200, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, ' Slideshow Auto Start', 'ZEN_COLORBOX_SLIDESHOW_AUTO', 'true', '<br />If true, your slideshow will auto start.<br /><br /><strong>Default: true</strong>', @cgi, 201, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''), '),
(NULL, ' Slideshow Speed', 'ZEN_COLORBOX_SLIDESHOW_SPEED', '2500', '<br />Sets the speed of the slideshow <br /><br />Note: This value is measured in milliseconds.<br /><br /><strong>Default: 2500</strong>', @cgi, 202, NOW(), NOW(), NULL, NULL),
(NULL, ' Slideshow Start Text', 'ZEN_COLORBOX_SLIDESHOW_START_TEXT', 'start slideshow', '<br />Link text to start the slideshow.<br /><br /><strong>Default: start slideshow</strong>', @cgi, 203, NOW(), NOW(), NULL, NULL),
(NULL, ' Slideshow Stop Text', 'ZEN_COLORBOX_SLIDESHOW_STOP_TEXT', 'stop slideshow', '<br />Link text to stop the slideshow.<br /><br /><strong>Default: stop slideshow</strong>', @cgi, 204, NOW(), NOW(), NULL, NULL),
(NULL, '<strong>Gallery Mode</strong>', 'ZEN_COLORBOX_GALLERY_MODE', 'true', '<br />If true, the lightbox will allow additional images to quickly be displayed using previous and next buttons.<br /><br /><strong>Default: true</strong>', @cgi, 300, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''),'),
(NULL, ' Include Main Image in Gallery', 'ZEN_COLORBOX_GALLERY_MAIN_IMAGE', 'true', '<br />If true, the main product image will be included in the lightbox gallery.<br /><br /><strong>Default: true</strong>', @cgi, 301, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''),'),
(NULL, '<strong>EZ-Pages Support</strong>', 'ZEN_COLORBOX_EZPAGES', 'true', '<br />If true, the lightbox effect will be used for linked images on all EZ-Pages.<br /><br /><strong>Default: true</strong>', @cgi, 400, NOW(), NOW(), NULL, 'zen_cfg_select_option(array(''true'', ''false''),'),
(NULL, ' File Types', 'ZEN_COLORBOX_FILE_TYPES', 'jpg,png,gif', '<br />On EZ-Pages, the lightbox effect will be applied to all images with one of the following file types.<br /><br /><strong>Default: jpg,png,gif</strong><br />', @cgi, 401, NOW(), NOW(), NULL, NULL);
INSERT INTO `admin_pages` (`page_key` ,`language_key` ,`main_page` ,`page_params` ,`menu_key` ,`display_on_menu` ,`sort_order`)VALUES
('configZenColorbox', 'BOX_CONFIGURATION_ZEN_COLORBOX', 'FILENAME_CONFIGURATION', CONCAT('gID=',@cgi), 'configuration', 'Y', @cgi);</textarea>
<li>
Copy the install sql to your clipboard Edit > Copy
</li>
<li>
Open a new browser window and navigate to your Store Admin > Tools > Install Sql Patches
</li>
<li>
Now paste the sql that you copied in step 5 into the sql area and press send.
</li>
<li>
Zen Colorbox should now be installed and ready to use. Navigate to your Store Admin > Configuration > Zen Colorbox to configure the settings
</li>
</ol>
</div>
<h3 class='heading' id='settings'>Settings</h3>
<p>
To adjust the settings for Zen Colorbox Navigate to your Store Admin > Configuration > Zen Colorbox
</p>
<div class='row-fluid' id='uninstall'>
<h3 class='heading'>
Uninstall
<span class='uninstall-one-point-five'>- 1.5</span>
<span class='uninstall-one-point-three'>- 1.3.9</span>
</h3>
<div class='row-fluid uninstall-choose-version'>
Choose your version:
<button class='btn btn-sm btn-primary btn-uninstall-one-point-five'><strong>Zen Cart 1.5</strong></button>
<button class='btn btn-sm btn-primary btn-uninstall-one-point-three'><strong>Zen Cart 1.3.9</strong></button>
</div>
<ol class='uninstall-steps'>
<li class='uninstall-one-point-five'>
<a class='btn btn-success btn-xs' id='copy-uninstall-sql-one-point-five'>Press this button</a>
to select the uninstall sql.
</li>
<li class='uninstall-one-point-three'>
<a class='btn btn-success btn-xs' id='copy-uninstall-sql-one-point-three'>Press this button</a>
to select the uninstall sql.
</li>
<textarea class='uninstall-one-point-five' id='uninstall-sql-one-point-five' readonly='readonly'>DELETE FROM `configuration` WHERE `configuration_key` LIKE 'ZEN_COLORBOX_%';
DELETE FROM `configuration_group` WHERE `configuration_group_title` = 'Zen Colorbox';
DELETE FROM `admin_pages` WHERE `language_key` = 'BOX_CONFIGURATION_ZEN_COLORBOX';</textarea>
<textarea class='uninstall-one-point-three' id='uninstall-sql-one-point-three' readonly='readonly'>DELETE FROM `configuration` WHERE `configuration_key` LIKE 'ZEN_COLORBOX_%';
DELETE FROM `configuration_group` WHERE `configuration_group_title` = 'Zen Colorbox';</textarea>
<li>
Copy the install sql to your clipboard Edit > Copy
</li>
<li>
Open a new browser window and navigate to your Store Admin > Tools > Install Sql Patches
</li>
<li>
Now paste the sql that you copied in step 2 into the sql area and press send.
</li>
<li>
Zen Colorbox should now be uninstalled from your admin area, but you will have to delete the files that were installed manually via your FTP program.
</li>
</ol>
</div>
<h3 class='heading' id='credits'>Credits</h3>
<p>
Zen Colorbox was created by
<a href='http://www.zen-cart.com/member.php?84336-niestudio'>niestudio</a>
. <br> Adapted from
<a href='http://www.jacklmoore.com/colorbox'>Colorbox</a>
created by Jack Moore.
<br> Additional credit goes to
<a href='http://www.zen-cart.com/member.php?23783-Alex-Clarke'>Alex Clarke</a> who created Zen Lightbox, from which Zen Colorbox was modeled.
<br>
<a href='http://www.zen-cart.com/member.php?34939-DivaVocals'>DivaVocals</a> For pre-release testing and updates.
</p>
</div>
<!--
Le javascript
==================================================
-->
<!-- Placed at the end of the document so the pages load faster -->
<script src='2_support_files/assets/js/bootstrap.js'></script>
</body>
</html>