|
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_portal 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-portal-package"> |
|
54 <h1>pyams_portal package<a class="headerlink" href="#pyams-portal-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_portal.interfaces.html">pyams_portal.interfaces package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.interfaces.html#module-pyams_portal.interfaces">Module contents</a></li> |
|
61 </ul> |
|
62 </li> |
|
63 <li class="toctree-l1"><a class="reference internal" href="pyams_portal.portlets.html">pyams_portal.portlets package</a><ul> |
|
64 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.portlets.html#subpackages">Subpackages</a><ul> |
|
65 <li class="toctree-l3"><a class="reference internal" href="pyams_portal.portlets.content.html">pyams_portal.portlets.content package</a><ul> |
|
66 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.portlets.content.html#submodules">Submodules</a></li> |
|
67 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.portlets.content.html#module-pyams_portal.portlets.content.interfaces">pyams_portal.portlets.content.interfaces module</a></li> |
|
68 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.portlets.content.html#module-pyams_portal.portlets.content">Module contents</a></li> |
|
69 </ul> |
|
70 </li> |
|
71 <li class="toctree-l3"><a class="reference internal" href="pyams_portal.portlets.image.html">pyams_portal.portlets.image package</a><ul> |
|
72 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.portlets.image.html#submodules">Submodules</a></li> |
|
73 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.portlets.image.html#module-pyams_portal.portlets.image.interfaces">pyams_portal.portlets.image.interfaces module</a></li> |
|
74 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.portlets.image.html#module-pyams_portal.portlets.image">Module contents</a></li> |
|
75 </ul> |
|
76 </li> |
|
77 </ul> |
|
78 </li> |
|
79 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.portlets.html#module-pyams_portal.portlets">Module contents</a></li> |
|
80 </ul> |
|
81 </li> |
|
82 <li class="toctree-l1"><a class="reference internal" href="pyams_portal.tests.html">pyams_portal.tests package</a><ul> |
|
83 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.tests.html#submodules">Submodules</a></li> |
|
84 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.tests.html#module-pyams_portal.tests.test_utilsdocs">pyams_portal.tests.test_utilsdocs module</a></li> |
|
85 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.tests.html#module-pyams_portal.tests.test_utilsdocstrings">pyams_portal.tests.test_utilsdocstrings module</a></li> |
|
86 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.tests.html#module-pyams_portal.tests">Module contents</a></li> |
|
87 </ul> |
|
88 </li> |
|
89 <li class="toctree-l1"><a class="reference internal" href="pyams_portal.zmi.html">pyams_portal.zmi package</a><ul> |
|
90 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.zmi.html#subpackages">Subpackages</a><ul> |
|
91 <li class="toctree-l3"><a class="reference internal" href="pyams_portal.zmi.portlets.html">pyams_portal.zmi.portlets package</a><ul> |
|
92 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.zmi.portlets.html#submodules">Submodules</a></li> |
|
93 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.zmi.portlets.html#module-pyams_portal.zmi.portlets.content">pyams_portal.zmi.portlets.content module</a></li> |
|
94 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.zmi.portlets.html#module-pyams_portal.zmi.portlets.image">pyams_portal.zmi.portlets.image module</a></li> |
|
95 <li class="toctree-l4"><a class="reference internal" href="pyams_portal.zmi.portlets.html#module-pyams_portal.zmi.portlets">Module contents</a></li> |
|
96 </ul> |
|
97 </li> |
|
98 </ul> |
|
99 </li> |
|
100 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.zmi.html#submodules">Submodules</a></li> |
|
101 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.zmi.html#module-pyams_portal.zmi.container">pyams_portal.zmi.container module</a></li> |
|
102 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.zmi.html#module-pyams_portal.zmi.interfaces">pyams_portal.zmi.interfaces module</a></li> |
|
103 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.zmi.html#module-pyams_portal.zmi.layout">pyams_portal.zmi.layout module</a></li> |
|
104 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.zmi.html#module-pyams_portal.zmi.page">pyams_portal.zmi.page module</a></li> |
|
105 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.zmi.html#module-pyams_portal.zmi.portlet">pyams_portal.zmi.portlet module</a></li> |
|
106 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.zmi.html#module-pyams_portal.zmi.template">pyams_portal.zmi.template module</a></li> |
|
107 <li class="toctree-l2"><a class="reference internal" href="pyams_portal.zmi.html#module-pyams_portal.zmi">Module contents</a></li> |
|
108 </ul> |
|
109 </li> |
|
110 </ul> |
|
111 </div> |
|
112 </div> |
|
113 <div class="section" id="submodules"> |
|
114 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
115 </div> |
|
116 <div class="section" id="module-pyams_portal.include"> |
|
117 <span id="pyams-portal-include-module"></span><h2>pyams_portal.include module<a class="headerlink" href="#module-pyams_portal.include" title="Permalink to this headline">¶</a></h2> |
|
118 <dl class="function"> |
|
119 <dt id="pyams_portal.include.include_package"> |
|
120 <code class="descclassname">pyams_portal.include.</code><code class="descname">include_package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.include.include_package" title="Permalink to this definition">¶</a></dt> |
|
121 <dd><p>Pyramid include</p> |
|
122 </dd></dl> |
|
123 |
|
124 </div> |
|
125 <div class="section" id="module-pyams_portal.page"> |
|
126 <span id="pyams-portal-page-module"></span><h2>pyams_portal.page module<a class="headerlink" href="#module-pyams_portal.page" title="Permalink to this headline">¶</a></h2> |
|
127 <dl class="function"> |
|
128 <dt id="pyams_portal.page.PortalContextPageAdapter"> |
|
129 <code class="descclassname">pyams_portal.page.</code><code class="descname">PortalContextPageAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.page.PortalContextPageAdapter" title="Permalink to this definition">¶</a></dt> |
|
130 <dd><p>Portal context page factory</p> |
|
131 </dd></dl> |
|
132 |
|
133 <dl class="class"> |
|
134 <dt id="pyams_portal.page.PortalContextPortletTraverser"> |
|
135 <em class="property">class </em><code class="descclassname">pyams_portal.page.</code><code class="descname">PortalContextPortletTraverser</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.page.PortalContextPortletTraverser" title="Permalink to this definition">¶</a></dt> |
|
136 <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> |
|
137 <p>++portlet++ portal context traverser</p> |
|
138 <dl class="method"> |
|
139 <dt id="pyams_portal.page.PortalContextPortletTraverser.traverse"> |
|
140 <code class="descname">traverse</code><span class="sig-paren">(</span><em>name</em>, <em>thurtherpath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.page.PortalContextPortletTraverser.traverse" title="Permalink to this definition">¶</a></dt> |
|
141 <dd></dd></dl> |
|
142 |
|
143 </dd></dl> |
|
144 |
|
145 <dl class="function"> |
|
146 <dt id="pyams_portal.page.PortalContextPortletsConfigurationAdapter"> |
|
147 <code class="descclassname">pyams_portal.page.</code><code class="descname">PortalContextPortletsConfigurationAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.page.PortalContextPortletsConfigurationAdapter" title="Permalink to this definition">¶</a></dt> |
|
148 <dd><p>Portal context portlets configuration adapter</p> |
|
149 </dd></dl> |
|
150 |
|
151 <dl class="function"> |
|
152 <dt id="pyams_portal.page.PortalContextTemplateConfigurationAdapter"> |
|
153 <code class="descclassname">pyams_portal.page.</code><code class="descname">PortalContextTemplateConfigurationAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.page.PortalContextTemplateConfigurationAdapter" title="Permalink to this definition">¶</a></dt> |
|
154 <dd><p>Portal context template configuration adapter</p> |
|
155 </dd></dl> |
|
156 |
|
157 <dl class="class"> |
|
158 <dt id="pyams_portal.page.PortalContextTemplateTraverser"> |
|
159 <em class="property">class </em><code class="descclassname">pyams_portal.page.</code><code class="descname">PortalContextTemplateTraverser</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.page.PortalContextTemplateTraverser" title="Permalink to this definition">¶</a></dt> |
|
160 <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> |
|
161 <p>++template++ portal context traverser</p> |
|
162 <dl class="method"> |
|
163 <dt id="pyams_portal.page.PortalContextTemplateTraverser.traverse"> |
|
164 <code class="descname">traverse</code><span class="sig-paren">(</span><em>name</em>, <em>furtherpath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.page.PortalContextTemplateTraverser.traverse" title="Permalink to this definition">¶</a></dt> |
|
165 <dd></dd></dl> |
|
166 |
|
167 </dd></dl> |
|
168 |
|
169 <dl class="class"> |
|
170 <dt id="pyams_portal.page.PortalPage"> |
|
171 <em class="property">class </em><code class="descclassname">pyams_portal.page.</code><code class="descname">PortalPage</code><a class="headerlink" href="#pyams_portal.page.PortalPage" title="Permalink to this definition">¶</a></dt> |
|
172 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p> |
|
173 <p>Portal page persistent class</p> |
|
174 <p>The page is the highest configuration level. |
|
175 It defines which template is used (a shared or local one), which gives |
|
176 the slot and portlet lists.</p> |
|
177 <dl class="attribute"> |
|
178 <dt id="pyams_portal.page.PortalPage.can_inherit"> |
|
179 <code class="descname">can_inherit</code><a class="headerlink" href="#pyams_portal.page.PortalPage.can_inherit" title="Permalink to this definition">¶</a></dt> |
|
180 <dd></dd></dl> |
|
181 |
|
182 <dl class="attribute"> |
|
183 <dt id="pyams_portal.page.PortalPage.inherit_parent"> |
|
184 <code class="descname">inherit_parent</code><a class="headerlink" href="#pyams_portal.page.PortalPage.inherit_parent" title="Permalink to this definition">¶</a></dt> |
|
185 <dd></dd></dl> |
|
186 |
|
187 <dl class="attribute"> |
|
188 <dt id="pyams_portal.page.PortalPage.local_template"> |
|
189 <code class="descname">local_template</code><a class="headerlink" href="#pyams_portal.page.PortalPage.local_template" title="Permalink to this definition">¶</a></dt> |
|
190 <dd></dd></dl> |
|
191 |
|
192 <dl class="attribute"> |
|
193 <dt id="pyams_portal.page.PortalPage.parent"> |
|
194 <code class="descname">parent</code><a class="headerlink" href="#pyams_portal.page.PortalPage.parent" title="Permalink to this definition">¶</a></dt> |
|
195 <dd></dd></dl> |
|
196 |
|
197 <dl class="attribute"> |
|
198 <dt id="pyams_portal.page.PortalPage.shared_template"> |
|
199 <code class="descname">shared_template</code><a class="headerlink" href="#pyams_portal.page.PortalPage.shared_template" title="Permalink to this definition">¶</a></dt> |
|
200 <dd></dd></dl> |
|
201 |
|
202 <dl class="attribute"> |
|
203 <dt id="pyams_portal.page.PortalPage.template"> |
|
204 <code class="descname">template</code><a class="headerlink" href="#pyams_portal.page.PortalPage.template" title="Permalink to this definition">¶</a></dt> |
|
205 <dd></dd></dl> |
|
206 |
|
207 <dl class="attribute"> |
|
208 <dt id="pyams_portal.page.PortalPage.use_local_template"> |
|
209 <code class="descname">use_local_template</code><a class="headerlink" href="#pyams_portal.page.PortalPage.use_local_template" title="Permalink to this definition">¶</a></dt> |
|
210 <dd></dd></dl> |
|
211 |
|
212 <dl class="attribute"> |
|
213 <dt id="pyams_portal.page.PortalPage.use_shared_template"> |
|
214 <code class="descname">use_shared_template</code><a class="headerlink" href="#pyams_portal.page.PortalPage.use_shared_template" title="Permalink to this definition">¶</a></dt> |
|
215 <dd></dd></dl> |
|
216 |
|
217 </dd></dl> |
|
218 |
|
219 </div> |
|
220 <div class="section" id="module-pyams_portal.portlet"> |
|
221 <span id="pyams-portal-portlet-module"></span><h2>pyams_portal.portlet module<a class="headerlink" href="#module-pyams_portal.portlet" title="Permalink to this headline">¶</a></h2> |
|
222 <dl class="class"> |
|
223 <dt id="pyams_portal.portlet.PortalPortletsConfiguration"> |
|
224 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortalPortletsConfiguration</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortalPortletsConfiguration" title="Permalink to this definition">¶</a></dt> |
|
225 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.mapping.PersistentMapping</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p> |
|
226 <p>Portal portlets configuration</p> |
|
227 <dl class="classmethod"> |
|
228 <dt id="pyams_portal.portlet.PortalPortletsConfiguration.clone"> |
|
229 <em class="property">classmethod </em><code class="descname">clone</code><span class="sig-paren">(</span><em>source_config</em>, <em>new_parent</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortalPortletsConfiguration.clone" title="Permalink to this definition">¶</a></dt> |
|
230 <dd><p>Clone source configuration</p> |
|
231 </dd></dl> |
|
232 |
|
233 <dl class="method"> |
|
234 <dt id="pyams_portal.portlet.PortalPortletsConfiguration.delete_portlet_configuration"> |
|
235 <code class="descname">delete_portlet_configuration</code><span class="sig-paren">(</span><em>portlet_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortalPortletsConfiguration.delete_portlet_configuration" title="Permalink to this definition">¶</a></dt> |
|
236 <dd></dd></dl> |
|
237 |
|
238 <dl class="method"> |
|
239 <dt id="pyams_portal.portlet.PortalPortletsConfiguration.get_portlet_configuration"> |
|
240 <code class="descname">get_portlet_configuration</code><span class="sig-paren">(</span><em>portlet_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortalPortletsConfiguration.get_portlet_configuration" title="Permalink to this definition">¶</a></dt> |
|
241 <dd></dd></dl> |
|
242 |
|
243 <dl class="method"> |
|
244 <dt id="pyams_portal.portlet.PortalPortletsConfiguration.set_portlet_configuration"> |
|
245 <code class="descname">set_portlet_configuration</code><span class="sig-paren">(</span><em>portlet_id</em>, <em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortalPortletsConfiguration.set_portlet_configuration" title="Permalink to this definition">¶</a></dt> |
|
246 <dd></dd></dl> |
|
247 |
|
248 </dd></dl> |
|
249 |
|
250 <dl class="class"> |
|
251 <dt id="pyams_portal.portlet.Portlet"> |
|
252 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">Portlet</code><a class="headerlink" href="#pyams_portal.portlet.Portlet" title="Permalink to this definition">¶</a></dt> |
|
253 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
254 <p>Base portlet utility</p> |
|
255 <dl class="attribute"> |
|
256 <dt id="pyams_portal.portlet.Portlet.permission"> |
|
257 <code class="descname">permission</code><a class="headerlink" href="#pyams_portal.portlet.Portlet.permission" title="Permalink to this definition">¶</a></dt> |
|
258 <dd><p>Computed attributes based on schema fields</p> |
|
259 <p>Field properties provide default values, data validation and error messages |
|
260 based on data found in field meta-data.</p> |
|
261 <p>Note that FieldProperties cannot be used with slots. They can only |
|
262 be used for attributes stored in instance dictionaries.</p> |
|
263 </dd></dl> |
|
264 |
|
265 <dl class="attribute"> |
|
266 <dt id="pyams_portal.portlet.Portlet.settings_class"> |
|
267 <code class="descname">settings_class</code><em class="property"> = None</em><a class="headerlink" href="#pyams_portal.portlet.Portlet.settings_class" title="Permalink to this definition">¶</a></dt> |
|
268 <dd></dd></dl> |
|
269 |
|
270 <dl class="attribute"> |
|
271 <dt id="pyams_portal.portlet.Portlet.toolbar_css_class"> |
|
272 <code class="descname">toolbar_css_class</code><em class="property"> = 'fa fa-fw fa-2x fa-edit'</em><a class="headerlink" href="#pyams_portal.portlet.Portlet.toolbar_css_class" title="Permalink to this definition">¶</a></dt> |
|
273 <dd></dd></dl> |
|
274 |
|
275 <dl class="attribute"> |
|
276 <dt id="pyams_portal.portlet.Portlet.toolbar_image"> |
|
277 <code class="descname">toolbar_image</code><em class="property"> = None</em><a class="headerlink" href="#pyams_portal.portlet.Portlet.toolbar_image" title="Permalink to this definition">¶</a></dt> |
|
278 <dd></dd></dl> |
|
279 |
|
280 </dd></dl> |
|
281 |
|
282 <dl class="class"> |
|
283 <dt id="pyams_portal.portlet.PortletConfiguration"> |
|
284 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletConfiguration</code><span class="sig-paren">(</span><em>portlet</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletConfiguration" title="Permalink to this definition">¶</a></dt> |
|
285 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p> |
|
286 <p>Portlet configuration persistent class</p> |
|
287 <p>This class is a generic persistent class which is used to store all portlet |
|
288 configuration and is <em>not</em> supposed to be sub-classed.</p> |
|
289 <p>PortletConfiguration.__parent__ points to context where configuration is applied (each context or |
|
290 local template). |
|
291 PortletConfiguration.parent points to context from where configuration is inherited.</p> |
|
292 <dl class="attribute"> |
|
293 <dt id="pyams_portal.portlet.PortletConfiguration.can_inherit"> |
|
294 <code class="descname">can_inherit</code><a class="headerlink" href="#pyams_portal.portlet.PortletConfiguration.can_inherit" title="Permalink to this definition">¶</a></dt> |
|
295 <dd></dd></dl> |
|
296 |
|
297 <dl class="attribute"> |
|
298 <dt id="pyams_portal.portlet.PortletConfiguration.editor_settings"> |
|
299 <code class="descname">editor_settings</code><a class="headerlink" href="#pyams_portal.portlet.PortletConfiguration.editor_settings" title="Permalink to this definition">¶</a></dt> |
|
300 <dd></dd></dl> |
|
301 |
|
302 <dl class="attribute"> |
|
303 <dt id="pyams_portal.portlet.PortletConfiguration.inherit_parent"> |
|
304 <code class="descname">inherit_parent</code><a class="headerlink" href="#pyams_portal.portlet.PortletConfiguration.inherit_parent" title="Permalink to this definition">¶</a></dt> |
|
305 <dd></dd></dl> |
|
306 |
|
307 <dl class="attribute"> |
|
308 <dt id="pyams_portal.portlet.PortletConfiguration.parent"> |
|
309 <code class="descname">parent</code><a class="headerlink" href="#pyams_portal.portlet.PortletConfiguration.parent" title="Permalink to this definition">¶</a></dt> |
|
310 <dd></dd></dl> |
|
311 |
|
312 <dl class="attribute"> |
|
313 <dt id="pyams_portal.portlet.PortletConfiguration.portlet_id"> |
|
314 <code class="descname">portlet_id</code><a class="headerlink" href="#pyams_portal.portlet.PortletConfiguration.portlet_id" title="Permalink to this definition">¶</a></dt> |
|
315 <dd><p>Computed attributes based on schema fields</p> |
|
316 <p>Field properties provide default values, data validation and error messages |
|
317 based on data found in field meta-data.</p> |
|
318 <p>Note that FieldProperties cannot be used with slots. They can only |
|
319 be used for attributes stored in instance dictionaries.</p> |
|
320 </dd></dl> |
|
321 |
|
322 <dl class="attribute"> |
|
323 <dt id="pyams_portal.portlet.PortletConfiguration.portlet_name"> |
|
324 <code class="descname">portlet_name</code><em class="property"> = None</em><a class="headerlink" href="#pyams_portal.portlet.PortletConfiguration.portlet_name" title="Permalink to this definition">¶</a></dt> |
|
325 <dd></dd></dl> |
|
326 |
|
327 <dl class="attribute"> |
|
328 <dt id="pyams_portal.portlet.PortletConfiguration.settings"> |
|
329 <code class="descname">settings</code><a class="headerlink" href="#pyams_portal.portlet.PortletConfiguration.settings" title="Permalink to this definition">¶</a></dt> |
|
330 <dd></dd></dl> |
|
331 |
|
332 </dd></dl> |
|
333 |
|
334 <dl class="function"> |
|
335 <dt id="pyams_portal.portlet.PortletConfigurationAdapter"> |
|
336 <code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletConfigurationAdapter</code><span class="sig-paren">(</span><em>portlet</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletConfigurationAdapter" title="Permalink to this definition">¶</a></dt> |
|
337 <dd><p>Portlet configuration factory</p> |
|
338 </dd></dl> |
|
339 |
|
340 <dl class="class"> |
|
341 <dt id="pyams_portal.portlet.PortletConfigurationPermissionChecker"> |
|
342 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletConfigurationPermissionChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletConfigurationPermissionChecker" title="Permalink to this definition">¶</a></dt> |
|
343 <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> |
|
344 <p>Portlet configuration permission checker</p> |
|
345 <dl class="attribute"> |
|
346 <dt id="pyams_portal.portlet.PortletConfigurationPermissionChecker.edit_permission"> |
|
347 <code class="descname">edit_permission</code><a class="headerlink" href="#pyams_portal.portlet.PortletConfigurationPermissionChecker.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
348 <dd></dd></dl> |
|
349 |
|
350 </dd></dl> |
|
351 |
|
352 <dl class="function"> |
|
353 <dt id="pyams_portal.portlet.PortletConfigurationSettingsAdapter"> |
|
354 <code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletConfigurationSettingsAdapter</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletConfigurationSettingsAdapter" title="Permalink to this definition">¶</a></dt> |
|
355 <dd><p>Portlet configuration settings adapter</p> |
|
356 </dd></dl> |
|
357 |
|
358 <dl class="class"> |
|
359 <dt id="pyams_portal.portlet.PortletConfigurationSettingsTraverser"> |
|
360 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletConfigurationSettingsTraverser</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletConfigurationSettingsTraverser" title="Permalink to this definition">¶</a></dt> |
|
361 <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> |
|
362 <p>++settings++ portlet configuration traverser</p> |
|
363 <dl class="method"> |
|
364 <dt id="pyams_portal.portlet.PortletConfigurationSettingsTraverser.traverse"> |
|
365 <code class="descname">traverse</code><span class="sig-paren">(</span><em>name</em>, <em>furtherpath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletConfigurationSettingsTraverser.traverse" title="Permalink to this definition">¶</a></dt> |
|
366 <dd></dd></dl> |
|
367 |
|
368 </dd></dl> |
|
369 |
|
370 <dl class="class"> |
|
371 <dt id="pyams_portal.portlet.PortletContentProvider"> |
|
372 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletContentProvider</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em>, <em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletContentProvider" title="Permalink to this definition">¶</a></dt> |
|
373 <dd><p>Bases: <a class="reference internal" href="pyams_viewlet.html#pyams_viewlet.viewlet.ViewContentProvider" title="pyams_viewlet.viewlet.ViewContentProvider"><code class="xref py py-class docutils literal"><span class="pre">pyams_viewlet.viewlet.ViewContentProvider</span></code></a></p> |
|
374 <p>Base portlet content provider</p> |
|
375 </dd></dl> |
|
376 |
|
377 <dl class="class"> |
|
378 <dt id="pyams_portal.portlet.PortletPreviewer"> |
|
379 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletPreviewer</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em>, <em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletPreviewer" title="Permalink to this definition">¶</a></dt> |
|
380 <dd><p>Bases: <a class="reference internal" href="#pyams_portal.portlet.PortletContentProvider" title="pyams_portal.portlet.PortletContentProvider"><code class="xref py py-class docutils literal"><span class="pre">pyams_portal.portlet.PortletContentProvider</span></code></a></p> |
|
381 <p>Portlet previewer adapter</p> |
|
382 <dl class="attribute"> |
|
383 <dt id="pyams_portal.portlet.PortletPreviewer.slot_configuration"> |
|
384 <code class="descname">slot_configuration</code><a class="headerlink" href="#pyams_portal.portlet.PortletPreviewer.slot_configuration" title="Permalink to this definition">¶</a></dt> |
|
385 <dd></dd></dl> |
|
386 |
|
387 </dd></dl> |
|
388 |
|
389 <dl class="class"> |
|
390 <dt id="pyams_portal.portlet.PortletRenderer"> |
|
391 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletRenderer</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>view</em>, <em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletRenderer" title="Permalink to this definition">¶</a></dt> |
|
392 <dd><p>Bases: <a class="reference internal" href="#pyams_portal.portlet.PortletContentProvider" title="pyams_portal.portlet.PortletContentProvider"><code class="xref py py-class docutils literal"><span class="pre">pyams_portal.portlet.PortletContentProvider</span></code></a></p> |
|
393 <p>Portlet renderer adapter</p> |
|
394 <dl class="attribute"> |
|
395 <dt id="pyams_portal.portlet.PortletRenderer.slot_configuration"> |
|
396 <code class="descname">slot_configuration</code><a class="headerlink" href="#pyams_portal.portlet.PortletRenderer.slot_configuration" title="Permalink to this definition">¶</a></dt> |
|
397 <dd></dd></dl> |
|
398 |
|
399 <dl class="attribute"> |
|
400 <dt id="pyams_portal.portlet.PortletRenderer.target_interface"> |
|
401 <code class="descname">target_interface</code><em class="property"> = None</em><a class="headerlink" href="#pyams_portal.portlet.PortletRenderer.target_interface" title="Permalink to this definition">¶</a></dt> |
|
402 <dd></dd></dl> |
|
403 |
|
404 </dd></dl> |
|
405 |
|
406 <dl class="class"> |
|
407 <dt id="pyams_portal.portlet.PortletRenderersVocabulary"> |
|
408 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletRenderersVocabulary</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletRenderersVocabulary" title="Permalink to this definition">¶</a></dt> |
|
409 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
410 <p>Portlet renderers vocabulary</p> |
|
411 </dd></dl> |
|
412 |
|
413 <dl class="class"> |
|
414 <dt id="pyams_portal.portlet.PortletSettings"> |
|
415 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletSettings</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletSettings" title="Permalink to this definition">¶</a></dt> |
|
416 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p> |
|
417 <p>Portlet settings persistent class</p> |
|
418 <p>This class is supposed to be sub-classed by all custom portlet subclasses to |
|
419 store their configuration settings. |
|
420 Each portlet sub-class must define it’s settings class in it’s “settings_class” attribute.</p> |
|
421 <dl class="attribute"> |
|
422 <dt id="pyams_portal.portlet.PortletSettings.configuration"> |
|
423 <code class="descname">configuration</code><a class="headerlink" href="#pyams_portal.portlet.PortletSettings.configuration" title="Permalink to this definition">¶</a></dt> |
|
424 <dd></dd></dl> |
|
425 |
|
426 <dl class="attribute"> |
|
427 <dt id="pyams_portal.portlet.PortletSettings.renderer"> |
|
428 <code class="descname">renderer</code><a class="headerlink" href="#pyams_portal.portlet.PortletSettings.renderer" title="Permalink to this definition">¶</a></dt> |
|
429 <dd></dd></dl> |
|
430 |
|
431 <dl class="attribute"> |
|
432 <dt id="pyams_portal.portlet.PortletSettings.visible"> |
|
433 <code class="descname">visible</code><a class="headerlink" href="#pyams_portal.portlet.PortletSettings.visible" title="Permalink to this definition">¶</a></dt> |
|
434 <dd><p>Computed attributes based on schema fields</p> |
|
435 <p>Field properties provide default values, data validation and error messages |
|
436 based on data found in field meta-data.</p> |
|
437 <p>Note that FieldProperties cannot be used with slots. They can only |
|
438 be used for attributes stored in instance dictionaries.</p> |
|
439 </dd></dl> |
|
440 |
|
441 </dd></dl> |
|
442 |
|
443 <dl class="class"> |
|
444 <dt id="pyams_portal.portlet.PortletVocabulary"> |
|
445 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">PortletVocabulary</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.PortletVocabulary" title="Permalink to this definition">¶</a></dt> |
|
446 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
447 <p>Portlet vocabulary</p> |
|
448 </dd></dl> |
|
449 |
|
450 <dl class="class"> |
|
451 <dt id="pyams_portal.portlet.portlet_config"> |
|
452 <em class="property">class </em><code class="descclassname">pyams_portal.portlet.</code><code class="descname">portlet_config</code><span class="sig-paren">(</span><em>**settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.portlet.portlet_config" title="Permalink to this definition">¶</a></dt> |
|
453 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
454 <p>Class decorator used to declare a portlet</p> |
|
455 <dl class="attribute"> |
|
456 <dt id="pyams_portal.portlet.portlet_config.venusian"> |
|
457 <code class="descname">venusian</code><em class="property"> = <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'></em><a class="headerlink" href="#pyams_portal.portlet.portlet_config.venusian" title="Permalink to this definition">¶</a></dt> |
|
458 <dd></dd></dl> |
|
459 |
|
460 </dd></dl> |
|
461 |
|
462 </div> |
|
463 <div class="section" id="module-pyams_portal.site"> |
|
464 <span id="pyams-portal-site-module"></span><h2>pyams_portal.site module<a class="headerlink" href="#module-pyams_portal.site" title="Permalink to this headline">¶</a></h2> |
|
465 <dl class="class"> |
|
466 <dt id="pyams_portal.site.PortalGenerationsChecker"> |
|
467 <em class="property">class </em><code class="descclassname">pyams_portal.site.</code><code class="descname">PortalGenerationsChecker</code><a class="headerlink" href="#pyams_portal.site.PortalGenerationsChecker" title="Permalink to this definition">¶</a></dt> |
|
468 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
469 <p>Portal generations checker</p> |
|
470 <dl class="method"> |
|
471 <dt id="pyams_portal.site.PortalGenerationsChecker.evolve"> |
|
472 <code class="descname">evolve</code><span class="sig-paren">(</span><em>site</em>, <em>current=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.site.PortalGenerationsChecker.evolve" title="Permalink to this definition">¶</a></dt> |
|
473 <dd><p>Check for required utilities</p> |
|
474 </dd></dl> |
|
475 |
|
476 <dl class="attribute"> |
|
477 <dt id="pyams_portal.site.PortalGenerationsChecker.generation"> |
|
478 <code class="descname">generation</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_portal.site.PortalGenerationsChecker.generation" title="Permalink to this definition">¶</a></dt> |
|
479 <dd></dd></dl> |
|
480 |
|
481 </dd></dl> |
|
482 |
|
483 <dl class="function"> |
|
484 <dt id="pyams_portal.site.handle_new_local_site"> |
|
485 <code class="descclassname">pyams_portal.site.</code><code class="descname">handle_new_local_site</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.site.handle_new_local_site" title="Permalink to this definition">¶</a></dt> |
|
486 <dd><p>Create a new templates container when a site is created</p> |
|
487 </dd></dl> |
|
488 |
|
489 </div> |
|
490 <div class="section" id="module-pyams_portal.slot"> |
|
491 <span id="pyams-portal-slot-module"></span><h2>pyams_portal.slot module<a class="headerlink" href="#module-pyams_portal.slot" title="Permalink to this headline">¶</a></h2> |
|
492 <dl class="class"> |
|
493 <dt id="pyams_portal.slot.SlotConfiguration"> |
|
494 <em class="property">class </em><code class="descclassname">pyams_portal.slot.</code><code class="descname">SlotConfiguration</code><span class="sig-paren">(</span><em>slot_name</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration" title="Permalink to this definition">¶</a></dt> |
|
495 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p> |
|
496 <p>Portal slot class</p> |
|
497 <dl class="attribute"> |
|
498 <dt id="pyams_portal.slot.SlotConfiguration.css_class"> |
|
499 <code class="descname">css_class</code><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.css_class" title="Permalink to this definition">¶</a></dt> |
|
500 <dd><p>Computed attributes based on schema fields</p> |
|
501 <p>Field properties provide default values, data validation and error messages |
|
502 based on data found in field meta-data.</p> |
|
503 <p>Note that FieldProperties cannot be used with slots. They can only |
|
504 be used for attributes stored in instance dictionaries.</p> |
|
505 </dd></dl> |
|
506 |
|
507 <dl class="method"> |
|
508 <dt id="pyams_portal.slot.SlotConfiguration.get_css_class"> |
|
509 <code class="descname">get_css_class</code><span class="sig-paren">(</span><em>device=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.get_css_class" title="Permalink to this definition">¶</a></dt> |
|
510 <dd></dd></dl> |
|
511 |
|
512 <dl class="method"> |
|
513 <dt id="pyams_portal.slot.SlotConfiguration.get_width"> |
|
514 <code class="descname">get_width</code><span class="sig-paren">(</span><em>device=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.get_width" title="Permalink to this definition">¶</a></dt> |
|
515 <dd></dd></dl> |
|
516 |
|
517 <dl class="attribute"> |
|
518 <dt id="pyams_portal.slot.SlotConfiguration.lg_width"> |
|
519 <code class="descname">lg_width</code><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.lg_width" title="Permalink to this definition">¶</a></dt> |
|
520 <dd><p>Computed attributes based on schema fields</p> |
|
521 <p>Field properties provide default values, data validation and error messages |
|
522 based on data found in field meta-data.</p> |
|
523 <p>Note that FieldProperties cannot be used with slots. They can only |
|
524 be used for attributes stored in instance dictionaries.</p> |
|
525 </dd></dl> |
|
526 |
|
527 <dl class="attribute"> |
|
528 <dt id="pyams_portal.slot.SlotConfiguration.md_width"> |
|
529 <code class="descname">md_width</code><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.md_width" title="Permalink to this definition">¶</a></dt> |
|
530 <dd><p>Computed attributes based on schema fields</p> |
|
531 <p>Field properties provide default values, data validation and error messages |
|
532 based on data found in field meta-data.</p> |
|
533 <p>Note that FieldProperties cannot be used with slots. They can only |
|
534 be used for attributes stored in instance dictionaries.</p> |
|
535 </dd></dl> |
|
536 |
|
537 <dl class="attribute"> |
|
538 <dt id="pyams_portal.slot.SlotConfiguration.portlet_ids"> |
|
539 <code class="descname">portlet_ids</code><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.portlet_ids" title="Permalink to this definition">¶</a></dt> |
|
540 <dd></dd></dl> |
|
541 |
|
542 <dl class="method"> |
|
543 <dt id="pyams_portal.slot.SlotConfiguration.set_width"> |
|
544 <code class="descname">set_width</code><span class="sig-paren">(</span><em>width</em>, <em>device=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.set_width" title="Permalink to this definition">¶</a></dt> |
|
545 <dd></dd></dl> |
|
546 |
|
547 <dl class="attribute"> |
|
548 <dt id="pyams_portal.slot.SlotConfiguration.slot_name"> |
|
549 <code class="descname">slot_name</code><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.slot_name" title="Permalink to this definition">¶</a></dt> |
|
550 <dd><p>Computed attributes based on schema fields</p> |
|
551 <p>Field properties provide default values, data validation and error messages |
|
552 based on data found in field meta-data.</p> |
|
553 <p>Note that FieldProperties cannot be used with slots. They can only |
|
554 be used for attributes stored in instance dictionaries.</p> |
|
555 </dd></dl> |
|
556 |
|
557 <dl class="attribute"> |
|
558 <dt id="pyams_portal.slot.SlotConfiguration.sm_width"> |
|
559 <code class="descname">sm_width</code><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.sm_width" title="Permalink to this definition">¶</a></dt> |
|
560 <dd><p>Computed attributes based on schema fields</p> |
|
561 <p>Field properties provide default values, data validation and error messages |
|
562 based on data found in field meta-data.</p> |
|
563 <p>Note that FieldProperties cannot be used with slots. They can only |
|
564 be used for attributes stored in instance dictionaries.</p> |
|
565 </dd></dl> |
|
566 |
|
567 <dl class="attribute"> |
|
568 <dt id="pyams_portal.slot.SlotConfiguration.template"> |
|
569 <code class="descname">template</code><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.template" title="Permalink to this definition">¶</a></dt> |
|
570 <dd></dd></dl> |
|
571 |
|
572 <dl class="attribute"> |
|
573 <dt id="pyams_portal.slot.SlotConfiguration.visible"> |
|
574 <code class="descname">visible</code><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.visible" title="Permalink to this definition">¶</a></dt> |
|
575 <dd><p>Computed attributes based on schema fields</p> |
|
576 <p>Field properties provide default values, data validation and error messages |
|
577 based on data found in field meta-data.</p> |
|
578 <p>Note that FieldProperties cannot be used with slots. They can only |
|
579 be used for attributes stored in instance dictionaries.</p> |
|
580 </dd></dl> |
|
581 |
|
582 <dl class="attribute"> |
|
583 <dt id="pyams_portal.slot.SlotConfiguration.xs_width"> |
|
584 <code class="descname">xs_width</code><a class="headerlink" href="#pyams_portal.slot.SlotConfiguration.xs_width" title="Permalink to this definition">¶</a></dt> |
|
585 <dd><p>Computed attributes based on schema fields</p> |
|
586 <p>Field properties provide default values, data validation and error messages |
|
587 based on data found in field meta-data.</p> |
|
588 <p>Note that FieldProperties cannot be used with slots. They can only |
|
589 be used for attributes stored in instance dictionaries.</p> |
|
590 </dd></dl> |
|
591 |
|
592 </dd></dl> |
|
593 |
|
594 </div> |
|
595 <div class="section" id="module-pyams_portal.template"> |
|
596 <span id="pyams-portal-template-module"></span><h2>pyams_portal.template module<a class="headerlink" href="#module-pyams_portal.template" title="Permalink to this headline">¶</a></h2> |
|
597 <dl class="class"> |
|
598 <dt id="pyams_portal.template.PortalTemplate"> |
|
599 <em class="property">class </em><code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplate</code><a class="headerlink" href="#pyams_portal.template.PortalTemplate" title="Permalink to this definition">¶</a></dt> |
|
600 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p> |
|
601 <p>Portal template class</p> |
|
602 <dl class="attribute"> |
|
603 <dt id="pyams_portal.template.PortalTemplate.name"> |
|
604 <code class="descname">name</code><a class="headerlink" href="#pyams_portal.template.PortalTemplate.name" title="Permalink to this definition">¶</a></dt> |
|
605 <dd><p>Computed attributes based on schema fields</p> |
|
606 <p>Field properties provide default values, data validation and error messages |
|
607 based on data found in field meta-data.</p> |
|
608 <p>Note that FieldProperties cannot be used with slots. They can only |
|
609 be used for attributes stored in instance dictionaries.</p> |
|
610 </dd></dl> |
|
611 |
|
612 </dd></dl> |
|
613 |
|
614 <dl class="class"> |
|
615 <dt id="pyams_portal.template.PortalTemplateConfiguration"> |
|
616 <em class="property">class </em><code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplateConfiguration</code><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration" title="Permalink to this definition">¶</a></dt> |
|
617 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p> |
|
618 <p>Portal template configuration</p> |
|
619 <dl class="method"> |
|
620 <dt id="pyams_portal.template.PortalTemplateConfiguration.add_portlet"> |
|
621 <code class="descname">add_portlet</code><span class="sig-paren">(</span><em>portlet_name</em>, <em>slot_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.add_portlet" title="Permalink to this definition">¶</a></dt> |
|
622 <dd><p>Add portlet to given slot</p> |
|
623 </dd></dl> |
|
624 |
|
625 <dl class="method"> |
|
626 <dt id="pyams_portal.template.PortalTemplateConfiguration.add_row"> |
|
627 <code class="descname">add_row</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.add_row" title="Permalink to this definition">¶</a></dt> |
|
628 <dd><p>Add new row and return last row index (0 based)</p> |
|
629 </dd></dl> |
|
630 |
|
631 <dl class="method"> |
|
632 <dt id="pyams_portal.template.PortalTemplateConfiguration.add_slot"> |
|
633 <code class="descname">add_slot</code><span class="sig-paren">(</span><em>slot_name</em>, <em>row_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.add_slot" title="Permalink to this definition">¶</a></dt> |
|
634 <dd></dd></dl> |
|
635 |
|
636 <dl class="method"> |
|
637 <dt id="pyams_portal.template.PortalTemplateConfiguration.delete_portlet"> |
|
638 <code class="descname">delete_portlet</code><span class="sig-paren">(</span><em>portlet_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.delete_portlet" title="Permalink to this definition">¶</a></dt> |
|
639 <dd><p>Delete portlet</p> |
|
640 </dd></dl> |
|
641 |
|
642 <dl class="method"> |
|
643 <dt id="pyams_portal.template.PortalTemplateConfiguration.delete_row"> |
|
644 <code class="descname">delete_row</code><span class="sig-paren">(</span><em>row_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.delete_row" title="Permalink to this definition">¶</a></dt> |
|
645 <dd><p>Delete template row</p> |
|
646 </dd></dl> |
|
647 |
|
648 <dl class="method"> |
|
649 <dt id="pyams_portal.template.PortalTemplateConfiguration.delete_slot"> |
|
650 <code class="descname">delete_slot</code><span class="sig-paren">(</span><em>slot_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.delete_slot" title="Permalink to this definition">¶</a></dt> |
|
651 <dd><p>Delete slot and associated portlets</p> |
|
652 </dd></dl> |
|
653 |
|
654 <dl class="method"> |
|
655 <dt id="pyams_portal.template.PortalTemplateConfiguration.get_portlet_slot"> |
|
656 <code class="descname">get_portlet_slot</code><span class="sig-paren">(</span><em>portlet_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.get_portlet_slot" title="Permalink to this definition">¶</a></dt> |
|
657 <dd><p>Get portlet slot</p> |
|
658 </dd></dl> |
|
659 |
|
660 <dl class="method"> |
|
661 <dt id="pyams_portal.template.PortalTemplateConfiguration.get_slot_configuration"> |
|
662 <code class="descname">get_slot_configuration</code><span class="sig-paren">(</span><em>slot_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.get_slot_configuration" title="Permalink to this definition">¶</a></dt> |
|
663 <dd><p>Get slot configuration</p> |
|
664 </dd></dl> |
|
665 |
|
666 <dl class="method"> |
|
667 <dt id="pyams_portal.template.PortalTemplateConfiguration.get_slot_row"> |
|
668 <code class="descname">get_slot_row</code><span class="sig-paren">(</span><em>slot_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.get_slot_row" title="Permalink to this definition">¶</a></dt> |
|
669 <dd></dd></dl> |
|
670 |
|
671 <dl class="method"> |
|
672 <dt id="pyams_portal.template.PortalTemplateConfiguration.get_slots"> |
|
673 <code class="descname">get_slots</code><span class="sig-paren">(</span><em>row_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.get_slots" title="Permalink to this definition">¶</a></dt> |
|
674 <dd><p>Get ordered slots list</p> |
|
675 </dd></dl> |
|
676 |
|
677 <dl class="method"> |
|
678 <dt id="pyams_portal.template.PortalTemplateConfiguration.get_slots_width"> |
|
679 <code class="descname">get_slots_width</code><span class="sig-paren">(</span><em>device=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.get_slots_width" title="Permalink to this definition">¶</a></dt> |
|
680 <dd><p>Get slots width</p> |
|
681 </dd></dl> |
|
682 |
|
683 <dl class="attribute"> |
|
684 <dt id="pyams_portal.template.PortalTemplateConfiguration.rows"> |
|
685 <code class="descname">rows</code><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.rows" title="Permalink to this definition">¶</a></dt> |
|
686 <dd><p>Computed attributes based on schema fields</p> |
|
687 <p>Field properties provide default values, data validation and error messages |
|
688 based on data found in field meta-data.</p> |
|
689 <p>Note that FieldProperties cannot be used with slots. They can only |
|
690 be used for attributes stored in instance dictionaries.</p> |
|
691 </dd></dl> |
|
692 |
|
693 <dl class="method"> |
|
694 <dt id="pyams_portal.template.PortalTemplateConfiguration.set_portlet_order"> |
|
695 <code class="descname">set_portlet_order</code><span class="sig-paren">(</span><em>order</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.set_portlet_order" title="Permalink to this definition">¶</a></dt> |
|
696 <dd><p>Set portlet order</p> |
|
697 </dd></dl> |
|
698 |
|
699 <dl class="method"> |
|
700 <dt id="pyams_portal.template.PortalTemplateConfiguration.set_row_order"> |
|
701 <code class="descname">set_row_order</code><span class="sig-paren">(</span><em>order</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.set_row_order" title="Permalink to this definition">¶</a></dt> |
|
702 <dd><p>Change template row order</p> |
|
703 </dd></dl> |
|
704 |
|
705 <dl class="method"> |
|
706 <dt id="pyams_portal.template.PortalTemplateConfiguration.set_slot_order"> |
|
707 <code class="descname">set_slot_order</code><span class="sig-paren">(</span><em>order</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.set_slot_order" title="Permalink to this definition">¶</a></dt> |
|
708 <dd><p>Set slots order</p> |
|
709 </dd></dl> |
|
710 |
|
711 <dl class="method"> |
|
712 <dt id="pyams_portal.template.PortalTemplateConfiguration.set_slot_width"> |
|
713 <code class="descname">set_slot_width</code><span class="sig-paren">(</span><em>slot_name</em>, <em>device</em>, <em>width</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.set_slot_width" title="Permalink to this definition">¶</a></dt> |
|
714 <dd><p>Set slot width</p> |
|
715 </dd></dl> |
|
716 |
|
717 <dl class="attribute"> |
|
718 <dt id="pyams_portal.template.PortalTemplateConfiguration.slot_config"> |
|
719 <code class="descname">slot_config</code><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.slot_config" title="Permalink to this definition">¶</a></dt> |
|
720 <dd></dd></dl> |
|
721 |
|
722 <dl class="attribute"> |
|
723 <dt id="pyams_portal.template.PortalTemplateConfiguration.slot_names"> |
|
724 <code class="descname">slot_names</code><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.slot_names" title="Permalink to this definition">¶</a></dt> |
|
725 <dd></dd></dl> |
|
726 |
|
727 <dl class="attribute"> |
|
728 <dt id="pyams_portal.template.PortalTemplateConfiguration.slot_order"> |
|
729 <code class="descname">slot_order</code><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfiguration.slot_order" title="Permalink to this definition">¶</a></dt> |
|
730 <dd></dd></dl> |
|
731 |
|
732 </dd></dl> |
|
733 |
|
734 <dl class="function"> |
|
735 <dt id="pyams_portal.template.PortalTemplateConfigurationFactory"> |
|
736 <code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplateConfigurationFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateConfigurationFactory" title="Permalink to this definition">¶</a></dt> |
|
737 <dd><p>Portal template configuration adapter</p> |
|
738 </dd></dl> |
|
739 |
|
740 <dl class="class"> |
|
741 <dt id="pyams_portal.template.PortalTemplateContainer"> |
|
742 <em class="property">class </em><code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplateContainer</code><a class="headerlink" href="#pyams_portal.template.PortalTemplateContainer" title="Permalink to this definition">¶</a></dt> |
|
743 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p> |
|
744 <p>Portal templates container</p> |
|
745 <dl class="method"> |
|
746 <dt id="pyams_portal.template.PortalTemplateContainer.get_portlet_id"> |
|
747 <code class="descname">get_portlet_id</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateContainer.get_portlet_id" title="Permalink to this definition">¶</a></dt> |
|
748 <dd></dd></dl> |
|
749 |
|
750 <dl class="attribute"> |
|
751 <dt id="pyams_portal.template.PortalTemplateContainer.last_portlet_id"> |
|
752 <code class="descname">last_portlet_id</code><a class="headerlink" href="#pyams_portal.template.PortalTemplateContainer.last_portlet_id" title="Permalink to this definition">¶</a></dt> |
|
753 <dd><p>Computed attributes based on schema fields</p> |
|
754 <p>Field properties provide default values, data validation and error messages |
|
755 based on data found in field meta-data.</p> |
|
756 <p>Note that FieldProperties cannot be used with slots. They can only |
|
757 be used for attributes stored in instance dictionaries.</p> |
|
758 </dd></dl> |
|
759 |
|
760 </dd></dl> |
|
761 |
|
762 <dl class="class"> |
|
763 <dt id="pyams_portal.template.PortalTemplateContainerConfiguration"> |
|
764 <em class="property">class </em><code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplateContainerConfiguration</code><a class="headerlink" href="#pyams_portal.template.PortalTemplateContainerConfiguration" title="Permalink to this definition">¶</a></dt> |
|
765 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p> |
|
766 <p>Portal template container configuration</p> |
|
767 <dl class="attribute"> |
|
768 <dt id="pyams_portal.template.PortalTemplateContainerConfiguration.toolbar_portlets"> |
|
769 <code class="descname">toolbar_portlets</code><a class="headerlink" href="#pyams_portal.template.PortalTemplateContainerConfiguration.toolbar_portlets" title="Permalink to this definition">¶</a></dt> |
|
770 <dd><p>Computed attributes based on schema fields</p> |
|
771 <p>Field properties provide default values, data validation and error messages |
|
772 based on data found in field meta-data.</p> |
|
773 <p>Note that FieldProperties cannot be used with slots. They can only |
|
774 be used for attributes stored in instance dictionaries.</p> |
|
775 </dd></dl> |
|
776 |
|
777 </dd></dl> |
|
778 |
|
779 <dl class="function"> |
|
780 <dt id="pyams_portal.template.PortalTemplateContainerConfigurationAdapter"> |
|
781 <code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplateContainerConfigurationAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateContainerConfigurationAdapter" title="Permalink to this definition">¶</a></dt> |
|
782 <dd><p>Portal template container configuration factory</p> |
|
783 </dd></dl> |
|
784 |
|
785 <dl class="class"> |
|
786 <dt id="pyams_portal.template.PortalTemplatePortletTraverser"> |
|
787 <em class="property">class </em><code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplatePortletTraverser</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplatePortletTraverser" title="Permalink to this definition">¶</a></dt> |
|
788 <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> |
|
789 <p>++portlet++ template traverser</p> |
|
790 <dl class="method"> |
|
791 <dt id="pyams_portal.template.PortalTemplatePortletTraverser.traverse"> |
|
792 <code class="descname">traverse</code><span class="sig-paren">(</span><em>name</em>, <em>furtherpath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplatePortletTraverser.traverse" title="Permalink to this definition">¶</a></dt> |
|
793 <dd></dd></dl> |
|
794 |
|
795 </dd></dl> |
|
796 |
|
797 <dl class="function"> |
|
798 <dt id="pyams_portal.template.PortalTemplatePortletsConfigurationAdapter"> |
|
799 <code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplatePortletsConfigurationAdapter</code><span class="sig-paren">(</span><em>template</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplatePortletsConfigurationAdapter" title="Permalink to this definition">¶</a></dt> |
|
800 <dd><p>Portal template portlets configuration adapter</p> |
|
801 </dd></dl> |
|
802 |
|
803 <dl class="class"> |
|
804 <dt id="pyams_portal.template.PortalTemplateSlotsVocabulary"> |
|
805 <em class="property">class </em><code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplateSlotsVocabulary</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplateSlotsVocabulary" title="Permalink to this definition">¶</a></dt> |
|
806 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
807 <p>Portal template slots vocabulary</p> |
|
808 </dd></dl> |
|
809 |
|
810 <dl class="class"> |
|
811 <dt id="pyams_portal.template.PortalTemplatesVocabulary"> |
|
812 <em class="property">class </em><code class="descclassname">pyams_portal.template.</code><code class="descname">PortalTemplatesVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.PortalTemplatesVocabulary" title="Permalink to this definition">¶</a></dt> |
|
813 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p> |
|
814 <p>Portal templates vocabulary</p> |
|
815 <dl class="attribute"> |
|
816 <dt id="pyams_portal.template.PortalTemplatesVocabulary.interface"> |
|
817 <code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_portal.interfaces.IPortalTemplate></em><a class="headerlink" href="#pyams_portal.template.PortalTemplatesVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
818 <dd></dd></dl> |
|
819 |
|
820 <dl class="attribute"> |
|
821 <dt id="pyams_portal.template.PortalTemplatesVocabulary.nameOnly"> |
|
822 <code class="descname">nameOnly</code><em class="property"> = True</em><a class="headerlink" href="#pyams_portal.template.PortalTemplatesVocabulary.nameOnly" title="Permalink to this definition">¶</a></dt> |
|
823 <dd></dd></dl> |
|
824 |
|
825 </dd></dl> |
|
826 |
|
827 <dl class="function"> |
|
828 <dt id="pyams_portal.template.handle_added_template"> |
|
829 <code class="descclassname">pyams_portal.template.</code><code class="descname">handle_added_template</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.handle_added_template" title="Permalink to this definition">¶</a></dt> |
|
830 <dd><p>Register shared template</p> |
|
831 </dd></dl> |
|
832 |
|
833 <dl class="function"> |
|
834 <dt id="pyams_portal.template.handle_removed_template"> |
|
835 <code class="descclassname">pyams_portal.template.</code><code class="descname">handle_removed_template</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.template.handle_removed_template" title="Permalink to this definition">¶</a></dt> |
|
836 <dd><p>Unregister removed template</p> |
|
837 </dd></dl> |
|
838 |
|
839 </div> |
|
840 <div class="section" id="module-pyams_portal.views"> |
|
841 <span id="pyams-portal-views-module"></span><h2>pyams_portal.views module<a class="headerlink" href="#module-pyams_portal.views" title="Permalink to this headline">¶</a></h2> |
|
842 <dl class="class"> |
|
843 <dt id="pyams_portal.views.PortalContextIndexPage"> |
|
844 <em class="property">class </em><code class="descclassname">pyams_portal.views.</code><code class="descname">PortalContextIndexPage</code><a class="headerlink" href="#pyams_portal.views.PortalContextIndexPage" title="Permalink to this definition">¶</a></dt> |
|
845 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">pyams_default_theme.page.BaseIndexPage</span></code></p> |
|
846 <p>Portal context index page</p> |
|
847 <dl class="method"> |
|
848 <dt id="pyams_portal.views.PortalContextIndexPage.get_portlet"> |
|
849 <code class="descname">get_portlet</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.views.PortalContextIndexPage.get_portlet" title="Permalink to this definition">¶</a></dt> |
|
850 <dd></dd></dl> |
|
851 |
|
852 <dl class="attribute"> |
|
853 <dt id="pyams_portal.views.PortalContextIndexPage.page"> |
|
854 <code class="descname">page</code><a class="headerlink" href="#pyams_portal.views.PortalContextIndexPage.page" title="Permalink to this definition">¶</a></dt> |
|
855 <dd></dd></dl> |
|
856 |
|
857 <dl class="attribute"> |
|
858 <dt id="pyams_portal.views.PortalContextIndexPage.portlet_configuration"> |
|
859 <code class="descname">portlet_configuration</code><a class="headerlink" href="#pyams_portal.views.PortalContextIndexPage.portlet_configuration" title="Permalink to this definition">¶</a></dt> |
|
860 <dd></dd></dl> |
|
861 |
|
862 <dl class="method"> |
|
863 <dt id="pyams_portal.views.PortalContextIndexPage.render_portlet"> |
|
864 <code class="descname">render_portlet</code><span class="sig-paren">(</span><em>portlet_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.views.PortalContextIndexPage.render_portlet" title="Permalink to this definition">¶</a></dt> |
|
865 <dd></dd></dl> |
|
866 |
|
867 <dl class="attribute"> |
|
868 <dt id="pyams_portal.views.PortalContextIndexPage.template_configuration"> |
|
869 <code class="descname">template_configuration</code><a class="headerlink" href="#pyams_portal.views.PortalContextIndexPage.template_configuration" title="Permalink to this definition">¶</a></dt> |
|
870 <dd></dd></dl> |
|
871 |
|
872 </dd></dl> |
|
873 |
|
874 </div> |
|
875 <div class="section" id="module-pyams_portal"> |
|
876 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_portal" title="Permalink to this headline">¶</a></h2> |
|
877 <dl class="function"> |
|
878 <dt id="pyams_portal.includeme"> |
|
879 <code class="descclassname">pyams_portal.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_portal.includeme" title="Permalink to this definition">¶</a></dt> |
|
880 <dd><p>Pyramid include</p> |
|
881 </dd></dl> |
|
882 |
|
883 </div> |
|
884 </div> |
|
885 |
|
886 |
|
887 </div> |
|
888 </div> |
|
889 </div> |
|
890 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
891 <div class="sphinxsidebarwrapper"> |
|
892 <h3><a href="index.html">Table Of Contents</a></h3> |
|
893 <ul> |
|
894 <li><a class="reference internal" href="#">pyams_portal package</a><ul> |
|
895 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
896 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
897 <li><a class="reference internal" href="#module-pyams_portal.include">pyams_portal.include module</a></li> |
|
898 <li><a class="reference internal" href="#module-pyams_portal.page">pyams_portal.page module</a></li> |
|
899 <li><a class="reference internal" href="#module-pyams_portal.portlet">pyams_portal.portlet module</a></li> |
|
900 <li><a class="reference internal" href="#module-pyams_portal.site">pyams_portal.site module</a></li> |
|
901 <li><a class="reference internal" href="#module-pyams_portal.slot">pyams_portal.slot module</a></li> |
|
902 <li><a class="reference internal" href="#module-pyams_portal.template">pyams_portal.template module</a></li> |
|
903 <li><a class="reference internal" href="#module-pyams_portal.views">pyams_portal.views module</a></li> |
|
904 <li><a class="reference internal" href="#module-pyams_portal">Module contents</a></li> |
|
905 </ul> |
|
906 </li> |
|
907 </ul> |
|
908 |
|
909 <div id="searchbox" style="display: none" role="search"> |
|
910 <h3>Quick search</h3> |
|
911 <form class="search" action="search.html" method="get"> |
|
912 <div><input type="text" name="q" /></div> |
|
913 <div><input type="submit" value="Go" /></div> |
|
914 <input type="hidden" name="check_keywords" value="yes" /> |
|
915 <input type="hidden" name="area" value="default" /> |
|
916 </form> |
|
917 </div> |
|
918 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
919 </div> |
|
920 </div> |
|
921 <div class="clearer"></div> |
|
922 </div> |
|
923 <div class="related" role="navigation" aria-label="related navigation"> |
|
924 <h3>Navigation</h3> |
|
925 <ul> |
|
926 <li class="right" style="margin-right: 10px"> |
|
927 <a href="genindex.html" title="General Index" |
|
928 >index</a></li> |
|
929 <li class="right" > |
|
930 <a href="py-modindex.html" title="Python Module Index" |
|
931 >modules</a> |</li> |
|
932 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
933 </ul> |
|
934 </div> |
|
935 <div class="footer" role="contentinfo"> |
|
936 © Copyright 2017, Thierry Florac. |
|
937 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
938 </div> |
|
939 </body> |
|
940 </html> |