|
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.component.paragraph 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-component-paragraph-package"> |
|
54 <h1>pyams_content.component.paragraph package<a class="headerlink" href="#pyams-content-component-paragraph-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.component.paragraph.interfaces.html">pyams_content.component.paragraph.interfaces package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.interfaces.html#submodules">Submodules</a></li> |
|
61 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.interfaces.html#module-pyams_content.component.paragraph.interfaces.header">pyams_content.component.paragraph.interfaces.header module</a></li> |
|
62 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.interfaces.html#module-pyams_content.component.paragraph.interfaces.html">pyams_content.component.paragraph.interfaces.html module</a></li> |
|
63 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.interfaces.html#module-pyams_content.component.paragraph.interfaces.video">pyams_content.component.paragraph.interfaces.video module</a></li> |
|
64 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.interfaces.html#module-pyams_content.component.paragraph.interfaces">Module contents</a></li> |
|
65 </ul> |
|
66 </li> |
|
67 <li class="toctree-l1"><a class="reference internal" href="pyams_content.component.paragraph.zmi.html">pyams_content.component.paragraph.zmi package</a><ul> |
|
68 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.zmi.html#submodules">Submodules</a></li> |
|
69 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.zmi.html#module-pyams_content.component.paragraph.zmi.container">pyams_content.component.paragraph.zmi.container module</a></li> |
|
70 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.zmi.html#module-pyams_content.component.paragraph.zmi.header">pyams_content.component.paragraph.zmi.header module</a></li> |
|
71 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.zmi.html#module-pyams_content.component.paragraph.zmi.html">pyams_content.component.paragraph.zmi.html module</a></li> |
|
72 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.zmi.html#module-pyams_content.component.paragraph.zmi.interfaces">pyams_content.component.paragraph.zmi.interfaces module</a></li> |
|
73 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.zmi.html#module-pyams_content.component.paragraph.zmi.preview">pyams_content.component.paragraph.zmi.preview module</a></li> |
|
74 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.zmi.html#module-pyams_content.component.paragraph.zmi.video">pyams_content.component.paragraph.zmi.video module</a></li> |
|
75 <li class="toctree-l2"><a class="reference internal" href="pyams_content.component.paragraph.zmi.html#module-pyams_content.component.paragraph.zmi">Module contents</a></li> |
|
76 </ul> |
|
77 </li> |
|
78 </ul> |
|
79 </div> |
|
80 </div> |
|
81 <div class="section" id="submodules"> |
|
82 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
83 </div> |
|
84 <div class="section" id="module-pyams_content.component.paragraph.container"> |
|
85 <span id="pyams-content-component-paragraph-container-module"></span><h2>pyams_content.component.paragraph.container module<a class="headerlink" href="#module-pyams_content.component.paragraph.container" title="Permalink to this headline">¶</a></h2> |
|
86 <dl class="class"> |
|
87 <dt id="pyams_content.component.paragraph.container.ParagraphContainer"> |
|
88 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.container.</code><code class="descname">ParagraphContainer</code><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainer" title="Permalink to this definition">¶</a></dt> |
|
89 <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> |
|
90 <p>Paragraphs container</p> |
|
91 <dl class="method"> |
|
92 <dt id="pyams_content.component.paragraph.container.ParagraphContainer.append"> |
|
93 <code class="descname">append</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainer.append" title="Permalink to this definition">¶</a></dt> |
|
94 <dd></dd></dl> |
|
95 |
|
96 <dl class="attribute"> |
|
97 <dt id="pyams_content.component.paragraph.container.ParagraphContainer.last_id"> |
|
98 <code class="descname">last_id</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainer.last_id" title="Permalink to this definition">¶</a></dt> |
|
99 <dd></dd></dl> |
|
100 |
|
101 </dd></dl> |
|
102 |
|
103 <dl class="class"> |
|
104 <dt id="pyams_content.component.paragraph.container.ParagraphContainerChecker"> |
|
105 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.container.</code><code class="descname">ParagraphContainerChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainerChecker" title="Permalink to this definition">¶</a></dt> |
|
106 <dd><p>Bases: <a class="reference internal" href="pyams_content.features.checker.html#pyams_content.features.checker.BaseContentChecker" title="pyams_content.features.checker.BaseContentChecker"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.features.checker.BaseContentChecker</span></code></a></p> |
|
107 <p>Paragraphs container checker</p> |
|
108 <dl class="method"> |
|
109 <dt id="pyams_content.component.paragraph.container.ParagraphContainerChecker.inner_check"> |
|
110 <code class="descname">inner_check</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainerChecker.inner_check" title="Permalink to this definition">¶</a></dt> |
|
111 <dd></dd></dl> |
|
112 |
|
113 <dl class="attribute"> |
|
114 <dt id="pyams_content.component.paragraph.container.ParagraphContainerChecker.label"> |
|
115 <code class="descname">label</code><em class="property"> = 'Paragraphs'</em><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainerChecker.label" title="Permalink to this definition">¶</a></dt> |
|
116 <dd></dd></dl> |
|
117 |
|
118 <dl class="attribute"> |
|
119 <dt id="pyams_content.component.paragraph.container.ParagraphContainerChecker.sep"> |
|
120 <code class="descname">sep</code><em class="property"> = '\n'</em><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainerChecker.sep" title="Permalink to this definition">¶</a></dt> |
|
121 <dd></dd></dl> |
|
122 |
|
123 <dl class="attribute"> |
|
124 <dt id="pyams_content.component.paragraph.container.ParagraphContainerChecker.weight"> |
|
125 <code class="descname">weight</code><em class="property"> = 10</em><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainerChecker.weight" title="Permalink to this definition">¶</a></dt> |
|
126 <dd></dd></dl> |
|
127 |
|
128 </dd></dl> |
|
129 |
|
130 <dl class="class"> |
|
131 <dt id="pyams_content.component.paragraph.container.ParagraphContainerNamespace"> |
|
132 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.container.</code><code class="descname">ParagraphContainerNamespace</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainerNamespace" title="Permalink to this definition">¶</a></dt> |
|
133 <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> |
|
134 <p>++paras++ namespace adapter</p> |
|
135 <dl class="method"> |
|
136 <dt id="pyams_content.component.paragraph.container.ParagraphContainerNamespace.traverse"> |
|
137 <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.component.paragraph.container.ParagraphContainerNamespace.traverse" title="Permalink to this definition">¶</a></dt> |
|
138 <dd></dd></dl> |
|
139 |
|
140 </dd></dl> |
|
141 |
|
142 <dl class="class"> |
|
143 <dt id="pyams_content.component.paragraph.container.ParagraphContainerSublocations"> |
|
144 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.container.</code><code class="descname">ParagraphContainerSublocations</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainerSublocations" title="Permalink to this definition">¶</a></dt> |
|
145 <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> |
|
146 <p>Paragraphs container sublocations</p> |
|
147 <dl class="method"> |
|
148 <dt id="pyams_content.component.paragraph.container.ParagraphContainerSublocations.sublocations"> |
|
149 <code class="descname">sublocations</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.container.ParagraphContainerSublocations.sublocations" title="Permalink to this definition">¶</a></dt> |
|
150 <dd></dd></dl> |
|
151 |
|
152 </dd></dl> |
|
153 |
|
154 <dl class="function"> |
|
155 <dt id="pyams_content.component.paragraph.container.paragraph_container_factory"> |
|
156 <code class="descclassname">pyams_content.component.paragraph.container.</code><code class="descname">paragraph_container_factory</code><span class="sig-paren">(</span><em>target</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.container.paragraph_container_factory" title="Permalink to this definition">¶</a></dt> |
|
157 <dd><p>Paragraphs container factory</p> |
|
158 </dd></dl> |
|
159 |
|
160 </div> |
|
161 <div class="section" id="module-pyams_content.component.paragraph.header"> |
|
162 <span id="pyams-content-component-paragraph-header-module"></span><h2>pyams_content.component.paragraph.header module<a class="headerlink" href="#module-pyams_content.component.paragraph.header" title="Permalink to this headline">¶</a></h2> |
|
163 <dl class="class"> |
|
164 <dt id="pyams_content.component.paragraph.header.HTMLParagraphFactory"> |
|
165 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.header.</code><code class="descname">HTMLParagraphFactory</code><a class="headerlink" href="#pyams_content.component.paragraph.header.HTMLParagraphFactory" title="Permalink to this definition">¶</a></dt> |
|
166 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
167 <p>HTML paragraph factory</p> |
|
168 <dl class="attribute"> |
|
169 <dt id="pyams_content.component.paragraph.header.HTMLParagraphFactory.content_type"> |
|
170 <code class="descname">content_type</code><a class="headerlink" href="#pyams_content.component.paragraph.header.HTMLParagraphFactory.content_type" title="Permalink to this definition">¶</a></dt> |
|
171 <dd><p>alias of <a class="reference internal" href="#pyams_content.component.paragraph.header.HeaderParagraph" title="pyams_content.component.paragraph.header.HeaderParagraph"><code class="xref py py-class docutils literal"><span class="pre">HeaderParagraph</span></code></a></p> |
|
172 </dd></dl> |
|
173 |
|
174 <dl class="attribute"> |
|
175 <dt id="pyams_content.component.paragraph.header.HTMLParagraphFactory.name"> |
|
176 <code class="descname">name</code><em class="property"> = 'Header paragraph'</em><a class="headerlink" href="#pyams_content.component.paragraph.header.HTMLParagraphFactory.name" title="Permalink to this definition">¶</a></dt> |
|
177 <dd></dd></dl> |
|
178 |
|
179 </dd></dl> |
|
180 |
|
181 <dl class="class"> |
|
182 <dt id="pyams_content.component.paragraph.header.HeaderParagraph"> |
|
183 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.header.</code><code class="descname">HeaderParagraph</code><a class="headerlink" href="#pyams_content.component.paragraph.header.HeaderParagraph" title="Permalink to this definition">¶</a></dt> |
|
184 <dd><p>Bases: <a class="reference internal" href="#pyams_content.component.paragraph.BaseParagraph" title="pyams_content.component.paragraph.BaseParagraph"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.component.paragraph.BaseParagraph</span></code></a></p> |
|
185 <p>Header paragraph</p> |
|
186 <dl class="attribute"> |
|
187 <dt id="pyams_content.component.paragraph.header.HeaderParagraph.header"> |
|
188 <code class="descname">header</code><a class="headerlink" href="#pyams_content.component.paragraph.header.HeaderParagraph.header" title="Permalink to this definition">¶</a></dt> |
|
189 <dd><p>Computed attributes based on schema fields</p> |
|
190 <p>Field properties provide default values, data validation and error messages |
|
191 based on data found in field meta-data.</p> |
|
192 <p>Note that FieldProperties cannot be used with slots. They can only |
|
193 be used for attributes stored in instance dictionaries.</p> |
|
194 </dd></dl> |
|
195 |
|
196 <dl class="attribute"> |
|
197 <dt id="pyams_content.component.paragraph.header.HeaderParagraph.icon_class"> |
|
198 <code class="descname">icon_class</code><em class="property"> = 'fa-header'</em><a class="headerlink" href="#pyams_content.component.paragraph.header.HeaderParagraph.icon_class" title="Permalink to this definition">¶</a></dt> |
|
199 <dd></dd></dl> |
|
200 |
|
201 <dl class="attribute"> |
|
202 <dt id="pyams_content.component.paragraph.header.HeaderParagraph.icon_hint"> |
|
203 <code class="descname">icon_hint</code><em class="property"> = 'Header'</em><a class="headerlink" href="#pyams_content.component.paragraph.header.HeaderParagraph.icon_hint" title="Permalink to this definition">¶</a></dt> |
|
204 <dd></dd></dl> |
|
205 |
|
206 <dl class="attribute"> |
|
207 <dt id="pyams_content.component.paragraph.header.HeaderParagraph.title"> |
|
208 <code class="descname">title</code><a class="headerlink" href="#pyams_content.component.paragraph.header.HeaderParagraph.title" title="Permalink to this definition">¶</a></dt> |
|
209 <dd></dd></dl> |
|
210 |
|
211 </dd></dl> |
|
212 |
|
213 <dl class="class"> |
|
214 <dt id="pyams_content.component.paragraph.header.HeaderParagraphContentChecker"> |
|
215 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.header.</code><code class="descname">HeaderParagraphContentChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.header.HeaderParagraphContentChecker" title="Permalink to this definition">¶</a></dt> |
|
216 <dd><p>Bases: <a class="reference internal" href="#pyams_content.component.paragraph.BaseParagraphContentChecker" title="pyams_content.component.paragraph.BaseParagraphContentChecker"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.component.paragraph.BaseParagraphContentChecker</span></code></a></p> |
|
217 <p>Header paragraph content checker</p> |
|
218 <dl class="method"> |
|
219 <dt id="pyams_content.component.paragraph.header.HeaderParagraphContentChecker.inner_check"> |
|
220 <code class="descname">inner_check</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.header.HeaderParagraphContentChecker.inner_check" title="Permalink to this definition">¶</a></dt> |
|
221 <dd></dd></dl> |
|
222 |
|
223 </dd></dl> |
|
224 |
|
225 </div> |
|
226 <div class="section" id="module-pyams_content.component.paragraph.html"> |
|
227 <span id="pyams-content-component-paragraph-html-module"></span><h2>pyams_content.component.paragraph.html module<a class="headerlink" href="#module-pyams_content.component.paragraph.html" title="Permalink to this headline">¶</a></h2> |
|
228 <dl class="class"> |
|
229 <dt id="pyams_content.component.paragraph.html.HTMLParagraph"> |
|
230 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.html.</code><code class="descname">HTMLParagraph</code><a class="headerlink" href="#pyams_content.component.paragraph.html.HTMLParagraph" title="Permalink to this definition">¶</a></dt> |
|
231 <dd><p>Bases: <a class="reference internal" href="#pyams_content.component.paragraph.BaseParagraph" title="pyams_content.component.paragraph.BaseParagraph"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.component.paragraph.BaseParagraph</span></code></a></p> |
|
232 <p>HTML paragraph</p> |
|
233 <dl class="attribute"> |
|
234 <dt id="pyams_content.component.paragraph.html.HTMLParagraph.body"> |
|
235 <code class="descname">body</code><a class="headerlink" href="#pyams_content.component.paragraph.html.HTMLParagraph.body" title="Permalink to this definition">¶</a></dt> |
|
236 <dd><p>Computed attributes based on schema fields</p> |
|
237 <p>Field properties provide default values, data validation and error messages |
|
238 based on data found in field meta-data.</p> |
|
239 <p>Note that FieldProperties cannot be used with slots. They can only |
|
240 be used for attributes stored in instance dictionaries.</p> |
|
241 </dd></dl> |
|
242 |
|
243 <dl class="attribute"> |
|
244 <dt id="pyams_content.component.paragraph.html.HTMLParagraph.icon_class"> |
|
245 <code class="descname">icon_class</code><em class="property"> = 'fa-html5'</em><a class="headerlink" href="#pyams_content.component.paragraph.html.HTMLParagraph.icon_class" title="Permalink to this definition">¶</a></dt> |
|
246 <dd></dd></dl> |
|
247 |
|
248 <dl class="attribute"> |
|
249 <dt id="pyams_content.component.paragraph.html.HTMLParagraph.icon_hint"> |
|
250 <code class="descname">icon_hint</code><em class="property"> = 'HTML paragraph'</em><a class="headerlink" href="#pyams_content.component.paragraph.html.HTMLParagraph.icon_hint" title="Permalink to this definition">¶</a></dt> |
|
251 <dd></dd></dl> |
|
252 |
|
253 </dd></dl> |
|
254 |
|
255 <dl class="class"> |
|
256 <dt id="pyams_content.component.paragraph.html.HTMLParagraphContentChecker"> |
|
257 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.html.</code><code class="descname">HTMLParagraphContentChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.html.HTMLParagraphContentChecker" title="Permalink to this definition">¶</a></dt> |
|
258 <dd><p>Bases: <a class="reference internal" href="#pyams_content.component.paragraph.BaseParagraphContentChecker" title="pyams_content.component.paragraph.BaseParagraphContentChecker"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.component.paragraph.BaseParagraphContentChecker</span></code></a></p> |
|
259 <p>HTML paragraph content checker</p> |
|
260 <dl class="method"> |
|
261 <dt id="pyams_content.component.paragraph.html.HTMLParagraphContentChecker.inner_check"> |
|
262 <code class="descname">inner_check</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.html.HTMLParagraphContentChecker.inner_check" title="Permalink to this definition">¶</a></dt> |
|
263 <dd></dd></dl> |
|
264 |
|
265 </dd></dl> |
|
266 |
|
267 <dl class="class"> |
|
268 <dt id="pyams_content.component.paragraph.html.HTMLParagraphFactory"> |
|
269 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.html.</code><code class="descname">HTMLParagraphFactory</code><a class="headerlink" href="#pyams_content.component.paragraph.html.HTMLParagraphFactory" title="Permalink to this definition">¶</a></dt> |
|
270 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
271 <p>HTML paragraph factory</p> |
|
272 <dl class="attribute"> |
|
273 <dt id="pyams_content.component.paragraph.html.HTMLParagraphFactory.content_type"> |
|
274 <code class="descname">content_type</code><a class="headerlink" href="#pyams_content.component.paragraph.html.HTMLParagraphFactory.content_type" title="Permalink to this definition">¶</a></dt> |
|
275 <dd><p>alias of <a class="reference internal" href="#pyams_content.component.paragraph.html.HTMLParagraph" title="pyams_content.component.paragraph.html.HTMLParagraph"><code class="xref py py-class docutils literal"><span class="pre">HTMLParagraph</span></code></a></p> |
|
276 </dd></dl> |
|
277 |
|
278 <dl class="attribute"> |
|
279 <dt id="pyams_content.component.paragraph.html.HTMLParagraphFactory.name"> |
|
280 <code class="descname">name</code><em class="property"> = 'HTML paragraph'</em><a class="headerlink" href="#pyams_content.component.paragraph.html.HTMLParagraphFactory.name" title="Permalink to this definition">¶</a></dt> |
|
281 <dd></dd></dl> |
|
282 |
|
283 </dd></dl> |
|
284 |
|
285 <dl class="function"> |
|
286 <dt id="pyams_content.component.paragraph.html.check_associations"> |
|
287 <code class="descclassname">pyams_content.component.paragraph.html.</code><code class="descname">check_associations</code><span class="sig-paren">(</span><em>context</em>, <em>body</em>, <em>lang</em>, <em>notify=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.html.check_associations" title="Permalink to this definition">¶</a></dt> |
|
288 <dd><p>Check for link associations from HTML content</p> |
|
289 </dd></dl> |
|
290 |
|
291 <dl class="function"> |
|
292 <dt id="pyams_content.component.paragraph.html.handle_added_html_paragraph"> |
|
293 <code class="descclassname">pyams_content.component.paragraph.html.</code><code class="descname">handle_added_html_paragraph</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.html.handle_added_html_paragraph" title="Permalink to this definition">¶</a></dt> |
|
294 <dd><p>Check for new associations from added paragraph</p> |
|
295 </dd></dl> |
|
296 |
|
297 <dl class="function"> |
|
298 <dt id="pyams_content.component.paragraph.html.handle_modified_html_paragraph"> |
|
299 <code class="descclassname">pyams_content.component.paragraph.html.</code><code class="descname">handle_modified_html_paragraph</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.html.handle_modified_html_paragraph" title="Permalink to this definition">¶</a></dt> |
|
300 <dd><p>Check for new associations from modified paragraph</p> |
|
301 </dd></dl> |
|
302 |
|
303 </div> |
|
304 <div class="section" id="module-pyams_content.component.paragraph.video"> |
|
305 <span id="pyams-content-component-paragraph-video-module"></span><h2>pyams_content.component.paragraph.video module<a class="headerlink" href="#module-pyams_content.component.paragraph.video" title="Permalink to this headline">¶</a></h2> |
|
306 <dl class="class"> |
|
307 <dt id="pyams_content.component.paragraph.video.VideoParagraph"> |
|
308 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.video.</code><code class="descname">VideoParagraph</code><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraph" title="Permalink to this definition">¶</a></dt> |
|
309 <dd><p>Bases: <a class="reference internal" href="#pyams_content.component.paragraph.BaseParagraph" title="pyams_content.component.paragraph.BaseParagraph"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.component.paragraph.BaseParagraph</span></code></a></p> |
|
310 <p>Video paragraph class</p> |
|
311 <dl class="attribute"> |
|
312 <dt id="pyams_content.component.paragraph.video.VideoParagraph.author"> |
|
313 <code class="descname">author</code><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraph.author" title="Permalink to this definition">¶</a></dt> |
|
314 <dd><p>Computed attributes based on schema fields</p> |
|
315 <p>Field properties provide default values, data validation and error messages |
|
316 based on data found in field meta-data.</p> |
|
317 <p>Note that FieldProperties cannot be used with slots. They can only |
|
318 be used for attributes stored in instance dictionaries.</p> |
|
319 </dd></dl> |
|
320 |
|
321 <dl class="attribute"> |
|
322 <dt id="pyams_content.component.paragraph.video.VideoParagraph.body"> |
|
323 <code class="descname">body</code><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraph.body" title="Permalink to this definition">¶</a></dt> |
|
324 <dd><p>Computed attributes based on schema fields</p> |
|
325 <p>Field properties provide default values, data validation and error messages |
|
326 based on data found in field meta-data.</p> |
|
327 <p>Note that FieldProperties cannot be used with slots. They can only |
|
328 be used for attributes stored in instance dictionaries.</p> |
|
329 </dd></dl> |
|
330 |
|
331 <dl class="attribute"> |
|
332 <dt id="pyams_content.component.paragraph.video.VideoParagraph.data"> |
|
333 <code class="descname">data</code><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraph.data" title="Permalink to this definition">¶</a></dt> |
|
334 <dd><p>Property class used to handle files</p> |
|
335 </dd></dl> |
|
336 |
|
337 <dl class="attribute"> |
|
338 <dt id="pyams_content.component.paragraph.video.VideoParagraph.description"> |
|
339 <code class="descname">description</code><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraph.description" title="Permalink to this definition">¶</a></dt> |
|
340 <dd><p>Computed attributes based on schema fields</p> |
|
341 <p>Field properties provide default values, data validation and error messages |
|
342 based on data found in field meta-data.</p> |
|
343 <p>Note that FieldProperties cannot be used with slots. They can only |
|
344 be used for attributes stored in instance dictionaries.</p> |
|
345 </dd></dl> |
|
346 |
|
347 <dl class="attribute"> |
|
348 <dt id="pyams_content.component.paragraph.video.VideoParagraph.icon_class"> |
|
349 <code class="descname">icon_class</code><em class="property"> = 'fa-film'</em><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraph.icon_class" title="Permalink to this definition">¶</a></dt> |
|
350 <dd></dd></dl> |
|
351 |
|
352 <dl class="attribute"> |
|
353 <dt id="pyams_content.component.paragraph.video.VideoParagraph.icon_hint"> |
|
354 <code class="descname">icon_hint</code><em class="property"> = 'Video'</em><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraph.icon_hint" title="Permalink to this definition">¶</a></dt> |
|
355 <dd></dd></dl> |
|
356 |
|
357 </dd></dl> |
|
358 |
|
359 <dl class="class"> |
|
360 <dt id="pyams_content.component.paragraph.video.VideoParagraphContentChecker"> |
|
361 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.video.</code><code class="descname">VideoParagraphContentChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraphContentChecker" title="Permalink to this definition">¶</a></dt> |
|
362 <dd><p>Bases: <a class="reference internal" href="#pyams_content.component.paragraph.BaseParagraphContentChecker" title="pyams_content.component.paragraph.BaseParagraphContentChecker"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.component.paragraph.BaseParagraphContentChecker</span></code></a></p> |
|
363 <p>Video paragraph content checker</p> |
|
364 <dl class="method"> |
|
365 <dt id="pyams_content.component.paragraph.video.VideoParagraphContentChecker.inner_check"> |
|
366 <code class="descname">inner_check</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraphContentChecker.inner_check" title="Permalink to this definition">¶</a></dt> |
|
367 <dd></dd></dl> |
|
368 |
|
369 </dd></dl> |
|
370 |
|
371 <dl class="class"> |
|
372 <dt id="pyams_content.component.paragraph.video.VideoParagraphFactory"> |
|
373 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.video.</code><code class="descname">VideoParagraphFactory</code><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraphFactory" title="Permalink to this definition">¶</a></dt> |
|
374 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
375 <p>Video paragraph factory</p> |
|
376 <dl class="attribute"> |
|
377 <dt id="pyams_content.component.paragraph.video.VideoParagraphFactory.content_type"> |
|
378 <code class="descname">content_type</code><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraphFactory.content_type" title="Permalink to this definition">¶</a></dt> |
|
379 <dd><p>alias of <a class="reference internal" href="#pyams_content.component.paragraph.video.VideoParagraph" title="pyams_content.component.paragraph.video.VideoParagraph"><code class="xref py py-class docutils literal"><span class="pre">VideoParagraph</span></code></a></p> |
|
380 </dd></dl> |
|
381 |
|
382 <dl class="attribute"> |
|
383 <dt id="pyams_content.component.paragraph.video.VideoParagraphFactory.name"> |
|
384 <code class="descname">name</code><em class="property"> = 'Video'</em><a class="headerlink" href="#pyams_content.component.paragraph.video.VideoParagraphFactory.name" title="Permalink to this definition">¶</a></dt> |
|
385 <dd></dd></dl> |
|
386 |
|
387 </dd></dl> |
|
388 |
|
389 <dl class="function"> |
|
390 <dt id="pyams_content.component.paragraph.video.handle_added_video_paragraph"> |
|
391 <code class="descclassname">pyams_content.component.paragraph.video.</code><code class="descname">handle_added_video_paragraph</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.video.handle_added_video_paragraph" title="Permalink to this definition">¶</a></dt> |
|
392 <dd><p>Check for new associations from added paragraph</p> |
|
393 </dd></dl> |
|
394 |
|
395 <dl class="function"> |
|
396 <dt id="pyams_content.component.paragraph.video.handle_modified_video_paragraph"> |
|
397 <code class="descclassname">pyams_content.component.paragraph.video.</code><code class="descname">handle_modified_video_paragraph</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.video.handle_modified_video_paragraph" title="Permalink to this definition">¶</a></dt> |
|
398 <dd><p>Check for new associations from modified paragraph</p> |
|
399 </dd></dl> |
|
400 |
|
401 </div> |
|
402 <div class="section" id="module-pyams_content.component.paragraph"> |
|
403 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.component.paragraph" title="Permalink to this headline">¶</a></h2> |
|
404 <dl class="class"> |
|
405 <dt id="pyams_content.component.paragraph.BaseParagraph"> |
|
406 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.</code><code class="descname">BaseParagraph</code><a class="headerlink" href="#pyams_content.component.paragraph.BaseParagraph" title="Permalink to this definition">¶</a></dt> |
|
407 <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> |
|
408 <p>Base paragraph persistent class</p> |
|
409 <dl class="attribute"> |
|
410 <dt id="pyams_content.component.paragraph.BaseParagraph.icon_class"> |
|
411 <code class="descname">icon_class</code><em class="property"> = ''</em><a class="headerlink" href="#pyams_content.component.paragraph.BaseParagraph.icon_class" title="Permalink to this definition">¶</a></dt> |
|
412 <dd></dd></dl> |
|
413 |
|
414 <dl class="attribute"> |
|
415 <dt id="pyams_content.component.paragraph.BaseParagraph.icon_hint"> |
|
416 <code class="descname">icon_hint</code><em class="property"> = ''</em><a class="headerlink" href="#pyams_content.component.paragraph.BaseParagraph.icon_hint" title="Permalink to this definition">¶</a></dt> |
|
417 <dd></dd></dl> |
|
418 |
|
419 <dl class="attribute"> |
|
420 <dt id="pyams_content.component.paragraph.BaseParagraph.title"> |
|
421 <code class="descname">title</code><a class="headerlink" href="#pyams_content.component.paragraph.BaseParagraph.title" title="Permalink to this definition">¶</a></dt> |
|
422 <dd><p>Computed attributes based on schema fields</p> |
|
423 <p>Field properties provide default values, data validation and error messages |
|
424 based on data found in field meta-data.</p> |
|
425 <p>Note that FieldProperties cannot be used with slots. They can only |
|
426 be used for attributes stored in instance dictionaries.</p> |
|
427 </dd></dl> |
|
428 |
|
429 <dl class="attribute"> |
|
430 <dt id="pyams_content.component.paragraph.BaseParagraph.visible"> |
|
431 <code class="descname">visible</code><a class="headerlink" href="#pyams_content.component.paragraph.BaseParagraph.visible" title="Permalink to this definition">¶</a></dt> |
|
432 <dd><p>Computed attributes based on schema fields</p> |
|
433 <p>Field properties provide default values, data validation and error messages |
|
434 based on data found in field meta-data.</p> |
|
435 <p>Note that FieldProperties cannot be used with slots. They can only |
|
436 be used for attributes stored in instance dictionaries.</p> |
|
437 </dd></dl> |
|
438 |
|
439 </dd></dl> |
|
440 |
|
441 <dl class="class"> |
|
442 <dt id="pyams_content.component.paragraph.BaseParagraphContentChecker"> |
|
443 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.</code><code class="descname">BaseParagraphContentChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.BaseParagraphContentChecker" title="Permalink to this definition">¶</a></dt> |
|
444 <dd><p>Bases: <a class="reference internal" href="pyams_content.features.checker.html#pyams_content.features.checker.BaseContentChecker" title="pyams_content.features.checker.BaseContentChecker"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.features.checker.BaseContentChecker</span></code></a></p> |
|
445 <p>Base paragraph content checker mixin</p> |
|
446 <dl class="attribute"> |
|
447 <dt id="pyams_content.component.paragraph.BaseParagraphContentChecker.label"> |
|
448 <code class="descname">label</code><a class="headerlink" href="#pyams_content.component.paragraph.BaseParagraphContentChecker.label" title="Permalink to this definition">¶</a></dt> |
|
449 <dd></dd></dl> |
|
450 |
|
451 </dd></dl> |
|
452 |
|
453 <dl class="class"> |
|
454 <dt id="pyams_content.component.paragraph.BaseParagraphPermissionChecker"> |
|
455 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.</code><code class="descname">BaseParagraphPermissionChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.BaseParagraphPermissionChecker" title="Permalink to this definition">¶</a></dt> |
|
456 <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> |
|
457 <p>Paragraph permission checker</p> |
|
458 <dl class="attribute"> |
|
459 <dt id="pyams_content.component.paragraph.BaseParagraphPermissionChecker.edit_permission"> |
|
460 <code class="descname">edit_permission</code><a class="headerlink" href="#pyams_content.component.paragraph.BaseParagraphPermissionChecker.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
461 <dd></dd></dl> |
|
462 |
|
463 </dd></dl> |
|
464 |
|
465 <dl class="class"> |
|
466 <dt id="pyams_content.component.paragraph.ParagraphFactoriesVocabulary"> |
|
467 <em class="property">class </em><code class="descclassname">pyams_content.component.paragraph.</code><code class="descname">ParagraphFactoriesVocabulary</code><span class="sig-paren">(</span><em>context=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.ParagraphFactoriesVocabulary" title="Permalink to this definition">¶</a></dt> |
|
468 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
469 <p>Paragraph factories vocabulary</p> |
|
470 </dd></dl> |
|
471 |
|
472 <dl class="function"> |
|
473 <dt id="pyams_content.component.paragraph.handle_added_paragraph"> |
|
474 <code class="descclassname">pyams_content.component.paragraph.</code><code class="descname">handle_added_paragraph</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.handle_added_paragraph" title="Permalink to this definition">¶</a></dt> |
|
475 <dd><p>Handle added paragraph</p> |
|
476 </dd></dl> |
|
477 |
|
478 <dl class="function"> |
|
479 <dt id="pyams_content.component.paragraph.handle_modified_paragraph"> |
|
480 <code class="descclassname">pyams_content.component.paragraph.</code><code class="descname">handle_modified_paragraph</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.handle_modified_paragraph" title="Permalink to this definition">¶</a></dt> |
|
481 <dd><p>Handle modified paragraph</p> |
|
482 </dd></dl> |
|
483 |
|
484 <dl class="function"> |
|
485 <dt id="pyams_content.component.paragraph.handle_new_paragraphs_container"> |
|
486 <code class="descclassname">pyams_content.component.paragraph.</code><code class="descname">handle_new_paragraphs_container</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.handle_new_paragraphs_container" title="Permalink to this definition">¶</a></dt> |
|
487 <dd><p>Handle new paragraphs container</p> |
|
488 </dd></dl> |
|
489 |
|
490 <dl class="function"> |
|
491 <dt id="pyams_content.component.paragraph.handle_removed_paragraph"> |
|
492 <code class="descclassname">pyams_content.component.paragraph.</code><code class="descname">handle_removed_paragraph</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.component.paragraph.handle_removed_paragraph" title="Permalink to this definition">¶</a></dt> |
|
493 <dd><p>Handle removed paragraph</p> |
|
494 </dd></dl> |
|
495 |
|
496 </div> |
|
497 </div> |
|
498 |
|
499 |
|
500 </div> |
|
501 </div> |
|
502 </div> |
|
503 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
504 <div class="sphinxsidebarwrapper"> |
|
505 <h3><a href="index.html">Table Of Contents</a></h3> |
|
506 <ul> |
|
507 <li><a class="reference internal" href="#">pyams_content.component.paragraph package</a><ul> |
|
508 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
509 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
510 <li><a class="reference internal" href="#module-pyams_content.component.paragraph.container">pyams_content.component.paragraph.container module</a></li> |
|
511 <li><a class="reference internal" href="#module-pyams_content.component.paragraph.header">pyams_content.component.paragraph.header module</a></li> |
|
512 <li><a class="reference internal" href="#module-pyams_content.component.paragraph.html">pyams_content.component.paragraph.html module</a></li> |
|
513 <li><a class="reference internal" href="#module-pyams_content.component.paragraph.video">pyams_content.component.paragraph.video module</a></li> |
|
514 <li><a class="reference internal" href="#module-pyams_content.component.paragraph">Module contents</a></li> |
|
515 </ul> |
|
516 </li> |
|
517 </ul> |
|
518 |
|
519 <div id="searchbox" style="display: none" role="search"> |
|
520 <h3>Quick search</h3> |
|
521 <form class="search" action="search.html" method="get"> |
|
522 <div><input type="text" name="q" /></div> |
|
523 <div><input type="submit" value="Go" /></div> |
|
524 <input type="hidden" name="check_keywords" value="yes" /> |
|
525 <input type="hidden" name="area" value="default" /> |
|
526 </form> |
|
527 </div> |
|
528 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
529 </div> |
|
530 </div> |
|
531 <div class="clearer"></div> |
|
532 </div> |
|
533 <div class="related" role="navigation" aria-label="related navigation"> |
|
534 <h3>Navigation</h3> |
|
535 <ul> |
|
536 <li class="right" style="margin-right: 10px"> |
|
537 <a href="genindex.html" title="General Index" |
|
538 >index</a></li> |
|
539 <li class="right" > |
|
540 <a href="py-modindex.html" title="Python Module Index" |
|
541 >modules</a> |</li> |
|
542 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
543 </ul> |
|
544 </div> |
|
545 <div class="footer" role="contentinfo"> |
|
546 © Copyright 2017, Thierry Florac. |
|
547 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
548 </div> |
|
549 </body> |
|
550 </html> |