• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1************************************
2* Clearsilver README
3************************************
4
5For more information, see the website:
6
7  http://www.clearsilver.net/
8
9This package includes Clearsilver, the CGI kit and HTML templating
10system. For information about building and installing, see the
11included INSTALL file. This package also includes tools which
12help you use Clearsilver, as well as a few examples.
13
14************************************************************
15*** Clearsilver
16
17* Clearsilver - This is our html template system and cgi kit.
18
19There are too many great things about clearsilver to list them all
20here, but here are some of the salient points:
21
22  * get the html out of your code
23  * loops, conditionals, macros, and stuff
24  * cgi kit unifies query variable and cookie handling
25  * super-easy to go from static mockup to dynamic page
26  * run multiple front-ends on the same application code
27  * super-fast C-library
28  * unifies Query variable and cookie handling
29  * language neutral (C,C++,Python,Ruby,Perl,Java,C#)
30  * nice iterative page debugging/development features
31  * generate static-data-driven page content without using any code
32  * did I mention super-fast?
33
34Supported language information:
35
36  README.python
37
38*************************************************************
39*** Tools
40
41* trans.py
42
43This is our transparent translation system. It's based on how we did
44translation at Yahoo!. You leave all the english strings right in the
45clearsilver templates. trans parses the html and extracts your
46language strings into a translation database. You can then translate
47the strings using any means. (it includes tools for dump and loading
48per-language files for shipping to translators). Occasionally trans
49isn't smart enough to find your language strings, in this case you can
50manually extract them into static language string files and trans will
51automatically pick them up. When it comes time to ship, trans
52generates language-independent templates, and a set of language files
53from your database.
54
55*************************************************************
56*** Examples
57
58* static.cgi
59
60This is a standalone binary which handles Clearsilver rendering of
61static content. This is a great way to play with clearsilver syntax
62before you start writing dynamic CGIs with it. This is also a great
63way to do webpage mockups with much more power than server side
64includes.  See the INSTALL file for information about configuring
65this for use with apache.
66
67