1
|
/*~ install.txt
|
2
|
.---------------------------------------------------------------------------.
|
3
|
| Software: QuickSkin |
|
4
|
| Version: 5.0 |
|
5
|
| Contact: andy.prevost@worxteam.com |
|
6
|
| Info: http://sourceforge.net/projects/quickskin |
|
7
|
| Support: http://sourceforge.net/projects/quickskin |
|
8
|
| ------------------------------------------------------------------------- |
|
9
|
| Author: Andy Prevost andy.prevost@worxteam.com (admin) |
|
10
|
| Author: Manuel 'EndelWar' Dalla Lana endelwar@aregar.it (former admin) |
|
11
|
| Author: Philipp v. Criegern philipp@criegern.com (original founder) |
|
12
|
| Copyright (c) 2002-2009, Andy Prevost. All Rights Reserved. |
|
13
|
| * NOTE: QuickSkin is the SmartTemplate project renamed. SmartTemplate |
|
14
|
| information and downloads can still be accessed at the |
|
15
|
| smarttemplate.sourceforge.net site |
|
16
|
| ------------------------------------------------------------------------- |
|
17
|
| License: Distributed under the Lesser General Public License (LGPL) |
|
18
|
| http://www.gnu.org/copyleft/lesser.html |
|
19
|
| This program is distributed in the hope that it will be useful - WITHOUT |
|
20
|
| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
21
|
| FITNESS FOR A PARTICULAR PURPOSE. |
|
22
|
| ------------------------------------------------------------------------- |
|
23
|
| We offer a number of paid services: |
|
24
|
| - Web Hosting on highly optimized fast and secure servers |
|
25
|
| - Technology Consulting |
|
26
|
| - Oursourcing (highly qualified programmers and graphic designers) |
|
27
|
'---------------------------------------------------------------------------'
|
28
|
Last modified: January 01 2009 ~*/
|
29
|
|
30
|
To install and use QuickSkin:
|
31
|
|
32
|
1. Uncompress the ZIP file to your local computer
|
33
|
|
34
|
-- FULL INSTALLATION
|
35
|
|
36
|
Copy the files to your webserver. We recommend that you put those in a
|
37
|
directory structure that resembles:
|
38
|
|
39
|
/_lib/class.quickskin.php
|
40
|
/_lib/class.quickskindebugger.php
|
41
|
/_lib/qx/{all files that start with qx_}
|
42
|
|
43
|
-- MINIMAL INSTALLATION
|
44
|
|
45
|
If you want to install the absolutely bare-bones installation, copy only
|
46
|
the base class file to your webserver. We recommend that you put that file in
|
47
|
the following directory structure:
|
48
|
|
49
|
/_lib/class.quickskin.php
|
50
|
|
51
|
2. Create a directory for your compiled/cached files. We recommend:
|
52
|
|
53
|
/_skins_tmp/
|
54
|
|
55
|
3. If you are using QuickSkin as part of a framework or plan to reuse your
|
56
|
code often, we recommend that you create a template structure such as:
|
57
|
|
58
|
/_skins/
|
59
|
/_skins/default/ (to store your template HTML files)
|
60
|
/_skins/default/tplimgs/ (to store your template images and CSS files)
|
61
|
/_skins/default/tpljs/ (to store your template Javascript files)
|
62
|
/_skins_tmp/ (to store all compiled and cached files)
|
63
|
|
64
|
With this kind of structure, you are able to create/edit your HTML
|
65
|
files with any HTML editor (MS FrontPage, MS Expression Web, Macromedia
|
66
|
Dreamweaver, etc.). All of your references to locations of Javascript
|
67
|
files, images, and CSS files will reference the directory under the
|
68
|
HTML template file (ie. <img src="tplimgs/yourimage.jpg>). This
|
69
|
is simple and convenient for both you and your users. Continue reading
|
70
|
for examples on how to take advantage of this directory structure.
|
71
|
|
72
|
4. All you need to use QuickSkin, is to instantiate it inside of your
|
73
|
script. If you used the directory structure we recommended, that looks like:
|
74
|
|
75
|
include_once('/_lib/class.quickskin.php');
|
76
|
|
77
|
$page = new QuickSkin( "default/yourtemplate.htm" );
|
78
|
|
79
|
$page->assign( 'title', 'TemplateDemo' );
|
80
|
$page->assign( 'welcome', 'My Welcome' );
|
81
|
|
82
|
$page->assign('welcome', 'My Welcome');
|
83
|
|
84
|
$page->set('template_dir', '_skins/');
|
85
|
$page->set('temp_dir', '_skins_tmp/');
|
86
|
$page->set('cache_dir', '_skins_tmp/');
|
87
|
|
88
|
// do substitute of template image directory
|
89
|
$page->assign('tpl_img', 'tplimgs/');
|
90
|
$page->assign('url_img', 'http://www.yourdomain.com/_skins/default/tplimgs/');
|
91
|
|
92
|
// do substitute of template javascript directory
|
93
|
$page->assign('tpl_js', 'tpljs/');
|
94
|
$page->assign('url_js', 'http://www.yourdomain.com/_skins/default/tpljs/');
|
95
|
|
96
|
$page->addtpl('sponsors', '_skins/default/sponsors.htm');
|
97
|
|
98
|
//$page->debug();
|
99
|
|
100
|
$page->output();
|
101
|
|
102
|
Experiment. It is pretty simple to work the system and the scripts are
|
103
|
well documented.
|
104
|
|
105
|
If you are a previous user of SmartTemplate, the new version is completely code
|
106
|
compatible with version 1.2.1 - with ONE EXCEPTION. The default for 'reuse_code'
|
107
|
is now FALSE. There's quite a few enhancements that you will want to explore.
|
108
|
|
109
|
Andy Prevost.
|