src/build/html/pyams_content.features.review.html
changeset 0 d153941bb745
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_content.features.review.html	Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,292 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>pyams_content.features.review package &#8212; PyAMS User Guide 0.1.0 documentation</title>
+    <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '0.1.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
+<!--[if lte IE 6]>
+<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
+<![endif]-->
+
+  </head>
+  <body>
+
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="pyams-content-features-review-package">
+<h1>pyams_content.features.review package<a class="headerlink" href="#pyams-content-features-review-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="pyams_content.features.review.zmi.html">pyams_content.features.review.zmi package</a><ul>
+<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>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="module-pyams_content.features.review.interfaces">
+<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>
+<dl class="class">
+<dt id="pyams_content.features.review.interfaces.CommentAddedEvent">
+<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>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.interface.interfaces.ObjectEvent</span></code></p>
+<p>Comment added event</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_content.features.review">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.features.review" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_content.features.review.ContentReviewNotificationHandler">
+<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>
+<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>
+<p>Content review notification handler</p>
+<dl class="method">
+<dt id="pyams_content.features.review.ContentReviewNotificationHandler.get_target">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content.features.review.ReviewComment">
+<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>
+<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>
+<p>Review comment persistent class</p>
+<dl class="attribute">
+<dt id="pyams_content.features.review.ReviewComment.comment">
+<code class="descname">comment</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.comment" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content.features.review.ReviewComment.comment_type">
+<code class="descname">comment_type</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.comment_type" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content.features.review.ReviewComment.creation_date">
+<code class="descname">creation_date</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.creation_date" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content.features.review.ReviewComment.is_reviewer_comment">
+<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>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content.features.review.ReviewComment.owner">
+<code class="descname">owner</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.owner" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content.features.review.ReviewComment.reviewers">
+<code class="descname">reviewers</code><a class="headerlink" href="#pyams_content.features.review.ReviewComment.reviewers" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content.features.review.ReviewCommentsContainer">
+<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>
+<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>
+<p>Review comments container</p>
+<dl class="method">
+<dt id="pyams_content.features.review.ReviewCommentsContainer.add_comment">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_content.features.review.ReviewCommentsContainer.clear">
+<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>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content.features.review.ReviewCommentsContainer.reviewers">
+<code class="descname">reviewers</code><a class="headerlink" href="#pyams_content.features.review.ReviewCommentsContainer.reviewers" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content.features.review.SharedContentReviewAdapter">
+<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>
+<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>
+<p>Shared content review adapter</p>
+<dl class="method">
+<dt id="pyams_content.features.review.SharedContentReviewAdapter.ask_review">
+<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>
+<dd><p>Ask for content review</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content.features.review.SharedContentReviewAdapter.review_template">
+<code class="descname">review_template</code><em class="property"> = &lt;PageTemplateFile /home/tflorac/Dropbox/src/PyAMS/pyams_content/src/pyams_content/features/review/zmi/templates/review-notification.pt&gt;</em><a class="headerlink" href="#pyams_content.features.review.SharedContentReviewAdapter.review_template" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.features.review.SharedContentReviewCommentsFactory">
+<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>
+<dd><p>Shared content review comments factory</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content.features.review.SharedContentReviewCommentsNamespace">
+<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>
+<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>
+<p>++review-comments++ namespace traverser</p>
+<dl class="method">
+<dt id="pyams_content.features.review.SharedContentReviewCommentsNamespace.traverse">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content.features.review.SharedContentReviewCommentsSublocations">
+<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>
+<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>
+<p>Shared content review comments sub-location adapter</p>
+<dl class="method">
+<dt id="pyams_content.features.review.SharedContentReviewCommentsSublocations.sublocations">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.features.review.handle_new_comment">
+<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>
+<dd><p>Handle new review comment</p>
+</dd></dl>
+
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">pyams_content.features.review package</a><ul>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-pyams_content.features.review.interfaces">pyams_content.features.review.interfaces module</a></li>
+<li><a class="reference internal" href="#module-pyams_content.features.review">Module contents</a></li>
+</ul>
+</li>
+</ul>
+
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2017, Thierry Florac.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
+    </div>
+  </body>
+</html>
\ No newline at end of file