22235b56bb8b873d07c0abdbdf0238551434b358
[philo.git] / index.html
1 <!DOCTYPE html>
2
3 <html>
4         <head>
5                 <title>Philo</title>
6                 <link rel="stylesheet" type="text/css" href="static/css/screen.css" media="screen" />
7                 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.0/jquery.min.js"></script>
8                 <script src="static/js/init.js"></script>
9         </head>
10         <body>
11                 <div id="fork">
12                         <a href="http://github.com/ithinksw/philo"><img style="position: fixed; top: 0; right: 0; border: 0;" src="https://d3nwyuy0nl342s.cloudfront.net/img/e6bef7a091f5f3138b8cd40bc3e114258dd68ddf/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67" alt="Fork me on GitHub"></a>
13                 </div>
14
15                 <div id="container">
16                         
17                         <header id="nameplate">
18                                 <h1>Philo</h1>
19                                 <a class="installButton" href="#install">Install</a>
20                         </header><!-- /#nameplate -->
21                         
22                         <article id="content">
23                                 
24                                 <section id="whatIs">
25                                         <p><span class="s1"><span class="w1">Philo</span> is a powerful content-management system built with <a href="https://djangoproject.com/">Django</a>.</span> It manages websites, simple and complex.</p>
26                                 </section>
27                         
28                                 <section id="featuresSection">
29                                         <header>
30                                                 <h2 id="features">Features</h2>
31                                         </header>
32                         
33                                         <p>Philo allows the creation of complex site structures from Django&#8217;s own <a href="https://docs.djangoproject.com/en/1.3/ref/contrib/admin/">admin interface</a> (or similar database interface). For a simple site, you will use the following three objects, included in the <span class="pname">Philo</span> core.</p>
34                         
35                                         <ul id="modelList">
36                                                 <li><span class="name">Nodes</span> are the basic building blocks of a website using <span class="pname">Philo</span>. They define the URL hierarchy and connect each URL to a View subclass instance, such as a Page.</li>
37                                                 <li><span class="name">Templates</span> are Django templates, stored in the database and editable from the Django admin (or similar).</li>
38                                                 <li><span class="name">Pages</span> are a simple view subclass which return a basic HTML page according to a template. They have related, editable Contentlets and Content References based on <code>{% container %}</code> tags used in the template.</li>
39                                         </ul>
40                         
41                                         <p><span class="pname">Philo</span> also provides a number of useful template tags, in particular <code>{% container %}</code>, which generates a relationship (and a field in the admin interface) on any pages which use that template. For more about <span class="pname">Philo</span> and its features, <a href="#documentation">read the documentation</a>.</p>
42                                 </section>
43                                 
44                                 <section id="exampleSection">
45                                         <h2 id="a_simple_example">A Simple Example</h2>
46                         
47                                         <div class="three-up">
48                                                 <figure>
49                                                         <img src="static/img/container1.png" width="600" height="300" />
50                                                         <figcaption>Put container tags in your template.</figcaption>
51                                                 </figure>
52                                                 <figure>
53                                                         <img src="static/img/container2.png" width="600" height="300" />
54                                                         <figcaption>Edit the contentlets on the page.</figcaption>
55                                                 </figure>
56                                                 <figure>
57                                                         <img src="static/img/container3.png" width="600" height="300" />
58                                                         <figcaption>See the results on your site!</figcaption>
59                                                 </figure>
60                                         </div>
61                         
62                                         <p>You can use also collections, redirects, files, content references (all included in the <span class="pname">Philo</span> core), as well as the <span class="pname">Philo</span> contrib apps and your own code to create and manage more powerful, complex websites.</p>
63                                 </section>
64                                 
65                                 <section id="contribSection">
66                                         <h2 id="batteries_included">Batteries Included</h2>
67                         
68                                         <p>Following Python and Django&#8217;s <a href="http://docs.python.org/tutorial/stdlib.html#batteries-included">&ldquo;batteries included&rdquo; philosophy</a>, Philo includes a number of optional packages that simplify common website structures. These are stored in <code>philo.contrib</code> and include the following:</p>
69                         
70                                         <ul id="contribList">
71                                                 <li>
72                                                         <span class="name">Penfield</span>
73                                                         <span class="description">Blog and newsletter management.</span>
74                                                 </li>
75                                                 <li>
76                                                         <span class="name">Shipherd</span>
77                                                         <span class="description">Powerful site navigation.</span>
78                                                 </li>
79                                                 <li>
80                                                         <span class="name">Sobol</span>
81                                                         <span class="description">Custom web and database searches.</span>
82                                                 </li>
83                                                 <li>
84                                                         <span class="name">Waldo</span>
85                                                         <span class="description">Custom authentication systems.</span>
86                                                 </li>
87                                                 <li>
88                                                         <span class="status dev">(in development)</span>
89                                                         <span class="name">Gilbert</span>
90                                                         <span class="description">Alternative admin built on <a href="http://www.sencha.com/products/extjs/">Ext JS</a>.</span>
91                                                 </li>
92                                                 <li>
93                                                         <span class="status dev">(in development)</span>
94                                                         <span class="name">Julian</span>
95                                                         <span class="description">Calendar and events system.</span>
96                                                 </li>
97                                                 <li>
98                                                         <span class="status dev">(in development)</span>
99                                                         <span class="name">Edmonia</span>
100                                                         <span class="description">Asset management.</span>
101                                                 </li>
102                                                 <li>
103                                                         <span class="status dev">(in development)</span>
104                                                         <span class="name">Bartleby</span>
105                                                         <span class="description">Form generation and handling.</span>
106                                                 </li>
107                                                 <li>
108                                                         <span class="status pla">(planned)</span>
109                                                         <span class="description">Forums.</span>
110                                                 </li>
111                                                 <li>
112                                                         <span class="status pla">(planned)</span>
113                                                         <span class="description">Wikis.</span>
114                                                 </li>
115                                         </ul>
116                                 </section>
117                                 
118                                 <section class="installSection">
119                                         <h2 id="install">Install Philo</h2>
120                                         <div class="codeblock shell">
121                                                 <code>git clone git://git.ithinksw.org/philo.git</code>
122                                                 <code>python philo/setup.py install</code>
123                                                 <code>rm -rf philo</code>
124                                         </div>
125                                 </section>
126                                 
127                                 <section class="getInvolved">
128                                         <h2 id="get_involved">Get Involved</h2>
129                                         <p><span class="pname">Philo</span> is still under heavy development. If you&#8217;re a Python/Django developer, help out by forking <a href="http://github.com/ithinksw/philo"><span class="pname">Philo</span> on GitHub</a> to add features or fix bugs.</p>
130                                 <section>
131                                 
132                         </article><!-- /#content -->
133                         
134                         <footer>
135                                 <p>Philo is developed by iThink Software. Read the <a href="https://github.com/ithinksw/philo/blob/master/LICENSE">license</a>. Read the <a href="#documentation">documentation</a>.</p>
136                         </footer>
137                         
138                 </div>
139         </body>
140 </html>