Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html
Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html
- changeset 5837
- 9ef6a28f1694
- parent 5414
- 7b937f8b31d0
- child 5845
- f3d2172d663e
equal
deleted
inserted
replaced
| 5836:159e6057ad34 | 5837:9ef6a28f1694 |
|---|---|
| 113 <dd> | 113 <dd> |
| 114 reference to the parent object (QObject) | 114 reference to the parent object (QObject) |
| 115 </dd> | 115 </dd> |
| 116 </dl><a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a> | 116 </dl><a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a> |
| 117 <h4>PreviewProcessingThread.__convertMarkdown</h4> | 117 <h4>PreviewProcessingThread.__convertMarkdown</h4> |
| 118 <b>__convertMarkdown</b>(<i>text</i>) | 118 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, htmlFormat</i>) |
| 119 <p> | 119 <p> |
| 120 Private method to convert Markdown text into HTML. | 120 Private method to convert Markdown text into HTML. |
| 121 </p><dl> | 121 </p><dl> |
| 122 <dt><i>text</i></dt> | 122 <dt><i>text</i></dt> |
| 123 <dd> | 123 <dd> |
| 124 text to be processed (string) | 124 text to be processed (string) |
| 125 </dd><dt><i>convertNewLineToBreak</i></dt> | |
| 126 <dd> | |
| 127 flag indicating to convert new lines | |
| 128 to HTML break (Markdown only) (boolean) | |
| 129 </dd><dt><i>htmlFormat</i></dt> | |
| 130 <dd> | |
| 131 HTML format to be generated by markdown (string) | |
| 125 </dd> | 132 </dd> |
| 126 </dl><dl> | 133 </dl><dl> |
| 127 <dt>Returns:</dt> | 134 <dt>Returns:</dt> |
| 128 <dd> | 135 <dd> |
| 129 processed HTML (string) | 136 processed HTML (string) |
| 130 </dd> | 137 </dd> |
| 131 </dl><a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a> | 138 </dl><a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a> |
| 132 <h4>PreviewProcessingThread.__convertReST</h4> | 139 <h4>PreviewProcessingThread.__convertReST</h4> |
| 133 <b>__convertReST</b>(<i>text, useSphinx</i>) | 140 <b>__convertReST</b>(<i>text, useSphinx, restDocutilsHtmlFormat</i>) |
| 134 <p> | 141 <p> |
| 135 Private method to convert ReST text into HTML. | 142 Private method to convert ReST text into HTML. |
| 136 </p><dl> | 143 </p><dl> |
| 137 <dt><i>text</i></dt> | 144 <dt><i>text</i></dt> |
| 138 <dd> | 145 <dd> |
| 139 text to be processed (string) | 146 text to be processed (string) |
| 140 </dd><dt><i>useSphinx</i></dt> | 147 </dd><dt><i>useSphinx</i></dt> |
| 141 <dd> | 148 <dd> |
| 142 flag indicating to use Sphinx to generate the | 149 flag indicating to use Sphinx to generate the |
| 143 ReST preview (boolean) | 150 ReST preview (boolean) |
| 151 </dd><dt><i>restDocutilsHtmlFormat</i></dt> | |
| 152 <dd> | |
| 153 HTML format to be generated by docutils | |
| 154 (string) | |
| 144 </dd> | 155 </dd> |
| 145 </dl><dl> | 156 </dl><dl> |
| 146 <dt>Returns:</dt> | 157 <dt>Returns:</dt> |
| 147 <dd> | 158 <dd> |
| 148 processed HTML (string) | 159 processed HTML (string) |
| 149 </dd> | 160 </dd> |
| 150 </dl><a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a> | 161 </dl><a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a> |
| 151 <h4>PreviewProcessingThread.__convertReSTDocutils</h4> | 162 <h4>PreviewProcessingThread.__convertReSTDocutils</h4> |
| 152 <b>__convertReSTDocutils</b>(<i>text</i>) | 163 <b>__convertReSTDocutils</b>(<i>text, htmlFormat</i>) |
| 153 <p> | 164 <p> |
| 154 Private method to convert ReST text into HTML using 'docutils'. | 165 Private method to convert ReST text into HTML using 'docutils'. |
| 155 </p><dl> | 166 </p><dl> |
| 156 <dt><i>text</i></dt> | 167 <dt><i>text</i></dt> |
| 157 <dd> | 168 <dd> |
| 158 text to be processed (string) | 169 text to be processed (string) |
| 170 </dd><dt><i>htmlFormat</i></dt> | |
| 171 <dd> | |
| 172 HTML format to be generated (string) | |
| 159 </dd> | 173 </dd> |
| 160 </dl><dl> | 174 </dl><dl> |
| 161 <dt>Returns:</dt> | 175 <dt>Returns:</dt> |
| 162 <dd> | 176 <dd> |
| 163 processed HTML (string) | 177 processed HTML (string) |
| 177 <dd> | 191 <dd> |
| 178 processed HTML (string) | 192 processed HTML (string) |
| 179 </dd> | 193 </dd> |
| 180 </dl><a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a> | 194 </dl><a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a> |
| 181 <h4>PreviewProcessingThread.__getHtml</h4> | 195 <h4>PreviewProcessingThread.__getHtml</h4> |
| 182 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx</i>) | 196 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>) |
| 183 <p> | 197 <p> |
| 184 Private method to process the given text depending upon the given | 198 Private method to process the given text depending upon the given |
| 185 language. | 199 language. |
| 186 </p><dl> | 200 </p><dl> |
| 187 <dt><i>language</i></dt> | 201 <dt><i>language</i></dt> |
| 202 root path to be used for SSI processing (str) | 216 root path to be used for SSI processing (str) |
| 203 </dd><dt><i>useSphinx</i></dt> | 217 </dd><dt><i>useSphinx</i></dt> |
| 204 <dd> | 218 <dd> |
| 205 flag indicating to use Sphinx to generate the | 219 flag indicating to use Sphinx to generate the |
| 206 ReST preview (boolean) | 220 ReST preview (boolean) |
| 221 </dd><dt><i>convertNewLineToBreak</i></dt> | |
| 222 <dd> | |
| 223 flag indicating to convert new lines | |
| 224 to HTML break (Markdown only) (boolean) | |
| 225 </dd><dt><i>markdownHtmlFormat</i></dt> | |
| 226 <dd> | |
| 227 HTML format to be generated by markdown | |
| 228 (string) | |
| 229 </dd><dt><i>restDocutilsHtmlFormat</i></dt> | |
| 230 <dd> | |
| 231 HTML format to be generated by docutils | |
| 232 (string) | |
| 207 </dd> | 233 </dd> |
| 208 </dl><dl> | 234 </dl><dl> |
| 209 <dt>Returns:</dt> | 235 <dt>Returns:</dt> |
| 210 <dd> | 236 <dd> |
| 211 processed HTML text (string) | 237 processed HTML text (string) |
| 234 <dd> | 260 <dd> |
| 235 processed HTML (string) | 261 processed HTML (string) |
| 236 </dd> | 262 </dd> |
| 237 </dl><a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a> | 263 </dl><a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a> |
| 238 <h4>PreviewProcessingThread.process</h4> | 264 <h4>PreviewProcessingThread.process</h4> |
| 239 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx</i>) | 265 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>) |
| 240 <p> | 266 <p> |
| 241 Public method to convert the given text to HTML. | 267 Public method to convert the given text to HTML. |
| 242 </p><dl> | 268 </p><dl> |
| 243 <dt><i>filePath</i></dt> | 269 <dt><i>filePath</i></dt> |
| 244 <dd> | 270 <dd> |
| 258 root path to be used for SSI processing (str) | 284 root path to be used for SSI processing (str) |
| 259 </dd><dt><i>useSphinx</i></dt> | 285 </dd><dt><i>useSphinx</i></dt> |
| 260 <dd> | 286 <dd> |
| 261 flag indicating to use Sphinx to generate the | 287 flag indicating to use Sphinx to generate the |
| 262 ReST preview (boolean) | 288 ReST preview (boolean) |
| 289 </dd><dt><i>convertNewLineToBreak</i></dt> | |
| 290 <dd> | |
| 291 flag indicating to convert new lines | |
| 292 to HTML break (Markdown only) (boolean) | |
| 293 </dd><dt><i>markdownHtmlFormat</i></dt> | |
| 294 <dd> | |
| 295 HTML format to be generated by markdown | |
| 296 (string) | |
| 297 </dd><dt><i>restDocutilsHtmlFormat</i></dt> | |
| 298 <dd> | |
| 299 HTML format to be generated by docutils | |
| 300 (string) | |
| 263 </dd> | 301 </dd> |
| 264 </dl><a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a> | 302 </dl><a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a> |
| 265 <h4>PreviewProcessingThread.run</h4> | 303 <h4>PreviewProcessingThread.run</h4> |
| 266 <b>run</b>(<i></i>) | 304 <b>run</b>(<i></i>) |
| 267 <p> | 305 <p> |
