Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html

Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html

changeset 3979
307b09aae43b
parent 3673
e26d7d0c1088
child 4615
7c090c9d389d
child 4849
4eb0fba3b6c5
equal deleted inserted replaced
3978:59d99092a4de 3979:307b09aae43b
60 </dl> 60 </dl>
61 <h3>Derived from</h3> 61 <h3>Derived from</h3>
62 QThread 62 QThread
63 <h3>Class Attributes</h3> 63 <h3>Class Attributes</h3>
64 <table> 64 <table>
65 <tr><td>None</td></tr> 65 <tr><td>DefaultStaticPath</td></tr><tr><td>StaticRegexp</td></tr>
66 </table> 66 </table>
67 <h3>Class Methods</h3> 67 <h3>Class Methods</h3>
68 <table> 68 <table>
69 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
70 </table> 70 </table>
78 <td>Private method to convert Markdown text into HTML.</td> 78 <td>Private method to convert Markdown text into HTML.</td>
79 </tr><tr> 79 </tr><tr>
80 <td><a href="#PreviewProcessingThread.__convertReST">__convertReST</a></td> 80 <td><a href="#PreviewProcessingThread.__convertReST">__convertReST</a></td>
81 <td>Private method to convert ReST text into HTML.</td> 81 <td>Private method to convert ReST text into HTML.</td>
82 </tr><tr> 82 </tr><tr>
83 <td><a href="#PreviewProcessingThread.__convertReSTDocutils">__convertReSTDocutils</a></td>
84 <td>Private method to convert ReST text into HTML using 'docutils'.</td>
85 </tr><tr>
86 <td><a href="#PreviewProcessingThread.__convertReSTSphinx">__convertReSTSphinx</a></td>
87 <td>Private method to convert ReST text into HTML using 'sphinx'.</td>
88 </tr><tr>
83 <td><a href="#PreviewProcessingThread.__getHtml">__getHtml</a></td> 89 <td><a href="#PreviewProcessingThread.__getHtml">__getHtml</a></td>
84 <td>Private method to process the given text depending upon the given language.</td> 90 <td>Private method to process the given text depending upon the given language.</td>
85 </tr><tr> 91 </tr><tr>
86 <td><a href="#PreviewProcessingThread.__processSSI">__processSSI</a></td> 92 <td><a href="#PreviewProcessingThread.__processSSI">__processSSI</a></td>
87 <td>Private method to process the given text for SSI statements.</td> 93 <td>Private method to process the given text for SSI statements.</td>
88 </tr><tr> 94 </tr><tr>
89 <td><a href="#PreviewProcessingThread.process">process</a></td> 95 <td><a href="#PreviewProcessingThread.process">process</a></td>
90 <td>Public method to convert the given text to HTML.</td> 96 <td>Public method to convert the given text to HTML.</td>
97 </tr><tr>
98 <td><a href="#PreviewProcessingThread.replace">replace</a></td>
99 <td></td>
91 </tr><tr> 100 </tr><tr>
92 <td><a href="#PreviewProcessingThread.run">run</a></td> 101 <td><a href="#PreviewProcessingThread.run">run</a></td>
93 <td>Public thread method to convert the stored data.</td> 102 <td>Public thread method to convert the stored data.</td>
94 </tr> 103 </tr>
95 </table> 104 </table>
122 <dd> 131 <dd>
123 processed HTML (string) 132 processed HTML (string)
124 </dd> 133 </dd>
125 </dl><a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a> 134 </dl><a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a>
126 <h4>PreviewProcessingThread.__convertReST</h4> 135 <h4>PreviewProcessingThread.__convertReST</h4>
127 <b>__convertReST</b>(<i>text</i>) 136 <b>__convertReST</b>(<i>text, useSphinx</i>)
128 <p> 137 <p>
129 Private method to convert ReST text into HTML. 138 Private method to convert ReST text into HTML.
139 </p><dl>
140 <dt><i>text</i></dt>
141 <dd>
142 text to be processed (string)
143 </dd><dt><i>useSphinx</i></dt>
144 <dd>
145 flag indicating to use Sphinx to generate the
146 ReST preview (boolean)
147 </dd>
148 </dl><dl>
149 <dt>Returns:</dt>
150 <dd>
151 processed HTML (string)
152 </dd>
153 </dl><a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a>
154 <h4>PreviewProcessingThread.__convertReSTDocutils</h4>
155 <b>__convertReSTDocutils</b>(<i>text</i>)
156 <p>
157 Private method to convert ReST text into HTML using 'docutils'.
158 </p><dl>
159 <dt><i>text</i></dt>
160 <dd>
161 text to be processed (string)
162 </dd>
163 </dl><dl>
164 <dt>Returns:</dt>
165 <dd>
166 processed HTML (string)
167 </dd>
168 </dl><a NAME="PreviewProcessingThread.__convertReSTSphinx" ID="PreviewProcessingThread.__convertReSTSphinx"></a>
169 <h4>PreviewProcessingThread.__convertReSTSphinx</h4>
170 <b>__convertReSTSphinx</b>(<i>text</i>)
171 <p>
172 Private method to convert ReST text into HTML using 'sphinx'.
130 </p><dl> 173 </p><dl>
131 <dt><i>text</i></dt> 174 <dt><i>text</i></dt>
132 <dd> 175 <dd>
133 text to be processed (string) 176 text to be processed (string)
134 </dd> 177 </dd>
137 <dd> 180 <dd>
138 processed HTML (string) 181 processed HTML (string)
139 </dd> 182 </dd>
140 </dl><a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a> 183 </dl><a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a>
141 <h4>PreviewProcessingThread.__getHtml</h4> 184 <h4>PreviewProcessingThread.__getHtml</h4>
142 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath</i>) 185 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx</i>)
143 <p> 186 <p>
144 Private method to process the given text depending upon the given 187 Private method to process the given text depending upon the given
145 language. 188 language.
146 </p><dl> 189 </p><dl>
147 <dt><i>language</i></dt> 190 <dt><i>language</i></dt>
158 <dd> 201 <dd>
159 file path of the text (string) 202 file path of the text (string)
160 </dd><dt><i>rootPath</i></dt> 203 </dd><dt><i>rootPath</i></dt>
161 <dd> 204 <dd>
162 root path to be used for SSI processing (str) 205 root path to be used for SSI processing (str)
206 </dd><dt><i>useSphinx</i></dt>
207 <dd>
208 flag indicating to use Sphinx to generate the
209 ReST preview (boolean)
163 </dd> 210 </dd>
164 </dl><dl> 211 </dl><dl>
165 <dt>Returns:</dt> 212 <dt>Returns:</dt>
166 <dd> 213 <dd>
167 processed HTML text (string) 214 processed HTML text (string)
190 <dd> 237 <dd>
191 processed HTML (string) 238 processed HTML (string)
192 </dd> 239 </dd>
193 </dl><a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a> 240 </dl><a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a>
194 <h4>PreviewProcessingThread.process</h4> 241 <h4>PreviewProcessingThread.process</h4>
195 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath</i>) 242 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx</i>)
196 <p> 243 <p>
197 Public method to convert the given text to HTML. 244 Public method to convert the given text to HTML.
198 </p><dl> 245 </p><dl>
199 <dt><i>filePath</i></dt> 246 <dt><i>filePath</i></dt>
200 <dd> 247 <dd>
210 flag indicating to do some (limited) SSI processing 257 flag indicating to do some (limited) SSI processing
211 (boolean) 258 (boolean)
212 </dd><dt><i>rootPath</i></dt> 259 </dd><dt><i>rootPath</i></dt>
213 <dd> 260 <dd>
214 root path to be used for SSI processing (str) 261 root path to be used for SSI processing (str)
215 </dd> 262 </dd><dt><i>useSphinx</i></dt>
216 </dl><a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a> 263 <dd>
264 flag indicating to use Sphinx to generate the
265 ReST preview (boolean)
266 </dd>
267 </dl><a NAME="PreviewProcessingThread.replace" ID="PreviewProcessingThread.replace"></a>
268 <h4>PreviewProcessingThread.replace</h4>
269 <b>replace</b>(<i></i>)
270 <a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a>
217 <h4>PreviewProcessingThread.run</h4> 271 <h4>PreviewProcessingThread.run</h4>
218 <b>run</b>(<i></i>) 272 <b>run</b>(<i></i>)
219 <p> 273 <p>
220 Public thread method to convert the stored data. 274 Public thread method to convert the stored data.
221 </p> 275 </p>

Mercurial Repository: eric

eric ide

mercurial