Project

General

Profile

1
/*~ readme.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
For documentation, please see the 'DOCS' folder.
31

    
32
QuickSkin v5.0
33
http://sourceforge.net/projects/quickskin 
34

    
35
Copyright (c) 2002-2009, Andy Prevost. All Rights Reserved.
36

    
37
QuickSkin is a Template Engine that was designed to support web based 
38
applications of any size. It is particularly suited to large scale applications
39
like Content Management Systems. The project was originally started by 
40
Philipp v. Criegern and named "SmartTemplate". The project was then taken over
41
by Manuel 'EndelWar' Dalla Lana and HonestQiao. The name of the project back
42
then led to confusion with Smarty Templating. Despite its advantages over other
43
templating systems (speed, small footprint, ease of use, power), SmartTemplate
44
has not been updated and had many outstanding bugs. Codeworx Technologies has
45
been using SmartTemplate on a variety of projects for several years. Over that
46
time we have become very familiar with the code. We have now taken over the
47
project. Our first task was to rename the project to make it less confusing,
48
fix the bugs, and extend its capabilities -- while maintaining its core 
49
simplicity and ease of use.
50

    
51
What's so special about it?
52

    
53
Common template engines work like the following: Your PHP script specifies an 
54
HTML template and assigns some dynamic content to display. The template parser
55
replaces all placeholders within the template with the assigned content and
56
displays it to the user. This means a lot of string processing and regular
57
expression work each time you want to display some content.
58

    
59
QuickSkin works like a 'template compiler' that converts templates into executable
60
PHP code and stores it for later reuse. The first time a new template is processed,
61
all placeholders in the template are replaced by small PHP code elements that
62
print the assigned content. The HTML template fragment <H3>{TITLE}</H3>, for
63
example, is converted into something like <H3><?php echo $TITLE; ?></H3>. If you
64
have assigned your content to the right variables, there is no need for any
65
template parsing anymore. The only thing that has to be done is to include and
66
execute the compiled template. This usually increases the execution time of the
67
template engine dramatically.
68

    
69
QuickSkin supports:
70

    
71
- Simple Scalar Substitution (Strings, etc.)
72
- Block Iterations (nested Arrays / LOOP..ENDLOOP)
73
- Basic Control Structures (IF..ELSEIF..ELSE)
74
- Custom Extension (Output filters, uppercase, sprintf, etc.)
75
- Template Compilation (HTML templates are converted to executable PHP Code)
76
- Output Caching (Accelerates your applications by reusing page output) 
77
- Tested and works with PHP4 and PHP5 (5.2.4)
78

    
79
If you successfully deploy QuickSkin with your applications, please add text
80
link or link the QuickSkin button back to
81
http://sourceforge.net/projects/quickskin/.
82

    
83
Please let us know about your usage, so we can keep track of the sites using
84
QuickSkin.
85
     
86
Andy Prevost.
(6-6/6)