|
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.news 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-news-package"> |
|
54 <h1>pyams_content.shared.news package<a class="headerlink" href="#pyams-content-shared-news-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.news.interfaces.html">pyams_content.shared.news.interfaces package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.news.interfaces.html#module-pyams_content.shared.news.interfaces">Module contents</a></li> |
|
61 </ul> |
|
62 </li> |
|
63 <li class="toctree-l1"><a class="reference internal" href="pyams_content.shared.news.zmi.html">pyams_content.shared.news.zmi package</a><ul> |
|
64 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.news.zmi.html#module-pyams_content.shared.news.zmi">Module contents</a></li> |
|
65 </ul> |
|
66 </li> |
|
67 </ul> |
|
68 </div> |
|
69 </div> |
|
70 <div class="section" id="submodules"> |
|
71 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
72 </div> |
|
73 <div class="section" id="module-pyams_content.shared.news.manager"> |
|
74 <span id="pyams-content-shared-news-manager-module"></span><h2>pyams_content.shared.news.manager module<a class="headerlink" href="#module-pyams_content.shared.news.manager" title="Permalink to this headline">¶</a></h2> |
|
75 <dl class="class"> |
|
76 <dt id="pyams_content.shared.news.manager.NewsManager"> |
|
77 <em class="property">class </em><code class="descclassname">pyams_content.shared.news.manager.</code><code class="descname">NewsManager</code><a class="headerlink" href="#pyams_content.shared.news.manager.NewsManager" title="Permalink to this definition">¶</a></dt> |
|
78 <dd><p>Bases: <a class="reference internal" href="pyams_content.shared.common.html#pyams_content.shared.common.manager.SharedTool" title="pyams_content.shared.common.manager.SharedTool"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.manager.SharedTool</span></code></a></p> |
|
79 <p>News manager class</p> |
|
80 <dl class="attribute"> |
|
81 <dt id="pyams_content.shared.news.manager.NewsManager.allowed_paragraphs"> |
|
82 <code class="descname">allowed_paragraphs</code><a class="headerlink" href="#pyams_content.shared.news.manager.NewsManager.allowed_paragraphs" title="Permalink to this definition">¶</a></dt> |
|
83 <dd><p>Computed attributes based on schema fields</p> |
|
84 <p>Field properties provide default values, data validation and error messages |
|
85 based on data found in field meta-data.</p> |
|
86 <p>Note that FieldProperties cannot be used with slots. They can only |
|
87 be used for attributes stored in instance dictionaries.</p> |
|
88 </dd></dl> |
|
89 |
|
90 <dl class="attribute"> |
|
91 <dt id="pyams_content.shared.news.manager.NewsManager.auto_created_paragraphs"> |
|
92 <code class="descname">auto_created_paragraphs</code><a class="headerlink" href="#pyams_content.shared.news.manager.NewsManager.auto_created_paragraphs" title="Permalink to this definition">¶</a></dt> |
|
93 <dd><p>Computed attributes based on schema fields</p> |
|
94 <p>Field properties provide default values, data validation and error messages |
|
95 based on data found in field meta-data.</p> |
|
96 <p>Note that FieldProperties cannot be used with slots. They can only |
|
97 be used for attributes stored in instance dictionaries.</p> |
|
98 </dd></dl> |
|
99 |
|
100 <dl class="attribute"> |
|
101 <dt id="pyams_content.shared.news.manager.NewsManager.shared_content_factory"> |
|
102 <code class="descname">shared_content_factory</code><a class="headerlink" href="#pyams_content.shared.news.manager.NewsManager.shared_content_factory" title="Permalink to this definition">¶</a></dt> |
|
103 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">NewsEvent</span></code></p> |
|
104 </dd></dl> |
|
105 |
|
106 <dl class="attribute"> |
|
107 <dt id="pyams_content.shared.news.manager.NewsManager.shared_content_type"> |
|
108 <code class="descname">shared_content_type</code><em class="property"> = 'news'</em><a class="headerlink" href="#pyams_content.shared.news.manager.NewsManager.shared_content_type" title="Permalink to this definition">¶</a></dt> |
|
109 <dd></dd></dl> |
|
110 |
|
111 </dd></dl> |
|
112 |
|
113 <dl class="function"> |
|
114 <dt id="pyams_content.shared.news.manager.handle_added_news_manager"> |
|
115 <code class="descclassname">pyams_content.shared.news.manager.</code><code class="descname">handle_added_news_manager</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.news.manager.handle_added_news_manager" title="Permalink to this definition">¶</a></dt> |
|
116 <dd><p>Register news manager when added</p> |
|
117 </dd></dl> |
|
118 |
|
119 </div> |
|
120 <div class="section" id="module-pyams_content.shared.news"> |
|
121 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.shared.news" title="Permalink to this headline">¶</a></h2> |
|
122 <dl class="class"> |
|
123 <dt id="pyams_content.shared.news.NewsEvent"> |
|
124 <em class="property">class </em><code class="descclassname">pyams_content.shared.news.</code><code class="descname">NewsEvent</code><a class="headerlink" href="#pyams_content.shared.news.NewsEvent" title="Permalink to this definition">¶</a></dt> |
|
125 <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> |
|
126 <p>Workflow managed news event class</p> |
|
127 <dl class="attribute"> |
|
128 <dt id="pyams_content.shared.news.NewsEvent.content_class"> |
|
129 <code class="descname">content_class</code><a class="headerlink" href="#pyams_content.shared.news.NewsEvent.content_class" title="Permalink to this definition">¶</a></dt> |
|
130 <dd><p>alias of <a class="reference internal" href="#pyams_content.shared.news.WfNewsEvent" title="pyams_content.shared.news.WfNewsEvent"><code class="xref py py-class docutils literal"><span class="pre">WfNewsEvent</span></code></a></p> |
|
131 </dd></dl> |
|
132 |
|
133 </dd></dl> |
|
134 |
|
135 <dl class="class"> |
|
136 <dt id="pyams_content.shared.news.WfNewsEvent"> |
|
137 <em class="property">class </em><code class="descclassname">pyams_content.shared.news.</code><code class="descname">WfNewsEvent</code><a class="headerlink" href="#pyams_content.shared.news.WfNewsEvent" title="Permalink to this definition">¶</a></dt> |
|
138 <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> |
|
139 <p>Base news event</p> |
|
140 <dl class="attribute"> |
|
141 <dt id="pyams_content.shared.news.WfNewsEvent.content_name"> |
|
142 <code class="descname">content_name</code><em class="property"> = 'News topic'</em><a class="headerlink" href="#pyams_content.shared.news.WfNewsEvent.content_name" title="Permalink to this definition">¶</a></dt> |
|
143 <dd></dd></dl> |
|
144 |
|
145 <dl class="attribute"> |
|
146 <dt id="pyams_content.shared.news.WfNewsEvent.content_type"> |
|
147 <code class="descname">content_type</code><em class="property"> = 'news'</em><a class="headerlink" href="#pyams_content.shared.news.WfNewsEvent.content_type" title="Permalink to this definition">¶</a></dt> |
|
148 <dd></dd></dl> |
|
149 |
|
150 </dd></dl> |
|
151 |
|
152 </div> |
|
153 </div> |
|
154 |
|
155 |
|
156 </div> |
|
157 </div> |
|
158 </div> |
|
159 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
160 <div class="sphinxsidebarwrapper"> |
|
161 <h3><a href="index.html">Table Of Contents</a></h3> |
|
162 <ul> |
|
163 <li><a class="reference internal" href="#">pyams_content.shared.news package</a><ul> |
|
164 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
165 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
166 <li><a class="reference internal" href="#module-pyams_content.shared.news.manager">pyams_content.shared.news.manager module</a></li> |
|
167 <li><a class="reference internal" href="#module-pyams_content.shared.news">Module contents</a></li> |
|
168 </ul> |
|
169 </li> |
|
170 </ul> |
|
171 |
|
172 <div id="searchbox" style="display: none" role="search"> |
|
173 <h3>Quick search</h3> |
|
174 <form class="search" action="search.html" method="get"> |
|
175 <div><input type="text" name="q" /></div> |
|
176 <div><input type="submit" value="Go" /></div> |
|
177 <input type="hidden" name="check_keywords" value="yes" /> |
|
178 <input type="hidden" name="area" value="default" /> |
|
179 </form> |
|
180 </div> |
|
181 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
182 </div> |
|
183 </div> |
|
184 <div class="clearer"></div> |
|
185 </div> |
|
186 <div class="related" role="navigation" aria-label="related navigation"> |
|
187 <h3>Navigation</h3> |
|
188 <ul> |
|
189 <li class="right" style="margin-right: 10px"> |
|
190 <a href="genindex.html" title="General Index" |
|
191 >index</a></li> |
|
192 <li class="right" > |
|
193 <a href="py-modindex.html" title="Python Module Index" |
|
194 >modules</a> |</li> |
|
195 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
196 </ul> |
|
197 </div> |
|
198 <div class="footer" role="contentinfo"> |
|
199 © Copyright 2017, Thierry Florac. |
|
200 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
201 </div> |
|
202 </body> |
|
203 </html> |