-
Notifications
You must be signed in to change notification settings - Fork 1
/
readMe.html
174 lines (173 loc) · 7.84 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Sanguine Easy Embed Templating System For Zen Cart</title>
<style>
.chapterTitle{
font-weight:bold;
border-bottom: solid 1px;
border-top: solid 1px;
margin-top:1em;
}
ol {
list-style-type: upper-roman;
}
ol li{
text-transform:uppercase;
}
ol ol {
list-style-type:decimal;
}
ol ol li, ol ul li {
text-transform: none;
}
</style>
</head>
<body>
<pre>
//+--------------------------------------------------------+
//| Sanguine Easy Embed Template - Zen Cart |
//|Support Site: |
//|http://code.google.com/p/sanguineasyembedtemplatesystem |
//|Released under the GPL v2 |
//|(c)Sanguis Developmet 2008 |
//|PLease consider donating to: |
//|[email protected] |
//|via Pay Pal |
//+--------------------------------------------------------+
#$Id$
</pre>
<p>
The Sanguine Easy embed template for Zen Cart. If this
program makes you money please consider donating to
[email protected], via Pay Pal in order to offset
the time loss that happens in the maintaining and supporting
of this program.
</p>
<p>
JOsh Beaureagard (sanguisdesign, on the Zen Cart
forum.)<br />
sanguisdevelopment.com
</p>
<h2>
CONTENTS
</h2>
<ol>
<li>
Install requirements
</li>
<li>
Install Instructions (as provided by urbanx, and modified
over time)
</li>
<li>
Map to version 2.
</li>
<li>
Change Log
</li>
<li>
Module Support
</li>
</ol>
<ol>
<li class="chapterTitle" id="req">INSTALL REQUIREMENTS</li>
<ul>
<li>A Zen Cart 1.3.x install</li>
<li>A a working mark up file (html layout) that you would like to embed your Zen cart into.</li>
<li>Basic php and html syntax knowledge.</li>
<li>A willingness to worth through any issues and learn.</li>
</ul>
<li class="chapterTitle" id="instructions">INSTALL INSTRUCTIONS</li>
(Originally Provided by Urbanx <a href="http://www.zen-cart.com/forum/showpost.php?p=456075&postcount=83">here</a>.
<ol>
<li>Create an html file in your web site that you would like to embed Zen cart into. Let's call it shop.html and let's put it in the root of our web site: - we can access this file from http://www.foo.com/shop.html - the file is found on the server at /path_to_your_files/shop.html</li>
<li>Some Where in your html file, you need to put three very specific lines of text. WHERE you put them is up to you, but they must be together and they must be exact. The thing to know is that it goes in the body of the file, and that it goes where you want your Zen Cart to go.
<br />
<code>
<!-- START EMBED --><br />
<!-- END EMBED -->
</code>
</li>
<li><p>Install Zen Cart. I'm going to assume that you installed Zen Cart in a directory called Zen. Go to http://www.foo.com/Zen and do all the Zen installation stuff.</p>
<p><strong>DO NOT GO ANY FURTHER UNTIL YOU HAVE ZEN WORKING PROPERLY WITH THE DEFAULT TEMPLATE.</strong></p>
</li>
<li>Once you have Zen Cart up and running, it is time to install the new template. The sang_embed template installs like any other template. Please see the wiki if you need basic assistance with installing a template in Zen Cart. Essentially, you copy the template files to your web server. Most will go in Zen/includes/templates/sang_embed, but the main thing is to match the folder structure in the download. Don't forget to "turn on" the sang_embed template in the admin.</li>
<li>Make ONE change in the file named easy_embed/config.php. You
can find it at
/path_to_your_files/Zen/includes/templates/sang_embed/sang_embed/config.php
find the line that begins with "$this->templateFile" (it is
line 15) and change it so that it refers to the html file you
created in step 1. In our example, it would be:
$this->templateFile = '/path_to_your_files/shop.html'; Other
examples can be: //if your mark up file is located in the same
folder as this file. $this->templateFile = DIR_FS_CATALOG .
DIR_WS_TEMPLATES. 'sang_embed/common/' . 'FILENAME'; //if your
mark up file is located in the Zen Cart root.
$this->templateFile = DIR_FS_CATALOG . 'FILENAME'; //other
wise fill this in $this->templateFile =
'YOUR_MARKUP_FILE_WITH_THE_FULL_PATH'; THIS IS THE KEY. IT
TELLS ZEN CART THAT IT MUST EMBED ITSELF IN THAT FILE. </li>
<li>(optional) in the config file there are options on lines 21-28
the top 4 are true or false and have been set already for Zen
cart and SHOULD NOT BE CHANGED. How ever if you want to add a
modifier to your links and images so that they point to the
correct files add a value there. An example would be if your
template was based on files that existed in the html root dir
you links would point to "/PAGE.html", and your Zen Cart is
installed in /Zen then you would want to rewrite you links to
be "../" so that they pointed to a parent directory. </li>
<li>Go test it by going to http://www.foo.com/Zen 8. Revel in your brilliance.</li>
</ol>
<li class="chapterTitle" id="map">Road Map to version 3</li>.
<ul>
<li>Possible web
interface in admin section. Liquid layout Embed Side boxes any
where.</li>
<li>Add ezpages menu</li>
</ul>
<li class="chapterTitle" id="change">Change log:</li>
(newest first)
<ul>
<h3>2.0</h3>
<li>Totally rewrote the magic.php file so that its is now a php class/object.</li>
<li>Added options for the config.</li>
<li>Revised readme.txt file.</li>
<li> Moved Files from templates/sang_embed/common to templates/sang_embed/sang_embed/congig.php and magic.php.</li>
<li>Updated Zen cart template files to reflect new class fuctions.</li>
<h3>1.2</h3>
<li>Updated readme.txt file to include install requirements, and support locations.</li>
<li>Split divided the config file in to two files. To separate the configuration form the process.
<dl>
<dt>embed_config.php</dt>
<dd>For configuration declaration.</dd>
<dt>embed_magic.php</dt>
<dd>For the processing of the script.</dd>
</dl>
</li>
<li>Added examples to the embed_config.</li>
<li>html_header.php Now gets the embed_magic.php instead of the config.</li>
<li>Merged language and template files with ZC 1.3.8a release.</li>
<h3>1.11</h3>
<li>Updated readmetxt file to include urbanix's install instructions.</li>
<h3>1.1 </h3>
<li>tpl_footer.php and tpl_html_header.php removed body includes moved to tpl_main_page.php </li>
<li>Added language files and folders that I find I am always having to change, and make copies of.</li>
<li>Added a tpl_products_info.page that works more with/ the provided style sheet.</li>
<li>In html_header.php; on line 18 replaced:
<br />
<code>require_once 'embed_config.php';</code>
<br />with:
<br />
<code>require_once($template->get_template_dir('embed_config.php',DIR_WS_TEMPLATE, $current_page_base,'common'). '/embed_config.php');</code>
<br />
to make it more over rides complaint.
</li>
</ul>
<li class="chapterTitle" id="support">Additional Support:</li>
<p>Community support can be obtained at <a href="http://www.zen-cart.com/forum/showpost.php?p=396372">http://www.zen-cart.com/forum/showpost.php?p=396372</a>.</p>
<p>Commercial support can be obtained at <a href="http://www.sanguisdevelopment.com">http://www.sanguisdevelopment.com</a></p>
</ol>
</body>
</html>