-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.html
142 lines (133 loc) · 6.55 KB
/
setup.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Setup — Ella v1.0.0.0 documentation</title>
<link rel="stylesheet" href="static/default.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.0.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="Ella v1.0.0.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li><a href="index.html">Ella v1.0.0.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="setup">
<h1>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h1>
<p>Ella is a set of standard django applications so in order to use it you first
need to create a django project and add those applications to
<tt class="docutils literal"><span class="pre">INSTALLED_APPS</span></tt> along with their dependencies:</p>
<div class="highlight-python"><pre>INSTALLED_APPS = [
...
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.redirects',
'ella.core',
'ella.photos',
'ella.newman',
'ella.articles',
...
]</pre>
</div>
<p>and define the URL mappings:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># use ella's error handlers</span>
<span class="kn">from</span> <span class="nn">ella.core.urls</span> <span class="kn">import</span> <span class="n">handler404</span><span class="p">,</span> <span class="n">handler500</span>
<span class="c"># newman instead of django.contrib.admin</span>
<span class="kn">from</span> <span class="nn">ella</span> <span class="kn">import</span> <span class="n">newman</span>
<span class="n">newman</span><span class="o">.</span><span class="n">autodiscover</span><span class="p">()</span>
<span class="n">urlpatterns</span> <span class="o">+=</span> <span class="n">patterns</span><span class="p">(</span><span class="s">''</span><span class="p">,</span>
<span class="p">(</span><span class="s">r'^newman/'</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="n">newman</span><span class="o">.</span><span class="n">site</span><span class="o">.</span><span class="n">urls</span><span class="p">)),</span>
<span class="p">(</span><span class="s">r'^'</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="s">'ella.core.urls'</span><span class="p">)),</span>
<span class="p">)</span>
</pre></div>
</div>
<p>Next you have to suuply the templates, the minimal set of template you will need is:</p>
<blockquote>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">page/category.html</span></tt> for category rendering, this will also render as
your site’s root (‘/’ - which is just root category’s URL).</li>
<li><tt class="docutils literal"><span class="pre">page/object.html</span></tt> all the object details rendering</li>
<li><tt class="docutils literal"><span class="pre">page/listing.html</span></tt> archives and list of objects</li>
<li><tt class="docutils literal"><span class="pre">page/404.html</span></tt>, <tt class="docutils literal"><span class="pre">page/500.html</span></tt> the error templates</li>
</ul>
</blockquote>
<p>See <a class="reference external" href="core/views.html#core-views"><em>Views</em></a> for views that render these templates and the context content.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Ella’s error handlers use <tt class="docutils literal"><span class="pre">RequestContext</span></tt> by default. If you have any
logic in your context processors that might fail you should use your own
<tt class="docutils literal"><span class="pre">handler500</span></tt> (do not import it in your <tt class="docutils literal"><span class="pre">urls.py</span></tt>).</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="sources/setup.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
>modules</a> |</li>
<li><a href="index.html">Ella v1.0.0.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009, Centrum Holdings.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.3.
</div>
</body>
</html>