|
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.shared.site 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-shared-site-package"> |
|
54 <h1>pyams_content.shared.site package<a class="headerlink" href="#pyams-content-shared-site-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.shared.site.interfaces.html">pyams_content.shared.site.interfaces package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.site.interfaces.html#module-pyams_content.shared.site.interfaces">Module contents</a></li> |
|
61 </ul> |
|
62 </li> |
|
63 <li class="toctree-l1"><a class="reference internal" href="pyams_content.shared.site.zmi.html">pyams_content.shared.site.zmi package</a><ul> |
|
64 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.site.zmi.html#subpackages">Subpackages</a><ul> |
|
65 <li class="toctree-l3"><a class="reference internal" href="pyams_content.shared.site.zmi.widget.html">pyams_content.shared.site.zmi.widget package</a><ul> |
|
66 <li class="toctree-l4"><a class="reference internal" href="pyams_content.shared.site.zmi.widget.html#submodules">Submodules</a></li> |
|
67 <li class="toctree-l4"><a class="reference internal" href="pyams_content.shared.site.zmi.widget.html#module-pyams_content.shared.site.zmi.widget.interfaces">pyams_content.shared.site.zmi.widget.interfaces module</a></li> |
|
68 <li class="toctree-l4"><a class="reference internal" href="pyams_content.shared.site.zmi.widget.html#module-pyams_content.shared.site.zmi.widget">Module contents</a></li> |
|
69 </ul> |
|
70 </li> |
|
71 </ul> |
|
72 </li> |
|
73 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.site.zmi.html#submodules">Submodules</a></li> |
|
74 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.site.zmi.html#module-pyams_content.shared.site.zmi.container">pyams_content.shared.site.zmi.container module</a></li> |
|
75 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.site.zmi.html#module-pyams_content.shared.site.zmi.folder">pyams_content.shared.site.zmi.folder module</a></li> |
|
76 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.site.zmi.html#module-pyams_content.shared.site.zmi.link">pyams_content.shared.site.zmi.link module</a></li> |
|
77 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.site.zmi.html#module-pyams_content.shared.site.zmi.manager">pyams_content.shared.site.zmi.manager module</a></li> |
|
78 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.site.zmi.html#module-pyams_content.shared.site.zmi">Module contents</a></li> |
|
79 </ul> |
|
80 </li> |
|
81 </ul> |
|
82 </div> |
|
83 </div> |
|
84 <div class="section" id="submodules"> |
|
85 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
86 </div> |
|
87 <div class="section" id="module-pyams_content.shared.site.container"> |
|
88 <span id="pyams-content-shared-site-container-module"></span><h2>pyams_content.shared.site.container module<a class="headerlink" href="#module-pyams_content.shared.site.container" title="Permalink to this headline">¶</a></h2> |
|
89 <dl class="class"> |
|
90 <dt id="pyams_content.shared.site.container.SiteContainerMixin"> |
|
91 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.container.</code><code class="descname">SiteContainerMixin</code><a class="headerlink" href="#pyams_content.shared.site.container.SiteContainerMixin" title="Permalink to this definition">¶</a></dt> |
|
92 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
93 <p>Site container mixin class</p> |
|
94 <dl class="method"> |
|
95 <dt id="pyams_content.shared.site.container.SiteContainerMixin.get_folders_tree"> |
|
96 <code class="descname">get_folders_tree</code><span class="sig-paren">(</span><em>selected=None</em>, <em>permission=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.container.SiteContainerMixin.get_folders_tree" title="Permalink to this definition">¶</a></dt> |
|
97 <dd></dd></dl> |
|
98 |
|
99 </dd></dl> |
|
100 |
|
101 </div> |
|
102 <div class="section" id="module-pyams_content.shared.site.folder"> |
|
103 <span id="pyams-content-shared-site-folder-module"></span><h2>pyams_content.shared.site.folder module<a class="headerlink" href="#module-pyams_content.shared.site.folder" title="Permalink to this headline">¶</a></h2> |
|
104 <dl class="class"> |
|
105 <dt id="pyams_content.shared.site.folder.SiteFolder"> |
|
106 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.folder.</code><code class="descname">SiteFolder</code><a class="headerlink" href="#pyams_content.shared.site.folder.SiteFolder" title="Permalink to this definition">¶</a></dt> |
|
107 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.site.container.SiteContainerMixin" title="pyams_content.shared.site.container.SiteContainerMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.site.container.SiteContainerMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.ordered.OrderedContainer</span></code>, <a class="reference internal" href="pyams_content.shared.common.html#pyams_content.shared.common.manager.BaseSharedTool" title="pyams_content.shared.common.manager.BaseSharedTool"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.manager.BaseSharedTool</span></code></a></p> |
|
108 <p>Site folder persistent class</p> |
|
109 <dl class="method"> |
|
110 <dt id="pyams_content.shared.site.folder.SiteFolder.is_deletable"> |
|
111 <code class="descname">is_deletable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.folder.SiteFolder.is_deletable" title="Permalink to this definition">¶</a></dt> |
|
112 <dd></dd></dl> |
|
113 |
|
114 <dl class="attribute"> |
|
115 <dt id="pyams_content.shared.site.folder.SiteFolder.notepad"> |
|
116 <code class="descname">notepad</code><a class="headerlink" href="#pyams_content.shared.site.folder.SiteFolder.notepad" title="Permalink to this definition">¶</a></dt> |
|
117 <dd><p>Computed attributes based on schema fields</p> |
|
118 <p>Field properties provide default values, data validation and error messages |
|
119 based on data found in field meta-data.</p> |
|
120 <p>Note that FieldProperties cannot be used with slots. They can only |
|
121 be used for attributes stored in instance dictionaries.</p> |
|
122 </dd></dl> |
|
123 |
|
124 <dl class="attribute"> |
|
125 <dt id="pyams_content.shared.site.folder.SiteFolder.roles_interface"> |
|
126 <code class="descname">roles_interface</code><em class="property"> = <InterfaceClass pyams_content.shared.site.interfaces.ISiteFolderRoles></em><a class="headerlink" href="#pyams_content.shared.site.folder.SiteFolder.roles_interface" title="Permalink to this definition">¶</a></dt> |
|
127 <dd></dd></dl> |
|
128 |
|
129 <dl class="attribute"> |
|
130 <dt id="pyams_content.shared.site.folder.SiteFolder.sequence_name"> |
|
131 <code class="descname">sequence_name</code><em class="property"> = ''</em><a class="headerlink" href="#pyams_content.shared.site.folder.SiteFolder.sequence_name" title="Permalink to this definition">¶</a></dt> |
|
132 <dd></dd></dl> |
|
133 |
|
134 <dl class="attribute"> |
|
135 <dt id="pyams_content.shared.site.folder.SiteFolder.sequence_prefix"> |
|
136 <code class="descname">sequence_prefix</code><em class="property"> = ''</em><a class="headerlink" href="#pyams_content.shared.site.folder.SiteFolder.sequence_prefix" title="Permalink to this definition">¶</a></dt> |
|
137 <dd></dd></dl> |
|
138 |
|
139 </dd></dl> |
|
140 |
|
141 <dl class="class"> |
|
142 <dt id="pyams_content.shared.site.folder.SiteFolderPermissionChecker"> |
|
143 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.folder.</code><code class="descname">SiteFolderPermissionChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.folder.SiteFolderPermissionChecker" title="Permalink to this definition">¶</a></dt> |
|
144 <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> |
|
145 <p>Site folder edit permission checker</p> |
|
146 <dl class="attribute"> |
|
147 <dt id="pyams_content.shared.site.folder.SiteFolderPermissionChecker.edit_permission"> |
|
148 <code class="descname">edit_permission</code><em class="property"> = 'pyams.ManageSite'</em><a class="headerlink" href="#pyams_content.shared.site.folder.SiteFolderPermissionChecker.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
149 <dd></dd></dl> |
|
150 |
|
151 </dd></dl> |
|
152 |
|
153 <dl class="class"> |
|
154 <dt id="pyams_content.shared.site.folder.SiteManagerFoldersVocabulary"> |
|
155 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.folder.</code><code class="descname">SiteManagerFoldersVocabulary</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.folder.SiteManagerFoldersVocabulary" title="Permalink to this definition">¶</a></dt> |
|
156 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
157 <p>Site manager folders vocabulary</p> |
|
158 </dd></dl> |
|
159 |
|
160 </div> |
|
161 <div class="section" id="module-pyams_content.shared.site.link"> |
|
162 <span id="pyams-content-shared-site-link-module"></span><h2>pyams_content.shared.site.link module<a class="headerlink" href="#module-pyams_content.shared.site.link" title="Permalink to this headline">¶</a></h2> |
|
163 <dl class="class"> |
|
164 <dt id="pyams_content.shared.site.link.ContentLink"> |
|
165 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.link.</code><code class="descname">ContentLink</code><a class="headerlink" href="#pyams_content.shared.site.link.ContentLink" title="Permalink to this definition">¶</a></dt> |
|
166 <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> |
|
167 <p>Content link persistent class</p> |
|
168 <p>A ‘content link’ is a link to another content, which may be stored anywhere (same site, |
|
169 another site or in any shared tool).</p> |
|
170 <dl class="attribute"> |
|
171 <dt id="pyams_content.shared.site.link.ContentLink.alt_title"> |
|
172 <code class="descname">alt_title</code><a class="headerlink" href="#pyams_content.shared.site.link.ContentLink.alt_title" title="Permalink to this definition">¶</a></dt> |
|
173 <dd><p>Computed attributes based on schema fields</p> |
|
174 <p>Field properties provide default values, data validation and error messages |
|
175 based on data found in field meta-data.</p> |
|
176 <p>Note that FieldProperties cannot be used with slots. They can only |
|
177 be used for attributes stored in instance dictionaries.</p> |
|
178 </dd></dl> |
|
179 |
|
180 <dl class="method"> |
|
181 <dt id="pyams_content.shared.site.link.ContentLink.get_target"> |
|
182 <code class="descname">get_target</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.link.ContentLink.get_target" title="Permalink to this definition">¶</a></dt> |
|
183 <dd></dd></dl> |
|
184 |
|
185 <dl class="method"> |
|
186 <dt id="pyams_content.shared.site.link.ContentLink.is_deletable"> |
|
187 <code class="descname">is_deletable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.link.ContentLink.is_deletable" title="Permalink to this definition">¶</a></dt> |
|
188 <dd></dd></dl> |
|
189 |
|
190 <dl class="attribute"> |
|
191 <dt id="pyams_content.shared.site.link.ContentLink.reference"> |
|
192 <code class="descname">reference</code><a class="headerlink" href="#pyams_content.shared.site.link.ContentLink.reference" title="Permalink to this definition">¶</a></dt> |
|
193 <dd><p>Computed attributes based on schema fields</p> |
|
194 <p>Field properties provide default values, data validation and error messages |
|
195 based on data found in field meta-data.</p> |
|
196 <p>Note that FieldProperties cannot be used with slots. They can only |
|
197 be used for attributes stored in instance dictionaries.</p> |
|
198 </dd></dl> |
|
199 |
|
200 <dl class="attribute"> |
|
201 <dt id="pyams_content.shared.site.link.ContentLink.visible"> |
|
202 <code class="descname">visible</code><a class="headerlink" href="#pyams_content.shared.site.link.ContentLink.visible" title="Permalink to this definition">¶</a></dt> |
|
203 <dd><p>Computed attributes based on schema fields</p> |
|
204 <p>Field properties provide default values, data validation and error messages |
|
205 based on data found in field meta-data.</p> |
|
206 <p>Note that FieldProperties cannot be used with slots. They can only |
|
207 be used for attributes stored in instance dictionaries.</p> |
|
208 </dd></dl> |
|
209 |
|
210 </dd></dl> |
|
211 |
|
212 <dl class="function"> |
|
213 <dt id="pyams_content.shared.site.link.content_link_publication_info"> |
|
214 <code class="descclassname">pyams_content.shared.site.link.</code><code class="descname">content_link_publication_info</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.link.content_link_publication_info" title="Permalink to this definition">¶</a></dt> |
|
215 <dd><p>Content link publication info</p> |
|
216 </dd></dl> |
|
217 |
|
218 <dl class="function"> |
|
219 <dt id="pyams_content.shared.site.link.content_link_sequence_info"> |
|
220 <code class="descclassname">pyams_content.shared.site.link.</code><code class="descname">content_link_sequence_info</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.link.content_link_sequence_info" title="Permalink to this definition">¶</a></dt> |
|
221 <dd></dd></dl> |
|
222 |
|
223 <dl class="function"> |
|
224 <dt id="pyams_content.shared.site.link.content_link_state_info"> |
|
225 <code class="descclassname">pyams_content.shared.site.link.</code><code class="descname">content_link_state_info</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.link.content_link_state_info" title="Permalink to this definition">¶</a></dt> |
|
226 <dd><p>Content link workflow state info</p> |
|
227 </dd></dl> |
|
228 |
|
229 <dl class="function"> |
|
230 <dt id="pyams_content.shared.site.link.content_link_workflow_info"> |
|
231 <code class="descclassname">pyams_content.shared.site.link.</code><code class="descname">content_link_workflow_info</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.link.content_link_workflow_info" title="Permalink to this definition">¶</a></dt> |
|
232 <dd><p>Content link workflow info</p> |
|
233 </dd></dl> |
|
234 |
|
235 </div> |
|
236 <div class="section" id="module-pyams_content.shared.site.manager"> |
|
237 <span id="pyams-content-shared-site-manager-module"></span><h2>pyams_content.shared.site.manager module<a class="headerlink" href="#module-pyams_content.shared.site.manager" title="Permalink to this headline">¶</a></h2> |
|
238 <dl class="class"> |
|
239 <dt id="pyams_content.shared.site.manager.SiteManager"> |
|
240 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.manager.</code><code class="descname">SiteManager</code><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManager" title="Permalink to this definition">¶</a></dt> |
|
241 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.site.container.SiteContainerMixin" title="pyams_content.shared.site.container.SiteContainerMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.site.container.SiteContainerMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.ordered.OrderedContainer</span></code>, <a class="reference internal" href="pyams_content.shared.common.html#pyams_content.shared.common.manager.BaseSharedTool" title="pyams_content.shared.common.manager.BaseSharedTool"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.manager.BaseSharedTool</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> |
|
242 <p>Site manager persistent class</p> |
|
243 <dl class="attribute"> |
|
244 <dt id="pyams_content.shared.site.manager.SiteManager.allowed_paragraphs"> |
|
245 <code class="descname">allowed_paragraphs</code><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManager.allowed_paragraphs" title="Permalink to this definition">¶</a></dt> |
|
246 <dd><p>Computed attributes based on schema fields</p> |
|
247 <p>Field properties provide default values, data validation and error messages |
|
248 based on data found in field meta-data.</p> |
|
249 <p>Note that FieldProperties cannot be used with slots. They can only |
|
250 be used for attributes stored in instance dictionaries.</p> |
|
251 </dd></dl> |
|
252 |
|
253 <dl class="attribute"> |
|
254 <dt id="pyams_content.shared.site.manager.SiteManager.auto_created_paragraphs"> |
|
255 <code class="descname">auto_created_paragraphs</code><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManager.auto_created_paragraphs" title="Permalink to this definition">¶</a></dt> |
|
256 <dd><p>Computed attributes based on schema fields</p> |
|
257 <p>Field properties provide default values, data validation and error messages |
|
258 based on data found in field meta-data.</p> |
|
259 <p>Note that FieldProperties cannot be used with slots. They can only |
|
260 be used for attributes stored in instance dictionaries.</p> |
|
261 </dd></dl> |
|
262 |
|
263 <dl class="attribute"> |
|
264 <dt id="pyams_content.shared.site.manager.SiteManager.folder_factory"> |
|
265 <code class="descname">folder_factory</code><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManager.folder_factory" title="Permalink to this definition">¶</a></dt> |
|
266 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">SiteFolder</span></code></p> |
|
267 </dd></dl> |
|
268 |
|
269 <dl class="method"> |
|
270 <dt id="pyams_content.shared.site.manager.SiteManager.is_deletable"> |
|
271 <code class="descname">is_deletable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManager.is_deletable" title="Permalink to this definition">¶</a></dt> |
|
272 <dd></dd></dl> |
|
273 |
|
274 <dl class="attribute"> |
|
275 <dt id="pyams_content.shared.site.manager.SiteManager.sequence_name"> |
|
276 <code class="descname">sequence_name</code><em class="property"> = ''</em><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManager.sequence_name" title="Permalink to this definition">¶</a></dt> |
|
277 <dd></dd></dl> |
|
278 |
|
279 <dl class="attribute"> |
|
280 <dt id="pyams_content.shared.site.manager.SiteManager.sequence_prefix"> |
|
281 <code class="descname">sequence_prefix</code><em class="property"> = ''</em><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManager.sequence_prefix" title="Permalink to this definition">¶</a></dt> |
|
282 <dd></dd></dl> |
|
283 |
|
284 <dl class="attribute"> |
|
285 <dt id="pyams_content.shared.site.manager.SiteManager.topic_content_factory"> |
|
286 <code class="descname">topic_content_factory</code><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManager.topic_content_factory" title="Permalink to this definition">¶</a></dt> |
|
287 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">Topic</span></code></p> |
|
288 </dd></dl> |
|
289 |
|
290 <dl class="attribute"> |
|
291 <dt id="pyams_content.shared.site.manager.SiteManager.topic_content_type"> |
|
292 <code class="descname">topic_content_type</code><em class="property"> = 'topic'</em><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManager.topic_content_type" title="Permalink to this definition">¶</a></dt> |
|
293 <dd></dd></dl> |
|
294 |
|
295 </dd></dl> |
|
296 |
|
297 <dl class="class"> |
|
298 <dt id="pyams_content.shared.site.manager.SiteManagerPermissionChecker"> |
|
299 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.manager.</code><code class="descname">SiteManagerPermissionChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManagerPermissionChecker" title="Permalink to this definition">¶</a></dt> |
|
300 <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> |
|
301 <p>Site manager edit permission checker</p> |
|
302 <dl class="attribute"> |
|
303 <dt id="pyams_content.shared.site.manager.SiteManagerPermissionChecker.edit_permission"> |
|
304 <code class="descname">edit_permission</code><em class="property"> = 'pyams.ManageSite'</em><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManagerPermissionChecker.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
305 <dd></dd></dl> |
|
306 |
|
307 </dd></dl> |
|
308 |
|
309 <dl class="class"> |
|
310 <dt id="pyams_content.shared.site.manager.SiteManagerVocabulary"> |
|
311 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.manager.</code><code class="descname">SiteManagerVocabulary</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManagerVocabulary" title="Permalink to this definition">¶</a></dt> |
|
312 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
313 <p>Site manager vocabulary</p> |
|
314 <dl class="attribute"> |
|
315 <dt id="pyams_content.shared.site.manager.SiteManagerVocabulary.interface"> |
|
316 <code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_content.shared.site.interfaces.ISiteManager></em><a class="headerlink" href="#pyams_content.shared.site.manager.SiteManagerVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
317 <dd></dd></dl> |
|
318 |
|
319 </dd></dl> |
|
320 |
|
321 <dl class="function"> |
|
322 <dt id="pyams_content.shared.site.manager.handle_added_site_manager"> |
|
323 <code class="descclassname">pyams_content.shared.site.manager.</code><code class="descname">handle_added_site_manager</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.manager.handle_added_site_manager" title="Permalink to this definition">¶</a></dt> |
|
324 <dd><p>Register site manager when added</p> |
|
325 </dd></dl> |
|
326 |
|
327 <dl class="function"> |
|
328 <dt id="pyams_content.shared.site.manager.handle_deleted_site_manager"> |
|
329 <code class="descclassname">pyams_content.shared.site.manager.</code><code class="descname">handle_deleted_site_manager</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.manager.handle_deleted_site_manager" title="Permalink to this definition">¶</a></dt> |
|
330 <dd><p>Un-register site manager when deleted</p> |
|
331 </dd></dl> |
|
332 |
|
333 </div> |
|
334 <div class="section" id="module-pyams_content.shared.site"> |
|
335 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.shared.site" title="Permalink to this headline">¶</a></h2> |
|
336 <dl class="class"> |
|
337 <dt id="pyams_content.shared.site.Topic"> |
|
338 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.</code><code class="descname">Topic</code><a class="headerlink" href="#pyams_content.shared.site.Topic" title="Permalink to this definition">¶</a></dt> |
|
339 <dd><p>Bases: <a class="reference internal" href="pyams_content.shared.common.html#pyams_content.shared.common.SharedContent" title="pyams_content.shared.common.SharedContent"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.SharedContent</span></code></a></p> |
|
340 <p>WOrkflow managed topic class</p> |
|
341 <dl class="attribute"> |
|
342 <dt id="pyams_content.shared.site.Topic.content_class"> |
|
343 <code class="descname">content_class</code><a class="headerlink" href="#pyams_content.shared.site.Topic.content_class" title="Permalink to this definition">¶</a></dt> |
|
344 <dd><p>alias of <a class="reference internal" href="#pyams_content.shared.site.WfTopic" title="pyams_content.shared.site.WfTopic"><code class="xref py py-class docutils literal"><span class="pre">WfTopic</span></code></a></p> |
|
345 </dd></dl> |
|
346 |
|
347 <dl class="method"> |
|
348 <dt id="pyams_content.shared.site.Topic.is_deletable"> |
|
349 <code class="descname">is_deletable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.site.Topic.is_deletable" title="Permalink to this definition">¶</a></dt> |
|
350 <dd></dd></dl> |
|
351 |
|
352 </dd></dl> |
|
353 |
|
354 <dl class="class"> |
|
355 <dt id="pyams_content.shared.site.WfTopic"> |
|
356 <em class="property">class </em><code class="descclassname">pyams_content.shared.site.</code><code class="descname">WfTopic</code><a class="headerlink" href="#pyams_content.shared.site.WfTopic" title="Permalink to this definition">¶</a></dt> |
|
357 <dd><p>Bases: <a class="reference internal" href="pyams_content.shared.common.html#pyams_content.shared.common.WfSharedContent" title="pyams_content.shared.common.WfSharedContent"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.WfSharedContent</span></code></a></p> |
|
358 <p>Base topic</p> |
|
359 <dl class="attribute"> |
|
360 <dt id="pyams_content.shared.site.WfTopic.content_name"> |
|
361 <code class="descname">content_name</code><em class="property"> = 'Topic'</em><a class="headerlink" href="#pyams_content.shared.site.WfTopic.content_name" title="Permalink to this definition">¶</a></dt> |
|
362 <dd></dd></dl> |
|
363 |
|
364 <dl class="attribute"> |
|
365 <dt id="pyams_content.shared.site.WfTopic.content_type"> |
|
366 <code class="descname">content_type</code><em class="property"> = 'topic'</em><a class="headerlink" href="#pyams_content.shared.site.WfTopic.content_type" title="Permalink to this definition">¶</a></dt> |
|
367 <dd></dd></dl> |
|
368 |
|
369 </dd></dl> |
|
370 |
|
371 </div> |
|
372 </div> |
|
373 |
|
374 |
|
375 </div> |
|
376 </div> |
|
377 </div> |
|
378 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
379 <div class="sphinxsidebarwrapper"> |
|
380 <h3><a href="index.html">Table Of Contents</a></h3> |
|
381 <ul> |
|
382 <li><a class="reference internal" href="#">pyams_content.shared.site package</a><ul> |
|
383 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
384 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
385 <li><a class="reference internal" href="#module-pyams_content.shared.site.container">pyams_content.shared.site.container module</a></li> |
|
386 <li><a class="reference internal" href="#module-pyams_content.shared.site.folder">pyams_content.shared.site.folder module</a></li> |
|
387 <li><a class="reference internal" href="#module-pyams_content.shared.site.link">pyams_content.shared.site.link module</a></li> |
|
388 <li><a class="reference internal" href="#module-pyams_content.shared.site.manager">pyams_content.shared.site.manager module</a></li> |
|
389 <li><a class="reference internal" href="#module-pyams_content.shared.site">Module contents</a></li> |
|
390 </ul> |
|
391 </li> |
|
392 </ul> |
|
393 |
|
394 <div id="searchbox" style="display: none" role="search"> |
|
395 <h3>Quick search</h3> |
|
396 <form class="search" action="search.html" method="get"> |
|
397 <div><input type="text" name="q" /></div> |
|
398 <div><input type="submit" value="Go" /></div> |
|
399 <input type="hidden" name="check_keywords" value="yes" /> |
|
400 <input type="hidden" name="area" value="default" /> |
|
401 </form> |
|
402 </div> |
|
403 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
404 </div> |
|
405 </div> |
|
406 <div class="clearer"></div> |
|
407 </div> |
|
408 <div class="related" role="navigation" aria-label="related navigation"> |
|
409 <h3>Navigation</h3> |
|
410 <ul> |
|
411 <li class="right" style="margin-right: 10px"> |
|
412 <a href="genindex.html" title="General Index" |
|
413 >index</a></li> |
|
414 <li class="right" > |
|
415 <a href="py-modindex.html" title="Python Module Index" |
|
416 >modules</a> |</li> |
|
417 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
418 </ul> |
|
419 </div> |
|
420 <div class="footer" role="contentinfo"> |
|
421 © Copyright 2017, Thierry Florac. |
|
422 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
423 </div> |
|
424 </body> |
|
425 </html> |