-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
282 lines (268 loc) · 14.8 KB
/
index.html
File metadata and controls
282 lines (268 loc) · 14.8 KB
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
<!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>Typus User Guide — Typus 4.0.0.beta documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '4.0.0.beta',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Typus 4.0.0.beta documentation" href="#" />
<link rel="next" title="Initializers" href="configuration/initializers.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="configuration/initializers.html" title="Initializers"
accesskey="N">next</a></li>
<li><a href="#">Typus 4.0.0.beta documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="typus-user-guide">
<h1>Typus User Guide<a class="headerlink" href="#typus-user-guide" title="Permalink to this headline">¶</a></h1>
<p><strong>Typus</strong> is a control panel for <a class="reference external" href="http://rubyonrails.org/">Rails</a> applications to allow
trusted users edit structured content.</p>
<p>It’s not a CMS with a full working system but it provides a part of the system:
authentication, permissions and basic look and feel for your websites control
panel. So using <a class="reference external" href="http://rubyonrails.org/">Rails</a> with <strong>Typus</strong> lets you concentrate on your
application instead of the bits to manage the system.</p>
<p><strong>Typus</strong> is the “old latin” word for <strong>type</strong> which stands for:</p>
<blockquote>
<div>A category of people or things having common characteristics.</div></blockquote>
<div class="section" id="key-features">
<h2>Key Features<a class="headerlink" href="#key-features" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Built-in Authentication and Access Control Lists.</li>
<li>CRUD and custom actions for your models on a clean interface.</li>
<li>Internationalized interface.</li>
<li>Internationalized interface (<a class="reference external" href="https://github.com/fesplugas/typus/tree/master/config/locales">See available translations</a>)</li>
<li>Customizable and extensible templates.</li>
<li>Integrated <a class="reference external" href="http://rubygems.org/gems/paperclip">paperclip</a> and <a class="reference external" href="http://rubygems.org/gems/dragonfly">dragonfly</a> attachments viewer.</li>
<li>Supports Rails 4.0 and 3.2.</li>
<li>Tested with <strong>SQLite3</strong>, <strong>MySQL</strong> and <strong>PostgreSQL</strong>.</li>
<li><strong>MIT License</strong>, the same as <a class="reference external" href="http://rubyonrails.org/">Rails</a>.</li>
</ul>
</div>
<div class="section" id="support">
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>
<p>You can directly participate in the support and development of <strong>Typus</strong>,
including new features, by hiring our team to work on your project. We offer
customization services for modules and extensions for a fee.</p>
<p>Send your inquiries to <a class="reference external" href="mailto:contact%40typuscmf.com">contact<span>@</span>typuscmf<span>.</span>com</a>.</p>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>Before installing make sure your application does not have any controller
under <tt class="docutils literal"><span class="pre">controllers/admin</span></tt> as all <strong>Typus</strong> controllers will be generated
there.</p>
<p>To install <strong>Typus</strong>, edit the application <tt class="docutils literal"><span class="pre">Gemfile</span></tt> and add:</p>
<div class="highlight-ruby"><div class="highlight"><pre><span class="n">gem</span> <span class="s1">'typus'</span>
<span class="c1"># Bundle edge Typus instead:</span>
<span class="c1"># gem 'typus', :git => 'https://github.com/fesplugas/typus.git'</span>
</pre></div>
</div>
<p>Install the <strong>RubyGem</strong> using <tt class="docutils literal"><span class="pre">bundler</span></tt>:</p>
<div class="highlight-bash"><div class="highlight"><pre>bundle install
</pre></div>
</div>
<p><strong>Typus</strong> expects to have models to manage, so run the generator in order to
generate the required configuration files:</p>
<div class="highlight-bash"><div class="highlight"><pre>rails generate typus
</pre></div>
</div>
<p>Start the application server, go to <a class="reference external" href="http://0.0.0.0:3000/admin">http://0.0.0.0:3000/admin</a> and follow the
instructions.</p>
<p>By default <strong>Typus</strong> will not enable any authentication mechanism. If you want
to add <tt class="docutils literal"><span class="pre">session</span></tt> authentication you need to run a generator and migrate your
application database:</p>
<div class="highlight-bash"><div class="highlight"><pre>rails generate typus:migration
rake db:migrate
</pre></div>
</div>
<p>This generator creates a new model, <tt class="docutils literal"><span class="pre">AdminUser</span></tt> and adds some settings which
will be stored under <tt class="docutils literal"><span class="pre">config/typus</span></tt> folder. You can see some options of this
generator running the following command:</p>
<div class="highlight-bash"><div class="highlight"><pre>rails generate typus:migration -h
</pre></div>
</div>
<p>If you want to customize views you can copy default views to your application:</p>
<div class="highlight-bash"><div class="highlight"><pre>rails generate typus:views
</pre></div>
</div>
<p>To see a list of <strong>Typus</strong> related tasks run:</p>
<div class="highlight-bash"><div class="highlight"><pre>rake -T typus
</pre></div>
</div>
</div>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="configuration/initializers.html">Initializers</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration/resources.html">Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration/resource.html">Resource</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration/roles.html">Roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="customization/selectors.html">Selectors</a></li>
<li class="toctree-l1"><a class="reference internal" href="customization/custom_css_and_js.html">Custom CSS and Javascript</a></li>
</ul>
</div>
</div>
<div class="section" id="customization">
<h2>Customization<a class="headerlink" href="#customization" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="customization/attribute-templates.html">Attribute Templates</a></li>
<li class="toctree-l1"><a class="reference internal" href="customization/custom_css_and_js.html">Custom CSS and Javascript</a></li>
<li class="toctree-l1"><a class="reference internal" href="customization/selectors.html">Selectors</a></li>
<li class="toctree-l1"><a class="reference internal" href="customization/user-interface.html">User Interface</a></li>
</ul>
</div>
</div>
<div class="section" id="recipes">
<h2>Recipes<a class="headerlink" href="#recipes" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="recipes/configuration-files.html">Configuration Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes/custom-actions.html">Custom Actions</a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes/custom-authentication.html">Custom Authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes/devise-authentication.html">Devise Authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes/export-on-heroku.html">Using Typus’ export features on Heroku (fixes the 0 byte export issue)</a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes/rich-text-editor.html">Adding a Rich Text Editor</a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes/single-table-inheritance.html">Single Table Inheritance</a></li>
</ul>
</div>
</div>
<div class="section" id="misc">
<h2>Misc<a class="headerlink" href="#misc" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="upgrade.html">Upgrade</a></li>
</ul>
</div>
</div>
<div class="section" id="contribute">
<h2>Contribute<a class="headerlink" href="#contribute" title="Permalink to this headline">¶</a></h2>
<p>All of our hard work and help/support is free. We do have expenses to pay for
this project and your donations do allow us to spend more time building and
supporting the project.</p>
<p>Some interesting ways to contribute to the project:</p>
<ul class="simple">
<li><strong>Fork the project</strong> - Fork the project on <a class="reference external" href="https://github.com/fesplugas/typus/">GitHub</a> and make it better.</li>
<li><strong>Tell everybody about Typus</strong> - Let us know and we’ll link back to you as well.</li>
<li><strong>Hire us</strong> to work on your next project - we build websites large and small.</li>
</ul>
</div>
</div>
<div class="section" id="credits">
<h1>Credits<a class="headerlink" href="#credits" title="Permalink to this headline">¶</a></h1>
<p>Somehow involved in the project:</p>
<ul class="simple">
<li><a class="reference external" href="http://www.rubyist.net/~matz">Yukihiro “matz” Matsumoto</a> creator of <a class="reference external" href="http://ruby-lang.org/">Ruby</a>, in my opinion, the most
beautiful programming language.</li>
<li><a class="reference external" href="http://loudthinking.com/">David Heinemeier Hansson</a> for creating <a class="reference external" href="http://rubyonrails.org/">Rails</a>.</li>
<li><a class="reference external" href="http://www.djangoproject.com/">Django Admin</a> who inspired part of the development, specially templates
rendering and user interface.</li>
<li>Our <a class="reference external" href="http://github.com/fesplugas/typus/contributors">Contributors</a>.</li>
</ul>
</div>
<div class="section" id="mit-license">
<h1>MIT License<a class="headerlink" href="#mit-license" title="Permalink to this headline">¶</a></h1>
<div class="highlight-none"><div class="highlight"><pre>Copyright (c) 2007-2013 Francesc Esplugas Marti
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Typus User Guide</a><ul>
<li><a class="reference internal" href="#key-features">Key Features</a></li>
<li><a class="reference internal" href="#support">Support</a></li>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
<li><a class="reference internal" href="#customization">Customization</a></li>
<li><a class="reference internal" href="#recipes">Recipes</a></li>
<li><a class="reference internal" href="#misc">Misc</a></li>
<li><a class="reference internal" href="#contribute">Contribute</a></li>
</ul>
</li>
<li><a class="reference internal" href="#credits">Credits</a></li>
<li><a class="reference internal" href="#mit-license">MIT License</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="configuration/initializers.html"
title="next chapter">Initializers</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.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" />
<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="configuration/initializers.html" title="Initializers"
>next</a></li>
<li><a href="#">Typus 4.0.0.beta documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Francesc Esplugas.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>