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

changeset 5837
9ef6a28f1694
parent 5414
7b937f8b31d0
child 5845
f3d2172d663e
--- a/Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html	Mon Aug 07 12:19:34 2017 +0200
+++ b/Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html	Mon Aug 07 18:00:51 2017 +0200
@@ -115,13 +115,20 @@
 </dd>
 </dl><a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a>
 <h4>PreviewProcessingThread.__convertMarkdown</h4>
-<b>__convertMarkdown</b>(<i>text</i>)
+<b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, htmlFormat</i>)
 <p>
         Private method to convert Markdown text into HTML.
 </p><dl>
 <dt><i>text</i></dt>
 <dd>
 text to be processed (string)
+</dd><dt><i>convertNewLineToBreak</i></dt>
+<dd>
+flag indicating to convert new lines
+            to HTML break (Markdown only) (boolean)
+</dd><dt><i>htmlFormat</i></dt>
+<dd>
+HTML format to be generated by markdown (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -130,7 +137,7 @@
 </dd>
 </dl><a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a>
 <h4>PreviewProcessingThread.__convertReST</h4>
-<b>__convertReST</b>(<i>text, useSphinx</i>)
+<b>__convertReST</b>(<i>text, useSphinx, restDocutilsHtmlFormat</i>)
 <p>
         Private method to convert ReST text into HTML.
 </p><dl>
@@ -141,6 +148,10 @@
 <dd>
 flag indicating to use Sphinx to generate the
             ReST preview (boolean)
+</dd><dt><i>restDocutilsHtmlFormat</i></dt>
+<dd>
+HTML format to be generated by docutils
+            (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -149,13 +160,16 @@
 </dd>
 </dl><a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a>
 <h4>PreviewProcessingThread.__convertReSTDocutils</h4>
-<b>__convertReSTDocutils</b>(<i>text</i>)
+<b>__convertReSTDocutils</b>(<i>text, htmlFormat</i>)
 <p>
         Private method to convert ReST text into HTML using 'docutils'.
 </p><dl>
 <dt><i>text</i></dt>
 <dd>
 text to be processed (string)
+</dd><dt><i>htmlFormat</i></dt>
+<dd>
+HTML format to be generated (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -179,7 +193,7 @@
 </dd>
 </dl><a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a>
 <h4>PreviewProcessingThread.__getHtml</h4>
-<b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx</i>)
+<b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
 <p>
         Private method to process the given text depending upon the given
         language.
@@ -204,6 +218,18 @@
 <dd>
 flag indicating to use Sphinx to generate the
             ReST preview (boolean)
+</dd><dt><i>convertNewLineToBreak</i></dt>
+<dd>
+flag indicating to convert new lines
+            to HTML break (Markdown only) (boolean)
+</dd><dt><i>markdownHtmlFormat</i></dt>
+<dd>
+HTML format to be generated by markdown
+            (string)
+</dd><dt><i>restDocutilsHtmlFormat</i></dt>
+<dd>
+HTML format to be generated by docutils
+            (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -236,7 +262,7 @@
 </dd>
 </dl><a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a>
 <h4>PreviewProcessingThread.process</h4>
-<b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx</i>)
+<b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
 <p>
         Public method to convert the given text to HTML.
 </p><dl>
@@ -260,6 +286,18 @@
 <dd>
 flag indicating to use Sphinx to generate the
             ReST preview (boolean)
+</dd><dt><i>convertNewLineToBreak</i></dt>
+<dd>
+flag indicating to convert new lines
+            to HTML break (Markdown only) (boolean)
+</dd><dt><i>markdownHtmlFormat</i></dt>
+<dd>
+HTML format to be generated by markdown
+            (string)
+</dd><dt><i>restDocutilsHtmlFormat</i></dt>
+<dd>
+HTML format to be generated by docutils
+            (string)
 </dd>
 </dl><a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a>
 <h4>PreviewProcessingThread.run</h4>

eric ide

mercurial