|
1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>pyams_content.root package — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
28 <!--[if lte IE 6]> |
|
29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
30 <![endif]--> |
|
31 |
|
32 </head> |
|
33 <body> |
|
34 |
|
35 <div class="related" role="navigation" aria-label="related navigation"> |
|
36 <h3>Navigation</h3> |
|
37 <ul> |
|
38 <li class="right" style="margin-right: 10px"> |
|
39 <a href="genindex.html" title="General Index" |
|
40 accesskey="I">index</a></li> |
|
41 <li class="right" > |
|
42 <a href="py-modindex.html" title="Python Module Index" |
|
43 >modules</a> |</li> |
|
44 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
45 </ul> |
|
46 </div> |
|
47 |
|
48 <div class="document"> |
|
49 <div class="documentwrapper"> |
|
50 <div class="bodywrapper"> |
|
51 <div class="body" role="main"> |
|
52 |
|
53 <div class="section" id="pyams-content-root-package"> |
|
54 <h1>pyams_content.root package<a class="headerlink" href="#pyams-content-root-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="subpackages"> |
|
56 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> |
|
57 <div class="toctree-wrapper compound"> |
|
58 <ul> |
|
59 <li class="toctree-l1"><a class="reference internal" href="pyams_content.root.interfaces.html">pyams_content.root.interfaces package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_content.root.interfaces.html#module-pyams_content.root.interfaces">Module contents</a></li> |
|
61 </ul> |
|
62 </li> |
|
63 <li class="toctree-l1"><a class="reference internal" href="pyams_content.root.zmi.html">pyams_content.root.zmi package</a><ul> |
|
64 <li class="toctree-l2"><a class="reference internal" href="pyams_content.root.zmi.html#submodules">Submodules</a></li> |
|
65 <li class="toctree-l2"><a class="reference internal" href="pyams_content.root.zmi.html#module-pyams_content.root.zmi.search">pyams_content.root.zmi.search module</a></li> |
|
66 <li class="toctree-l2"><a class="reference internal" href="pyams_content.root.zmi.html#module-pyams_content.root.zmi.sites">pyams_content.root.zmi.sites module</a></li> |
|
67 <li class="toctree-l2"><a class="reference internal" href="pyams_content.root.zmi.html#module-pyams_content.root.zmi">Module contents</a></li> |
|
68 </ul> |
|
69 </li> |
|
70 </ul> |
|
71 </div> |
|
72 </div> |
|
73 <div class="section" id="module-pyams_content.root"> |
|
74 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.root" title="Permalink to this headline">¶</a></h2> |
|
75 <dl class="class"> |
|
76 <dt id="pyams_content.root.SiteRoot"> |
|
77 <em class="property">class </em><code class="descclassname">pyams_content.root.</code><code class="descname">SiteRoot</code><a class="headerlink" href="#pyams_content.root.SiteRoot" title="Permalink to this definition">¶</a></dt> |
|
78 <dd><p>Bases: <a class="reference internal" href="pyams_security.html#pyams_security.security.ProtectedObject" title="pyams_security.security.ProtectedObject"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.security.ProtectedObject</span></code></a>, <a class="reference internal" href="pyams_utils.html#pyams_utils.site.BaseSiteRoot" title="pyams_utils.site.BaseSiteRoot"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.site.BaseSiteRoot</span></code></a>, <a class="reference internal" href="pyams_skin.html#pyams_skin.skin.UserSkinnableContent" title="pyams_skin.skin.UserSkinnableContent"><code class="xref py py-class docutils literal"><span class="pre">pyams_skin.skin.UserSkinnableContent</span></code></a></p> |
|
79 <p>Main site root</p> |
|
80 <dl class="attribute"> |
|
81 <dt id="pyams_content.root.SiteRoot.managers"> |
|
82 <code class="descname">managers</code><a class="headerlink" href="#pyams_content.root.SiteRoot.managers" title="Permalink to this definition">¶</a></dt> |
|
83 <dd><p>Custom field property used to handle role principals</p> |
|
84 </dd></dl> |
|
85 |
|
86 <dl class="attribute"> |
|
87 <dt id="pyams_content.root.SiteRoot.operators"> |
|
88 <code class="descname">operators</code><a class="headerlink" href="#pyams_content.root.SiteRoot.operators" title="Permalink to this definition">¶</a></dt> |
|
89 <dd><p>Custom field property used to handle role principals</p> |
|
90 </dd></dl> |
|
91 |
|
92 <dl class="attribute"> |
|
93 <dt id="pyams_content.root.SiteRoot.roles_interface"> |
|
94 <code class="descname">roles_interface</code><em class="property"> = <InterfaceClass pyams_content.root.interfaces.ISiteRootRoles></em><a class="headerlink" href="#pyams_content.root.SiteRoot.roles_interface" title="Permalink to this definition">¶</a></dt> |
|
95 <dd></dd></dl> |
|
96 |
|
97 <dl class="attribute"> |
|
98 <dt id="pyams_content.root.SiteRoot.templates_managers"> |
|
99 <code class="descname">templates_managers</code><a class="headerlink" href="#pyams_content.root.SiteRoot.templates_managers" title="Permalink to this definition">¶</a></dt> |
|
100 <dd><p>Custom field property used to handle role principals</p> |
|
101 </dd></dl> |
|
102 |
|
103 <dl class="attribute"> |
|
104 <dt id="pyams_content.root.SiteRoot.webmasters"> |
|
105 <code class="descname">webmasters</code><a class="headerlink" href="#pyams_content.root.SiteRoot.webmasters" title="Permalink to this definition">¶</a></dt> |
|
106 <dd><p>Custom field property used to handle role principals</p> |
|
107 </dd></dl> |
|
108 |
|
109 </dd></dl> |
|
110 |
|
111 <dl class="class"> |
|
112 <dt id="pyams_content.root.SiteRootBackOfficeConfiguration"> |
|
113 <em class="property">class </em><code class="descclassname">pyams_content.root.</code><code class="descname">SiteRootBackOfficeConfiguration</code><a class="headerlink" href="#pyams_content.root.SiteRootBackOfficeConfiguration" title="Permalink to this definition">¶</a></dt> |
|
114 <dd><p>Bases: <a class="reference internal" href="pyams_skin.html#pyams_skin.configuration.BackOfficeConfiguration" title="pyams_skin.configuration.BackOfficeConfiguration"><code class="xref py py-class docutils literal"><span class="pre">pyams_skin.configuration.BackOfficeConfiguration</span></code></a></p> |
|
115 <p>Site root back-office configuration</p> |
|
116 </dd></dl> |
|
117 |
|
118 <dl class="function"> |
|
119 <dt id="pyams_content.root.SiteRootBackOfficeConfigurationFactory"> |
|
120 <code class="descclassname">pyams_content.root.</code><code class="descname">SiteRootBackOfficeConfigurationFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.root.SiteRootBackOfficeConfigurationFactory" title="Permalink to this definition">¶</a></dt> |
|
121 <dd></dd></dl> |
|
122 |
|
123 <dl class="class"> |
|
124 <dt id="pyams_content.root.SiteRootConfiguration"> |
|
125 <em class="property">class </em><code class="descclassname">pyams_content.root.</code><code class="descname">SiteRootConfiguration</code><a class="headerlink" href="#pyams_content.root.SiteRootConfiguration" title="Permalink to this definition">¶</a></dt> |
|
126 <dd><p>Bases: <a class="reference internal" href="pyams_skin.html#pyams_skin.configuration.Configuration" title="pyams_skin.configuration.Configuration"><code class="xref py py-class docutils literal"><span class="pre">pyams_skin.configuration.Configuration</span></code></a></p> |
|
127 <p>Site root configuration</p> |
|
128 </dd></dl> |
|
129 |
|
130 <dl class="function"> |
|
131 <dt id="pyams_content.root.SiteRootConfigurationFactory"> |
|
132 <code class="descclassname">pyams_content.root.</code><code class="descname">SiteRootConfigurationFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.root.SiteRootConfigurationFactory" title="Permalink to this definition">¶</a></dt> |
|
133 <dd></dd></dl> |
|
134 |
|
135 <dl class="class"> |
|
136 <dt id="pyams_content.root.SiteRootPermissionChecker"> |
|
137 <em class="property">class </em><code class="descclassname">pyams_content.root.</code><code class="descname">SiteRootPermissionChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.root.SiteRootPermissionChecker" title="Permalink to this definition">¶</a></dt> |
|
138 <dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextAdapter" title="pyams_utils.adapter.ContextAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextAdapter</span></code></a></p> |
|
139 <p>Site root permission checker</p> |
|
140 <dl class="attribute"> |
|
141 <dt id="pyams_content.root.SiteRootPermissionChecker.edit_permission"> |
|
142 <code class="descname">edit_permission</code><a class="headerlink" href="#pyams_content.root.SiteRootPermissionChecker.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
143 <dd></dd></dl> |
|
144 |
|
145 </dd></dl> |
|
146 |
|
147 <dl class="class"> |
|
148 <dt id="pyams_content.root.SiteRootStaticConfiguration"> |
|
149 <em class="property">class </em><code class="descclassname">pyams_content.root.</code><code class="descname">SiteRootStaticConfiguration</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.root.SiteRootStaticConfiguration" title="Permalink to this definition">¶</a></dt> |
|
150 <dd><p>Bases: <a class="reference internal" href="pyams_skin.html#pyams_skin.configuration.StaticConfiguration" title="pyams_skin.configuration.StaticConfiguration"><code class="xref py py-class docutils literal"><span class="pre">pyams_skin.configuration.StaticConfiguration</span></code></a></p> |
|
151 <p>Site root static configuration</p> |
|
152 <dl class="attribute"> |
|
153 <dt id="pyams_content.root.SiteRootStaticConfiguration.application_name"> |
|
154 <code class="descname">application_name</code><em class="property"> = 'PyAMS CMS'</em><a class="headerlink" href="#pyams_content.root.SiteRootStaticConfiguration.application_name" title="Permalink to this definition">¶</a></dt> |
|
155 <dd></dd></dl> |
|
156 |
|
157 <dl class="attribute"> |
|
158 <dt id="pyams_content.root.SiteRootStaticConfiguration.application_package"> |
|
159 <code class="descname">application_package</code><em class="property"> = 'pyams_content'</em><a class="headerlink" href="#pyams_content.root.SiteRootStaticConfiguration.application_package" title="Permalink to this definition">¶</a></dt> |
|
160 <dd></dd></dl> |
|
161 |
|
162 <dl class="attribute"> |
|
163 <dt id="pyams_content.root.SiteRootStaticConfiguration.include_reload_button"> |
|
164 <code class="descname">include_reload_button</code><em class="property"> = False</em><a class="headerlink" href="#pyams_content.root.SiteRootStaticConfiguration.include_reload_button" title="Permalink to this definition">¶</a></dt> |
|
165 <dd></dd></dl> |
|
166 |
|
167 <dl class="attribute"> |
|
168 <dt id="pyams_content.root.SiteRootStaticConfiguration.inner_package"> |
|
169 <code class="descname">inner_package</code><em class="property"> = 'pyams_skin'</em><a class="headerlink" href="#pyams_content.root.SiteRootStaticConfiguration.inner_package" title="Permalink to this definition">¶</a></dt> |
|
170 <dd></dd></dl> |
|
171 |
|
172 <dl class="attribute"> |
|
173 <dt id="pyams_content.root.SiteRootStaticConfiguration.inner_package_name"> |
|
174 <code class="descname">inner_package_name</code><em class="property"> = 'PyAMS'</em><a class="headerlink" href="#pyams_content.root.SiteRootStaticConfiguration.inner_package_name" title="Permalink to this definition">¶</a></dt> |
|
175 <dd></dd></dl> |
|
176 |
|
177 </dd></dl> |
|
178 |
|
179 <dl class="class"> |
|
180 <dt id="pyams_content.root.SiteRootToolsConfiguration"> |
|
181 <em class="property">class </em><code class="descclassname">pyams_content.root.</code><code class="descname">SiteRootToolsConfiguration</code><a class="headerlink" href="#pyams_content.root.SiteRootToolsConfiguration" title="Permalink to this definition">¶</a></dt> |
|
182 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p> |
|
183 <p>Site root tools configuration</p> |
|
184 <dl class="attribute"> |
|
185 <dt id="pyams_content.root.SiteRootToolsConfiguration.forms_tool_name"> |
|
186 <code class="descname">forms_tool_name</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.root.SiteRootToolsConfiguration.forms_tool_name" title="Permalink to this definition">¶</a></dt> |
|
187 <dd></dd></dl> |
|
188 |
|
189 <dl class="attribute"> |
|
190 <dt id="pyams_content.root.SiteRootToolsConfiguration.imagemaps_tool_name"> |
|
191 <code class="descname">imagemaps_tool_name</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.root.SiteRootToolsConfiguration.imagemaps_tool_name" title="Permalink to this definition">¶</a></dt> |
|
192 <dd></dd></dl> |
|
193 |
|
194 <dl class="attribute"> |
|
195 <dt id="pyams_content.root.SiteRootToolsConfiguration.news_tool_name"> |
|
196 <code class="descname">news_tool_name</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.root.SiteRootToolsConfiguration.news_tool_name" title="Permalink to this definition">¶</a></dt> |
|
197 <dd></dd></dl> |
|
198 |
|
199 <dl class="attribute"> |
|
200 <dt id="pyams_content.root.SiteRootToolsConfiguration.tools_name"> |
|
201 <code class="descname">tools_name</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.root.SiteRootToolsConfiguration.tools_name" title="Permalink to this definition">¶</a></dt> |
|
202 <dd></dd></dl> |
|
203 |
|
204 <dl class="attribute"> |
|
205 <dt id="pyams_content.root.SiteRootToolsConfiguration.views_tool_name"> |
|
206 <code class="descname">views_tool_name</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.root.SiteRootToolsConfiguration.views_tool_name" title="Permalink to this definition">¶</a></dt> |
|
207 <dd></dd></dl> |
|
208 |
|
209 </dd></dl> |
|
210 |
|
211 <dl class="function"> |
|
212 <dt id="pyams_content.root.handle_granted_role"> |
|
213 <code class="descclassname">pyams_content.root.</code><code class="descname">handle_granted_role</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.root.handle_granted_role" title="Permalink to this definition">¶</a></dt> |
|
214 <dd><p>Add principals to operators group when a role is granted</p> |
|
215 </dd></dl> |
|
216 |
|
217 <dl class="function"> |
|
218 <dt id="pyams_content.root.site_root_tools_configuration_factory"> |
|
219 <code class="descclassname">pyams_content.root.</code><code class="descname">site_root_tools_configuration_factory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.root.site_root_tools_configuration_factory" title="Permalink to this definition">¶</a></dt> |
|
220 <dd><p>Site root tools configuration factory</p> |
|
221 </dd></dl> |
|
222 |
|
223 </div> |
|
224 </div> |
|
225 |
|
226 |
|
227 </div> |
|
228 </div> |
|
229 </div> |
|
230 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
231 <div class="sphinxsidebarwrapper"> |
|
232 <h3><a href="index.html">Table Of Contents</a></h3> |
|
233 <ul> |
|
234 <li><a class="reference internal" href="#">pyams_content.root package</a><ul> |
|
235 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
236 <li><a class="reference internal" href="#module-pyams_content.root">Module contents</a></li> |
|
237 </ul> |
|
238 </li> |
|
239 </ul> |
|
240 |
|
241 <div id="searchbox" style="display: none" role="search"> |
|
242 <h3>Quick search</h3> |
|
243 <form class="search" action="search.html" method="get"> |
|
244 <div><input type="text" name="q" /></div> |
|
245 <div><input type="submit" value="Go" /></div> |
|
246 <input type="hidden" name="check_keywords" value="yes" /> |
|
247 <input type="hidden" name="area" value="default" /> |
|
248 </form> |
|
249 </div> |
|
250 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
251 </div> |
|
252 </div> |
|
253 <div class="clearer"></div> |
|
254 </div> |
|
255 <div class="related" role="navigation" aria-label="related navigation"> |
|
256 <h3>Navigation</h3> |
|
257 <ul> |
|
258 <li class="right" style="margin-right: 10px"> |
|
259 <a href="genindex.html" title="General Index" |
|
260 >index</a></li> |
|
261 <li class="right" > |
|
262 <a href="py-modindex.html" title="Python Module Index" |
|
263 >modules</a> |</li> |
|
264 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
265 </ul> |
|
266 </div> |
|
267 <div class="footer" role="contentinfo"> |
|
268 © Copyright 2017, Thierry Florac. |
|
269 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
270 </div> |
|
271 </body> |
|
272 </html> |