|
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.interfaces 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-interfaces-package"> |
|
54 <h1>pyams_content.interfaces package<a class="headerlink" href="#pyams-content-interfaces-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="submodules"> |
|
56 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
57 </div> |
|
58 <div class="section" id="module-pyams_content.interfaces.container"> |
|
59 <span id="pyams-content-interfaces-container-module"></span><h2>pyams_content.interfaces.container module<a class="headerlink" href="#module-pyams_content.interfaces.container" title="Permalink to this headline">¶</a></h2> |
|
60 </div> |
|
61 <div class="section" id="module-pyams_content.interfaces"> |
|
62 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.interfaces" title="Permalink to this headline">¶</a></h2> |
|
63 <dl class="data"> |
|
64 <dt id="pyams_content.interfaces.COMMENT_CONTENT_PERMISSION"> |
|
65 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">COMMENT_CONTENT_PERMISSION</code><em class="property"> = 'pyams.CommentContent'</em><a class="headerlink" href="#pyams_content.interfaces.COMMENT_CONTENT_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
66 <dd><p>Permission required to add comments on an existing content</p> |
|
67 </dd></dl> |
|
68 |
|
69 <dl class="data"> |
|
70 <dt id="pyams_content.interfaces.CONTRIBUTOR_ROLE"> |
|
71 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">CONTRIBUTOR_ROLE</code><em class="property"> = 'pyams.Contributor'</em><a class="headerlink" href="#pyams_content.interfaces.CONTRIBUTOR_ROLE" title="Permalink to this definition">¶</a></dt> |
|
72 <dd><p>Contributor role is allowed to create new contents</p> |
|
73 </dd></dl> |
|
74 |
|
75 <dl class="data"> |
|
76 <dt id="pyams_content.interfaces.CREATE_CONTENT_PERMISSION"> |
|
77 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">CREATE_CONTENT_PERMISSION</code><em class="property"> = 'pyams.CreateContent'</em><a class="headerlink" href="#pyams_content.interfaces.CREATE_CONTENT_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
78 <dd><p>Permission required to create a new content</p> |
|
79 </dd></dl> |
|
80 |
|
81 <dl class="data"> |
|
82 <dt id="pyams_content.interfaces.CREATE_VERSION_PERMISSION"> |
|
83 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">CREATE_VERSION_PERMISSION</code><em class="property"> = 'pyams.CreateVersion'</em><a class="headerlink" href="#pyams_content.interfaces.CREATE_VERSION_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
84 <dd><p>Permission required to create a new version of an existing content</p> |
|
85 </dd></dl> |
|
86 |
|
87 <dl class="data"> |
|
88 <dt id="pyams_content.interfaces.GUEST_ROLE"> |
|
89 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">GUEST_ROLE</code><em class="property"> = 'pyams.Guest'</em><a class="headerlink" href="#pyams_content.interfaces.GUEST_ROLE" title="Permalink to this definition">¶</a></dt> |
|
90 <dd><p>Guest role is allowed to view contents</p> |
|
91 </dd></dl> |
|
92 |
|
93 <dl class="data"> |
|
94 <dt id="pyams_content.interfaces.MANAGER_ROLE"> |
|
95 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">MANAGER_ROLE</code><em class="property"> = 'pyams.Manager'</em><a class="headerlink" href="#pyams_content.interfaces.MANAGER_ROLE" title="Permalink to this definition">¶</a></dt> |
|
96 <dd><p>Manager role is allowed to manage contents workflow</p> |
|
97 </dd></dl> |
|
98 |
|
99 <dl class="data"> |
|
100 <dt id="pyams_content.interfaces.MANAGE_CONTENT_PERMISSION"> |
|
101 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">MANAGE_CONTENT_PERMISSION</code><em class="property"> = 'pyams.ManageContent'</em><a class="headerlink" href="#pyams_content.interfaces.MANAGE_CONTENT_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
102 <dd><p>Permission required to manager properties of an existing content</p> |
|
103 </dd></dl> |
|
104 |
|
105 <dl class="data"> |
|
106 <dt id="pyams_content.interfaces.MANAGE_SITE_PERMISSION"> |
|
107 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">MANAGE_SITE_PERMISSION</code><em class="property"> = 'pyams.ManageSite'</em><a class="headerlink" href="#pyams_content.interfaces.MANAGE_SITE_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
108 <dd><p>Permission required to manager inner site or blog properties</p> |
|
109 </dd></dl> |
|
110 |
|
111 <dl class="data"> |
|
112 <dt id="pyams_content.interfaces.MANAGE_SITE_ROOT_PERMISSION"> |
|
113 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">MANAGE_SITE_ROOT_PERMISSION</code><em class="property"> = 'pyams.ManageSiteRoot'</em><a class="headerlink" href="#pyams_content.interfaces.MANAGE_SITE_ROOT_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
114 <dd><p>Permission required to manage main site root properties</p> |
|
115 </dd></dl> |
|
116 |
|
117 <dl class="data"> |
|
118 <dt id="pyams_content.interfaces.MANAGE_TOOL_PERMISSION"> |
|
119 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">MANAGE_TOOL_PERMISSION</code><em class="property"> = 'pyams.ManageTool'</em><a class="headerlink" href="#pyams_content.interfaces.MANAGE_TOOL_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
120 <dd><p>Permission required to manager shared tool properties</p> |
|
121 </dd></dl> |
|
122 |
|
123 <dl class="data"> |
|
124 <dt id="pyams_content.interfaces.OPERATOR_ROLE"> |
|
125 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">OPERATOR_ROLE</code><em class="property"> = 'pyams.Operator'</em><a class="headerlink" href="#pyams_content.interfaces.OPERATOR_ROLE" title="Permalink to this definition">¶</a></dt> |
|
126 <dd><p>Operator role is allowed to access management interface</p> |
|
127 </dd></dl> |
|
128 |
|
129 <dl class="data"> |
|
130 <dt id="pyams_content.interfaces.OWNER_ROLE"> |
|
131 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">OWNER_ROLE</code><em class="property"> = 'pyams.Owner'</em><a class="headerlink" href="#pyams_content.interfaces.OWNER_ROLE" title="Permalink to this definition">¶</a></dt> |
|
132 <dd><p>Content owner role is allowed to manage content properties until publication</p> |
|
133 </dd></dl> |
|
134 |
|
135 <dl class="data"> |
|
136 <dt id="pyams_content.interfaces.PILOT_ROLE"> |
|
137 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">PILOT_ROLE</code><em class="property"> = 'pyams.Pilot'</em><a class="headerlink" href="#pyams_content.interfaces.PILOT_ROLE" title="Permalink to this definition">¶</a></dt> |
|
138 <dd><p>Pilot role is allowed to manage tools configuration and permissions</p> |
|
139 </dd></dl> |
|
140 |
|
141 <dl class="data"> |
|
142 <dt id="pyams_content.interfaces.PUBLISH_CONTENT_PERMISSION"> |
|
143 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">PUBLISH_CONTENT_PERMISSION</code><em class="property"> = 'pyams.PublishContent'</em><a class="headerlink" href="#pyams_content.interfaces.PUBLISH_CONTENT_PERMISSION" title="Permalink to this definition">¶</a></dt> |
|
144 <dd><p>Permission required to publish or retire an existing content</p> |
|
145 </dd></dl> |
|
146 |
|
147 <dl class="data"> |
|
148 <dt id="pyams_content.interfaces.READER_ROLE"> |
|
149 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">READER_ROLE</code><em class="property"> = 'pyams.Reader'</em><a class="headerlink" href="#pyams_content.interfaces.READER_ROLE" title="Permalink to this definition">¶</a></dt> |
|
150 <dd><p>Reader role is allowed to read and comment contents while still in draft state</p> |
|
151 </dd></dl> |
|
152 |
|
153 <dl class="data"> |
|
154 <dt id="pyams_content.interfaces.WEBMASTER_ROLE"> |
|
155 <code class="descclassname">pyams_content.interfaces.</code><code class="descname">WEBMASTER_ROLE</code><em class="property"> = 'pyams.Webmaster'</em><a class="headerlink" href="#pyams_content.interfaces.WEBMASTER_ROLE" title="Permalink to this definition">¶</a></dt> |
|
156 <dd><p>Webmaster role has all permissions on all contents</p> |
|
157 </dd></dl> |
|
158 |
|
159 </div> |
|
160 </div> |
|
161 |
|
162 |
|
163 </div> |
|
164 </div> |
|
165 </div> |
|
166 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
167 <div class="sphinxsidebarwrapper"> |
|
168 <h3><a href="index.html">Table Of Contents</a></h3> |
|
169 <ul> |
|
170 <li><a class="reference internal" href="#">pyams_content.interfaces package</a><ul> |
|
171 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
172 <li><a class="reference internal" href="#module-pyams_content.interfaces.container">pyams_content.interfaces.container module</a></li> |
|
173 <li><a class="reference internal" href="#module-pyams_content.interfaces">Module contents</a></li> |
|
174 </ul> |
|
175 </li> |
|
176 </ul> |
|
177 |
|
178 <div id="searchbox" style="display: none" role="search"> |
|
179 <h3>Quick search</h3> |
|
180 <form class="search" action="search.html" method="get"> |
|
181 <div><input type="text" name="q" /></div> |
|
182 <div><input type="submit" value="Go" /></div> |
|
183 <input type="hidden" name="check_keywords" value="yes" /> |
|
184 <input type="hidden" name="area" value="default" /> |
|
185 </form> |
|
186 </div> |
|
187 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
188 </div> |
|
189 </div> |
|
190 <div class="clearer"></div> |
|
191 </div> |
|
192 <div class="related" role="navigation" aria-label="related navigation"> |
|
193 <h3>Navigation</h3> |
|
194 <ul> |
|
195 <li class="right" style="margin-right: 10px"> |
|
196 <a href="genindex.html" title="General Index" |
|
197 >index</a></li> |
|
198 <li class="right" > |
|
199 <a href="py-modindex.html" title="Python Module Index" |
|
200 >modules</a> |</li> |
|
201 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
202 </ul> |
|
203 </div> |
|
204 <div class="footer" role="contentinfo"> |
|
205 © Copyright 2017, Thierry Florac. |
|
206 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
207 </div> |
|
208 </body> |
|
209 </html> |