]> CyberLeo.Net >> Repos - Github/sugarcrm.git/blob - include/Smarty/README
Release 6.5.0
[Github/sugarcrm.git] / include / Smarty / README
1 NAME:
2
3     Smarty - the PHP compiling template engine
4
5 VERSION: 2.6.0
6
7 AUTHORS:
8     
9     Monte Ohrt <monte at ohrt dot com>
10     Andrei Zmievski <andrei@php.net>
11
12 MAILING LISTS:
13
14     We have a few mailing lists. "general" for you to share your ideas or ask
15         questions, "dev" for those interested in the development efforts of Smarty,
16         and "cvs" for those that would like to track the updates made in the cvs
17         repository.
18
19     send a blank e-mail message to:
20       smarty-general-subscribe@lists.php.net (subscribe to the general list)
21       smarty-general-unsubscribe@lists.php.net (unsubscribe from the general list)
22       smarty-general-digest-subscribe@lists.php.net (subscribe to digest)
23       smarty-general-digest-unsubscribe@lists.php.net (unsubscribe from digest)
24       smarty-dev-subscribe@lists.php.net (subscribe to the dev list)
25       smarty-dev-unsubscribe@lists.php.net (unsubscribe from the dev list)
26       smarty-cvs-subscribe@lists.php.net (subscribe to the cvs list)
27       smarty-cvs-unsubscribe@lists.php.net (unsubscribe from the cvs list)
28     You can also browse the mailing list archives at
29     http://marc.theaimsgroup.com/?l=smarty&r=1&w=2
30
31 SYNOPSIS:
32
33     require("Smarty.class.php");
34
35     $smarty = new Smarty;
36
37     $smarty->assign("Title","My Homepage");
38     $smarty->assign("Names",array("John","Gary","Gregg","James"));
39
40     $smarty->display("index.tpl");
41
42
43 DESCRIPTION:
44
45     What is Smarty?
46
47     Smarty is a template engine for PHP. Many other template engines for PHP
48     provide basic variable substitution and dynamic block functionality.
49     Smarty takes a step further to be a "smart" template engine, adding
50     features such as configuration files, template functions, and variable
51     modifiers, and making all of this functionality as easy as possible to
52     use for both programmers and template designers. Smarty also converts
53     the templates into PHP scripts, eliminating the need to parse the
54     templates on every invocation. This makes Smarty extremely scalable and
55     manageable for large application needs.
56
57     Some of Smarty's features:
58
59     * it is extremely fast
60     * no template parsing overhead, only compiles once.
61         * it is smart about recompiling only the template files that have
62           changed.
63     * the template language is remarkably extensible via the plugin
64       architecture.
65     * configurable template delimiter tag syntax, so you can use
66       {}, {{}}, <!--{}-->, or whatever you like.
67     * built-in caching of template output.
68     * arbitrary template sources (filesystem, databases, etc.)
69     * template if/elseif/else/endif constructs are passed to the PHP parser,
70       so the if syntax can be as simple or as complex as you like.
71     * unlimited nesting of sections, conditionals, etc. allowed
72     * it is possible to embed PHP code right in your template files,
73       although not recommended and doubtfully needed since the engine
74       is so customizable.
75     * and many more.
76
77 COPYRIGHT:
78     Copyright (c) 2001-2005 New Digital Group, Inc. All rights reserved.
79     This software is released under the GNU Lesser General Public License.
80     Please read the disclaimer at the top of the Smarty.class.php file.