diff options
| author | R. Tyler Ballance <tyler@slide.com> | 2009-04-05 21:58:10 -0700 |
|---|---|---|
| committer | R. Tyler Ballance <tyler@slide.com> | 2009-04-05 21:58:10 -0700 |
| commit | 10477af3fd5271b445e10a8e9bbb0a068d3dbe3d (patch) | |
| tree | 3a385e8310a08ba33c442922076d7fd81247b279 | |
| parent | 8a6ad3b355790a537d27e4f1e80afeb88a5005c9 (diff) | |
| download | python-cheetah-10477af3fd5271b445e10a8e9bbb0a068d3dbe3d.tar.gz | |
Add the docs page, flesh out most of the rest of the new site
Signed-off-by: R. Tyler Ballance <tyler@slide.com>
| -rw-r--r-- | .gitignore | 6 | ||||
| -rw-r--r-- | WikiRoot.tmpl | 24 | ||||
| -rw-r--r-- | developers.tmpl | 44 | ||||
| -rw-r--r-- | docs.tmpl | 93 | ||||
| -rw-r--r-- | index.tmpl | 24 | ||||
| -rw-r--r-- | stylesheet.css | 8 |
6 files changed, 187 insertions, 12 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7fada59 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +*.pyc +*.swp +*.so +*.html +*.bak + diff --git a/WikiRoot.tmpl b/WikiRoot.tmpl index 1adbec2..9f3de2f 100644 --- a/WikiRoot.tmpl +++ b/WikiRoot.tmpl @@ -2,13 +2,15 @@ #extends Template #implements respond +## (Name, Link, IsTab) #set global $Pages = [ - ('Home', 'index.html'), - ('Download', 'download.html'), - ('Issues', 'http://bugs.communitycheetah.org'), - ('Developers', 'developers.html'), - ('Source', 'http://github.com/rtyler/cheetah/tree/master'), - ('Mailing List', 'http://lists.sourceforge.net/lists/listinfo/cheetahtemplate-discuss'), + ('Home', 'index.html', True), + ('Download', 'download.html', True), + ('Documentation', 'docs.html', True), + ('Issues', 'http://bugs.communitycheetah.org', False), + ('Developers', 'developers.html', True), + ('Source', 'http://github.com/rtyler/cheetah/tree/master', False), + ('Mailing List', 'http://lists.sourceforge.net/lists/listinfo/cheetahtemplate-discuss', False), ] <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html> @@ -78,7 +80,10 @@ <div id="blogtitle"> <div id="small"><a href="#">Community Cheetah</a> </div> <div id="small2"> - #for $Name, $Link in $Pages + #for $Name, $Link, $IsTab in $Pages + #if $IsTab and not $Name == 'Home' + #continue + #end if <a href="$Link">$Name</a> | #end for </div> @@ -86,7 +91,10 @@ <div id="topmenu"> <ul class="BLUE"> - #for $Name, $Link in $Pages + #for $Name, $Link, $IsTab in $Pages + #if not $IsTab + #continue + #end if <li> <a href="$Link" title="$Name"> <span>$Name</span> diff --git a/developers.tmpl b/developers.tmpl index 4924fbd..f5ecd6f 100644 --- a/developers.tmpl +++ b/developers.tmpl @@ -11,4 +11,48 @@ Contributing to Cheetah ======================== +Cheetah is the work of many volunteers. If you use Cheetah, share your experiences, tricks, customizations, and frustrations. +Please join the [mailing list](http://lists.sourceforge.net/lists/listinfo/cheetahtemplate-discuss). + +Fork Me! +-------- +Community Cheetah is hosted by [GitHub](http://www.github.com) which encourages forking of projects in order +to facilitate truly distributed and decentralized development. That is not to say that Community Cheetah is +"decentralized" per sé but rather it's ready for community involvement from the get-go! To get started +with contributing to Community Cheetah, it's a good idea to clone the "central" Git repo [here](http://github.com/rtyler/cheetah). + +Development Process +------------------- +The typical development workflow for Community Cheetah revolves around two primary branches **maint** and **next**. +The **next** branch is where development planned for the next release of Community Cheetah is. The **maint** branch +on the otherhand is where backported fixes and patches will be applied for the *current* release of Community Cheetah +will go, it's common for a patch to be applied to **maint** and **next** at the same time. + + +Bug reports and patches +----------------------- + +If you have stubmled across a bug or have an improvement to suggest in Cheetah please consider reporting +the issue into Community Cheetah's [bug tracker](http://bugs.communitycheetah.org) or emailing the +[mailing list](http://lists.sourceforge.net/lists/listinfo/cheetahtemplate-discuss). + +Please try to include the following bits of information: + +* A description of what you were trying to do, and what happened (i.e. reproduction steps) +* Any and all tracebacks or compiler errors +* The version of Cheetah you're using +* The version of Python you're using +* The operating system you're running Cheetah on +* Any other pieces of information you might think are relevant + +Example sites and tutorials +--------------------------- + +If you're developing a website with Cheetah, please send a link to the email list so we can keep track of Cheetah sites. Also, if you discover new and interesting ways to use Cheetah please share your experience and write a quick tutorial about your technique. + + +Test cases +---------- + +Cheetah is packaged with a regression testing suite that is run with each new release to ensure that everything is working as expected and that recent changes haven't broken anything. The test cases are in the Cheetah.Tests module. If you find a reproduceable bug please consider writing a test case that will pass only when the bug is fixed. Send any new test cases to the email list with the subject-line "new test case for Cheetah." #end def diff --git a/docs.tmpl b/docs.tmpl new file mode 100644 index 0000000..998364f --- /dev/null +++ b/docs.tmpl @@ -0,0 +1,93 @@ +#import WikiRoot +#from Cheetah.Filters import Markdown +#extends WikiRoot.WikiRoot + +#def pagename() + #return 'Documentation' +#end def + +#def content() +#transform Markdown +Cheetah Documentation +===================== + +Currently the Community Cheetah documentation is in a state-of flux, you can however +still refer to the older Cheetah v2.0.1 documentation for most of the basics + +* [Single-page HTML](http://www.cheetahtemplate.org/docs/users_guide_html/) +* [Multi-page HTML](http://www.cheetahtemplate.org/docs/users_guide_html_multipage/) +* [Text](http://www.cheetahtemplate.org/docs/users_guide.txt) +* [PDF](http://www.cheetahtemplate.org/docs/users_guide.pdf) + + +Unofficial Documentation and Articles +------------------------------------- + +[Building and filling out templates with Python and Cheetah](http://www-128.ibm.com/developerworks/opensource/library/os-pythcheetah/?ca=dgr-lnxw06PythonCheetah) by Leonard Richardson, Software Engineer +at CollabNet. Published in IBM Developer Works, August 9th, 2005. Leonard +Richardson is the author of many Python applications and libraries, including +NewsBruiser and Beautiful Soup. He is a co-author of the new tome Beginning +Python, from Wrox. + + +[Python-Powered Templates with Cheetah](http://www.onlamp.com/pub/a/python/2005/01/13/cheetah.html) +by Andrew Glover, founder and CTO of Vanward +Technologies, a company specializing in building automated testing frameworks. +Published in O'Reilly's ONLamp.com, January 13th, 2005 + + +[Templating with Cheetah](http://www.devshed.com/c/a/Python/Templating-with-Cheetah/) +A DevShed article by Peyton McCullough. Published in December 2005. + + +[Templating in Python](http://linuxgazette.net/117/orr.html) A +Linux Gazette article by Mike Orr. Published in Issue 117 of Linux Gazette, +August 2005. + + +[Regular Expressions: CherryPy proves its worth](http://www.unixreview.com/documents/s=10075/ur0604h/) +An Unix Review article by Miki Tebeka and Cameron Laid. They build a small addressbook application in less +than 150 lines of code using the CherryPy web framework and Cheetah. +Published May 2006. + + +[How to install Cheetah on Dreamhost](http://coderseye.com/2006/how-to-install-cheetah-on-dreamhost.html) +A blog article published by Bruce Kroeze in January 2006. + + +[Tierisch gut Das Cheetah Templating-System in der Praxis](http://www.linuxenterprise.de/itr/online_artikel/psecom,id,639,nodeid,9.html) +A German-language article by Markus Jais. Published in the +December 2004 edition of [linuxenterprise.de](http://www.linuxenterprise.de/) + + +[Python Success Stories: Python Enterprise-Wide at the University of St Andrews in Scotland](http://wingware.com/python/success/st-andrews) +by Hamish Lawson. Cheetah is used for the presentation +layer. Hamish Lawson is a software developer in the IT Services department at +the University of St Andrews, Scotland. Published January 17th, 2003. + + +[Code Generation Network - Case Study with Peter White](http://www.codegeneration.net/tiki-read_article.php?articleId=39) +An interview that discusses using Cheetah for generating Java code in a financial services +application. "Given my recent experience with Python and Cheetah, I can't +imagine an easier way to generate code!" Published March 1st, 2004. + + +In Literature +------------- + +Cheetah is covered in [Python in a Nutshell](http://www.amazon.com/exec/obidos/tg/detail/-/0596001886/ref=pd_sim_b_2/002-9262270-4252038?%5Fencoding=UTF8&v=glance) +by Alex Martelli. Alex writes on the Cheetah list: "Nutshell +readers looking for templating engines will be tempted by my ultra-brief +coverage enough to come visit the Cheetah site and get stunned. Indeed, I'm +impressed enough that I plan to cover _only_ Cheetah as the one tool for any +serious templating need." + + +It is also introduced in the New Riders book [Python Web Programming](http://www.informit.com/title/0735710902) +by Steve Holden. Steve writes "Although the software is still in beta at the +time of writing, it is already stable and easy to use either with or without +Webware. It looks as though Cheetah will be useful to many web projects, as +well as any others that need flexible template substitution of a general +nature." Published Jan 8th, 2002. + +#end def @@ -23,4 +23,28 @@ patches and improvements to the engine. Cheetah already has a large and active user community, and there are a number of products built with Cheetah in the Fortune 500, as well startups in Silicon Valley (like [reddit](http://www.reddit.com)) + + +Why should I use Cheetah? +------------------------- +* Cheetah is supported by every major Python web framework. + +* It is fully documented and is supported by an active user community. + +* It can output/generate any text-based format. + +* Cheetah compiles templates into optimized, yet readable, Python code. + +* It blends the power and flexibility of Python with a simple template language that non-programmers can understand. + +* It gives template authors full access to any Python data structure, module, function, object, or method in their templates. Meanwhile, it provides a way for administrators to selectively restrict access to Python when needed. + +* Cheetah makes code reuse easy by providing an object-oriented interface to templates that is accessible from Python code or other Cheetah templates. One template can subclass another and selectively reimplement sections of it. Cheetah templates can be subclasses of any Python class and vice-versa. + +* It provides a simple, yet powerful, caching mechanism that can dramatically improve the performance of a dynamic website. + +* It encourages clean separation of content, graphic design, and program code. This leads to highly modular, flexible, and reusable site architectures, shorter development time, and HTML and program code that is easier to understand and maintain. It is particularly well suited for team efforts. + +* Cheetah can be used to generate static html via its command-line tool. + #end def diff --git a/stylesheet.css b/stylesheet.css index 983b0a4..0fa8c2e 100644 --- a/stylesheet.css +++ b/stylesheet.css @@ -5,9 +5,9 @@ body { background:#ffffff url('images/bg.jpg') top center repeat-x;
margin:10px 10px 0px 10px;
padding:0px;
-color:#999999;
+color: #000;
font-family:"Trebuchet MS",arial,sans-serif;
-font-size: 90%;
+font-size: 80%;
}
@@ -83,10 +83,10 @@ voice-family: inherit; margin-left: 201px;
margin-right:201px;
padding:20px;
-
+font-size: 1.3em;
}
-#centercontent p {color:#888;}
+#centercontent p {color:#000;}
#centercontent a, a:link { color:#006633;}
|