|
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.features.review 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-features-review-package"> |
|
54 <h1>pyams_content.features.review package<a class="headerlink" href="#pyams-content-features-review-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.features.review.zmi.html">pyams_content.features.review.zmi package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_content.features.review.zmi.html#module-pyams_content.features.review.zmi">Module contents</a></li> |
|
61 </ul> |
|
62 </li> |
|
63 </ul> |
|
64 </div> |
|
65 </div> |
|
66 <div class="section" id="submodules"> |
|
67 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
68 </div> |
|
69 <div class="section" id="module-pyams_content.features.review.interfaces"> |
|
70 <span id="pyams-content-features-review-interfaces-module"></span><h2>pyams_content.features.review.interfaces module<a class="headerlink" href="#module-pyams_content.features.review.interfaces" title="Permalink to this headline">¶</a></h2> |
|
71 <dl class="class"> |
|
72 <dt id="pyams_content.features.review.interfaces.CommentAddedEvent"> |
|
73 <em class="property">class </em><code class="descclassname">pyams_content.features.review.interfaces.</code><code class="descname">CommentAddedEvent</code><span class="sig-paren">(</span><em>object</em>, <em>comment</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.interfaces.CommentAddedEvent" title="Permalink to this definition">¶</a></dt> |
|
74 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.interface.interfaces.ObjectEvent</span></code></p> |
|
75 <p>Comment added event</p> |
|
76 </dd></dl> |
|
77 |
|
78 </div> |
|
79 <div class="section" id="module-pyams_content.features.review"> |
|
80 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.features.review" title="Permalink to this headline">¶</a></h2> |
|
81 <dl class="class"> |
|
82 <dt id="pyams_content.features.review.ContentReviewNotificationHandler"> |
|
83 <em class="property">class </em><code class="descclassname">pyams_content.features.review.</code><code class="descname">ContentReviewNotificationHandler</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.ContentReviewNotificationHandler" title="Permalink to this definition">¶</a></dt> |
|
84 <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> |
|
85 <p>Content review notification handler</p> |
|
86 <dl class="method"> |
|
87 <dt id="pyams_content.features.review.ContentReviewNotificationHandler.get_target"> |
|
88 <code class="descname">get_target</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.ContentReviewNotificationHandler.get_target" title="Permalink to this definition">¶</a></dt> |
|
89 <dd></dd></dl> |
|
90 |
|
91 </dd></dl> |
|
92 |
|
93 <dl class="class"> |
|
94 <dt id="pyams_content.features.review.ReviewComment"> |
|
95 <em class="property">class </em><code class="descclassname">pyams_content.features.review.</code><code class="descname">ReviewComment</code><span class="sig-paren">(</span><em>owner</em>, <em>comment</em>, <em>comment_type='comment'</em>, <em>reviewers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.ReviewComment" title="Permalink to this definition">¶</a></dt> |
|
96 <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> |
|
97 <p>Review comment persistent class</p> |
|
98 <dl class="attribute"> |
|
99 <dt id="pyams_content.features.review.ReviewComment.comment"> |
|
100 <code class="descname">comment</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.comment" title="Permalink to this definition">¶</a></dt> |
|
101 <dd><p>Computed attributes based on schema fields</p> |
|
102 <p>Field properties provide default values, data validation and error messages |
|
103 based on data found in field meta-data.</p> |
|
104 <p>Note that FieldProperties cannot be used with slots. They can only |
|
105 be used for attributes stored in instance dictionaries.</p> |
|
106 </dd></dl> |
|
107 |
|
108 <dl class="attribute"> |
|
109 <dt id="pyams_content.features.review.ReviewComment.comment_type"> |
|
110 <code class="descname">comment_type</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.comment_type" title="Permalink to this definition">¶</a></dt> |
|
111 <dd><p>Computed attributes based on schema fields</p> |
|
112 <p>Field properties provide default values, data validation and error messages |
|
113 based on data found in field meta-data.</p> |
|
114 <p>Note that FieldProperties cannot be used with slots. They can only |
|
115 be used for attributes stored in instance dictionaries.</p> |
|
116 </dd></dl> |
|
117 |
|
118 <dl class="attribute"> |
|
119 <dt id="pyams_content.features.review.ReviewComment.creation_date"> |
|
120 <code class="descname">creation_date</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.creation_date" title="Permalink to this definition">¶</a></dt> |
|
121 <dd><p>Computed attributes based on schema fields</p> |
|
122 <p>Field properties provide default values, data validation and error messages |
|
123 based on data found in field meta-data.</p> |
|
124 <p>Note that FieldProperties cannot be used with slots. They can only |
|
125 be used for attributes stored in instance dictionaries.</p> |
|
126 </dd></dl> |
|
127 |
|
128 <dl class="attribute"> |
|
129 <dt id="pyams_content.features.review.ReviewComment.is_reviewer_comment"> |
|
130 <code class="descname">is_reviewer_comment</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.is_reviewer_comment" title="Permalink to this definition">¶</a></dt> |
|
131 <dd><p>Computed attributes based on schema fields</p> |
|
132 <p>Field properties provide default values, data validation and error messages |
|
133 based on data found in field meta-data.</p> |
|
134 <p>Note that FieldProperties cannot be used with slots. They can only |
|
135 be used for attributes stored in instance dictionaries.</p> |
|
136 </dd></dl> |
|
137 |
|
138 <dl class="attribute"> |
|
139 <dt id="pyams_content.features.review.ReviewComment.owner"> |
|
140 <code class="descname">owner</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.owner" title="Permalink to this definition">¶</a></dt> |
|
141 <dd><p>Computed attributes based on schema fields</p> |
|
142 <p>Field properties provide default values, data validation and error messages |
|
143 based on data found in field meta-data.</p> |
|
144 <p>Note that FieldProperties cannot be used with slots. They can only |
|
145 be used for attributes stored in instance dictionaries.</p> |
|
146 </dd></dl> |
|
147 |
|
148 <dl class="attribute"> |
|
149 <dt id="pyams_content.features.review.ReviewComment.reviewers"> |
|
150 <code class="descname">reviewers</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.reviewers" title="Permalink to this definition">¶</a></dt> |
|
151 <dd><p>Computed attributes based on schema fields</p> |
|
152 <p>Field properties provide default values, data validation and error messages |
|
153 based on data found in field meta-data.</p> |
|
154 <p>Note that FieldProperties cannot be used with slots. They can only |
|
155 be used for attributes stored in instance dictionaries.</p> |
|
156 </dd></dl> |
|
157 |
|
158 </dd></dl> |
|
159 |
|
160 <dl class="class"> |
|
161 <dt id="pyams_content.features.review.ReviewCommentsContainer"> |
|
162 <em class="property">class </em><code class="descclassname">pyams_content.features.review.</code><code class="descname">ReviewCommentsContainer</code><a class="headerlink" href="#pyams_content.features.review.ReviewCommentsContainer" title="Permalink to this definition">¶</a></dt> |
|
163 <dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.container.BTreeOrderedContainer" title="pyams_utils.container.BTreeOrderedContainer"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.container.BTreeOrderedContainer</span></code></a></p> |
|
164 <p>Review comments container</p> |
|
165 <dl class="method"> |
|
166 <dt id="pyams_content.features.review.ReviewCommentsContainer.add_comment"> |
|
167 <code class="descname">add_comment</code><span class="sig-paren">(</span><em>comment</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.ReviewCommentsContainer.add_comment" title="Permalink to this definition">¶</a></dt> |
|
168 <dd></dd></dl> |
|
169 |
|
170 <dl class="method"> |
|
171 <dt id="pyams_content.features.review.ReviewCommentsContainer.clear"> |
|
172 <code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.ReviewCommentsContainer.clear" title="Permalink to this definition">¶</a></dt> |
|
173 <dd></dd></dl> |
|
174 |
|
175 <dl class="attribute"> |
|
176 <dt id="pyams_content.features.review.ReviewCommentsContainer.reviewers"> |
|
177 <code class="descname">reviewers</code><a class="headerlink" href="#pyams_content.features.review.ReviewCommentsContainer.reviewers" title="Permalink to this definition">¶</a></dt> |
|
178 <dd><p>Computed attributes based on schema fields</p> |
|
179 <p>Field properties provide default values, data validation and error messages |
|
180 based on data found in field meta-data.</p> |
|
181 <p>Note that FieldProperties cannot be used with slots. They can only |
|
182 be used for attributes stored in instance dictionaries.</p> |
|
183 </dd></dl> |
|
184 |
|
185 </dd></dl> |
|
186 |
|
187 <dl class="class"> |
|
188 <dt id="pyams_content.features.review.SharedContentReviewAdapter"> |
|
189 <em class="property">class </em><code class="descclassname">pyams_content.features.review.</code><code class="descname">SharedContentReviewAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.SharedContentReviewAdapter" title="Permalink to this definition">¶</a></dt> |
|
190 <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> |
|
191 <p>Shared content review adapter</p> |
|
192 <dl class="method"> |
|
193 <dt id="pyams_content.features.review.SharedContentReviewAdapter.ask_review"> |
|
194 <code class="descname">ask_review</code><span class="sig-paren">(</span><em>reviewers</em>, <em>comment</em>, <em>notify_all=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.SharedContentReviewAdapter.ask_review" title="Permalink to this definition">¶</a></dt> |
|
195 <dd><p>Ask for content review</p> |
|
196 </dd></dl> |
|
197 |
|
198 <dl class="attribute"> |
|
199 <dt id="pyams_content.features.review.SharedContentReviewAdapter.review_template"> |
|
200 <code class="descname">review_template</code><em class="property"> = <PageTemplateFile /home/tflorac/Dropbox/src/PyAMS/pyams_content/src/pyams_content/features/review/zmi/templates/review-notification.pt></em><a class="headerlink" href="#pyams_content.features.review.SharedContentReviewAdapter.review_template" title="Permalink to this definition">¶</a></dt> |
|
201 <dd></dd></dl> |
|
202 |
|
203 </dd></dl> |
|
204 |
|
205 <dl class="function"> |
|
206 <dt id="pyams_content.features.review.SharedContentReviewCommentsFactory"> |
|
207 <code class="descclassname">pyams_content.features.review.</code><code class="descname">SharedContentReviewCommentsFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.SharedContentReviewCommentsFactory" title="Permalink to this definition">¶</a></dt> |
|
208 <dd><p>Shared content review comments factory</p> |
|
209 </dd></dl> |
|
210 |
|
211 <dl class="class"> |
|
212 <dt id="pyams_content.features.review.SharedContentReviewCommentsNamespace"> |
|
213 <em class="property">class </em><code class="descclassname">pyams_content.features.review.</code><code class="descname">SharedContentReviewCommentsNamespace</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.SharedContentReviewCommentsNamespace" title="Permalink to this definition">¶</a></dt> |
|
214 <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> |
|
215 <p>++review-comments++ namespace traverser</p> |
|
216 <dl class="method"> |
|
217 <dt id="pyams_content.features.review.SharedContentReviewCommentsNamespace.traverse"> |
|
218 <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_content.features.review.SharedContentReviewCommentsNamespace.traverse" title="Permalink to this definition">¶</a></dt> |
|
219 <dd></dd></dl> |
|
220 |
|
221 </dd></dl> |
|
222 |
|
223 <dl class="class"> |
|
224 <dt id="pyams_content.features.review.SharedContentReviewCommentsSublocations"> |
|
225 <em class="property">class </em><code class="descclassname">pyams_content.features.review.</code><code class="descname">SharedContentReviewCommentsSublocations</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.SharedContentReviewCommentsSublocations" title="Permalink to this definition">¶</a></dt> |
|
226 <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> |
|
227 <p>Shared content review comments sub-location adapter</p> |
|
228 <dl class="method"> |
|
229 <dt id="pyams_content.features.review.SharedContentReviewCommentsSublocations.sublocations"> |
|
230 <code class="descname">sublocations</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.SharedContentReviewCommentsSublocations.sublocations" title="Permalink to this definition">¶</a></dt> |
|
231 <dd></dd></dl> |
|
232 |
|
233 </dd></dl> |
|
234 |
|
235 <dl class="function"> |
|
236 <dt id="pyams_content.features.review.handle_new_comment"> |
|
237 <code class="descclassname">pyams_content.features.review.</code><code class="descname">handle_new_comment</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.features.review.handle_new_comment" title="Permalink to this definition">¶</a></dt> |
|
238 <dd><p>Handle new review comment</p> |
|
239 </dd></dl> |
|
240 |
|
241 </div> |
|
242 </div> |
|
243 |
|
244 |
|
245 </div> |
|
246 </div> |
|
247 </div> |
|
248 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
249 <div class="sphinxsidebarwrapper"> |
|
250 <h3><a href="index.html">Table Of Contents</a></h3> |
|
251 <ul> |
|
252 <li><a class="reference internal" href="#">pyams_content.features.review package</a><ul> |
|
253 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
254 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
255 <li><a class="reference internal" href="#module-pyams_content.features.review.interfaces">pyams_content.features.review.interfaces module</a></li> |
|
256 <li><a class="reference internal" href="#module-pyams_content.features.review">Module contents</a></li> |
|
257 </ul> |
|
258 </li> |
|
259 </ul> |
|
260 |
|
261 <div id="searchbox" style="display: none" role="search"> |
|
262 <h3>Quick search</h3> |
|
263 <form class="search" action="search.html" method="get"> |
|
264 <div><input type="text" name="q" /></div> |
|
265 <div><input type="submit" value="Go" /></div> |
|
266 <input type="hidden" name="check_keywords" value="yes" /> |
|
267 <input type="hidden" name="area" value="default" /> |
|
268 </form> |
|
269 </div> |
|
270 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
271 </div> |
|
272 </div> |
|
273 <div class="clearer"></div> |
|
274 </div> |
|
275 <div class="related" role="navigation" aria-label="related navigation"> |
|
276 <h3>Navigation</h3> |
|
277 <ul> |
|
278 <li class="right" style="margin-right: 10px"> |
|
279 <a href="genindex.html" title="General Index" |
|
280 >index</a></li> |
|
281 <li class="right" > |
|
282 <a href="py-modindex.html" title="Python Module Index" |
|
283 >modules</a> |</li> |
|
284 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
285 </ul> |
|
286 </div> |
|
287 <div class="footer" role="contentinfo"> |
|
288 © Copyright 2017, Thierry Florac. |
|
289 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
290 </div> |
|
291 </body> |
|
292 </html> |