--- a/src/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.MarkdownProvider.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.MarkdownProvider.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,57 +7,53 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.MarkupProviders.MarkdownProvider</h1>
-
<p>
Module implementing the Markdown markup provider.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MarkdownProvider">MarkdownProvider</a></td>
<td>Class implementing the Markdown markup provider.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#createProvider">createProvider</a></td>
<td>Function to instantiate a markup provider object.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="MarkdownProvider" ID="MarkdownProvider"></a>
<h2>MarkdownProvider</h2>
-
<p>
Class implementing the Markdown markup provider.
</p>
+
<h3>Derived from</h3>
MarkupBase
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#MarkdownProvider.__init__">MarkdownProvider</a></td>
<td>Constructor</td>
@@ -171,23 +167,23 @@
<td>Public method to generate strikethrough text.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MarkdownProvider.__init__" ID="MarkdownProvider.__init__"></a>
<h4>MarkdownProvider (Constructor)</h4>
<b>MarkdownProvider</b>(<i></i>)
-
<p>
Constructor
</p>
+
<a NAME="MarkdownProvider.__insertMarkup" ID="MarkdownProvider.__insertMarkup"></a>
<h4>MarkdownProvider.__insertMarkup</h4>
<b>__insertMarkup</b>(<i>markup, editor</i>)
-
<p>
Private method to insert the specified markup.
</p>
@@ -196,6 +192,7 @@
markup. If no text is selected, the markup is inserted at the cursor
position and the cursor is positioned in between.
</p>
+
<dl>
<dt><i>markup</i> (str)</dt>
@@ -210,10 +207,10 @@
<a NAME="MarkdownProvider.__makeList" ID="MarkdownProvider.__makeList"></a>
<h4>MarkdownProvider.__makeList</h4>
<b>__makeList</b>(<i>editor, numberedList</i>)
-
<p>
Private method to generate the desired list markup.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -228,10 +225,10 @@
<a NAME="MarkdownProvider.bold" ID="MarkdownProvider.bold"></a>
<h4>MarkdownProvider.bold</h4>
<b>bold</b>(<i>editor</i>)
-
<p>
Public method to generate bold text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -242,10 +239,10 @@
<a NAME="MarkdownProvider.bulletedList" ID="MarkdownProvider.bulletedList"></a>
<h4>MarkdownProvider.bulletedList</h4>
<b>bulletedList</b>(<i>editor</i>)
-
<p>
Public method to generate bulleted list text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -256,10 +253,10 @@
<a NAME="MarkdownProvider.code" ID="MarkdownProvider.code"></a>
<h4>MarkdownProvider.code</h4>
<b>code</b>(<i>editor</i>)
-
<p>
Public method to generate inline code text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -270,10 +267,10 @@
<a NAME="MarkdownProvider.codeBlock" ID="MarkdownProvider.codeBlock"></a>
<h4>MarkdownProvider.codeBlock</h4>
<b>codeBlock</b>(<i>editor</i>)
-
<p>
Public method to generate code block text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -284,10 +281,10 @@
<a NAME="MarkdownProvider.hasBold" ID="MarkdownProvider.hasBold"></a>
<h4>MarkdownProvider.hasBold</h4>
<b>hasBold</b>(<i></i>)
-
<p>
Public method to indicate the availability of bold markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -303,10 +300,10 @@
<a NAME="MarkdownProvider.hasBulletedList" ID="MarkdownProvider.hasBulletedList"></a>
<h4>MarkdownProvider.hasBulletedList</h4>
<b>hasBulletedList</b>(<i></i>)
-
<p>
Public method to indicate the availability of bulleted list markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -322,10 +319,10 @@
<a NAME="MarkdownProvider.hasCode" ID="MarkdownProvider.hasCode"></a>
<h4>MarkdownProvider.hasCode</h4>
<b>hasCode</b>(<i></i>)
-
<p>
Public method to indicate the availability of inline code markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -341,10 +338,10 @@
<a NAME="MarkdownProvider.hasCodeBlock" ID="MarkdownProvider.hasCodeBlock"></a>
<h4>MarkdownProvider.hasCodeBlock</h4>
<b>hasCodeBlock</b>(<i></i>)
-
<p>
Public method to indicate the availability of code block markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -360,10 +357,10 @@
<a NAME="MarkdownProvider.hasHyperlink" ID="MarkdownProvider.hasHyperlink"></a>
<h4>MarkdownProvider.hasHyperlink</h4>
<b>hasHyperlink</b>(<i></i>)
-
<p>
Public method to indicate the availability of hyperlink markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -379,10 +376,10 @@
<a NAME="MarkdownProvider.hasImage" ID="MarkdownProvider.hasImage"></a>
<h4>MarkdownProvider.hasImage</h4>
<b>hasImage</b>(<i></i>)
-
<p>
Public method to indicate the availability of image markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -398,10 +395,10 @@
<a NAME="MarkdownProvider.hasItalic" ID="MarkdownProvider.hasItalic"></a>
<h4>MarkdownProvider.hasItalic</h4>
<b>hasItalic</b>(<i></i>)
-
<p>
Public method to indicate the availability of italic markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -417,10 +414,10 @@
<a NAME="MarkdownProvider.hasLine" ID="MarkdownProvider.hasLine"></a>
<h4>MarkdownProvider.hasLine</h4>
<b>hasLine</b>(<i></i>)
-
<p>
Public method to indicate the availability of a horizontal line markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -436,10 +433,10 @@
<a NAME="MarkdownProvider.hasNumberedList" ID="MarkdownProvider.hasNumberedList"></a>
<h4>MarkdownProvider.hasNumberedList</h4>
<b>hasNumberedList</b>(<i></i>)
-
<p>
Public method to indicate the availability of numbered list markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -455,10 +452,10 @@
<a NAME="MarkdownProvider.hasQuote" ID="MarkdownProvider.hasQuote"></a>
<h4>MarkdownProvider.hasQuote</h4>
<b>hasQuote</b>(<i></i>)
-
<p>
Public method to indicate the availability of block quote markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -474,10 +471,10 @@
<a NAME="MarkdownProvider.hasStrikethrough" ID="MarkdownProvider.hasStrikethrough"></a>
<h4>MarkdownProvider.hasStrikethrough</h4>
<b>hasStrikethrough</b>(<i></i>)
-
<p>
Public method to indicate the availability of strikethrough markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -493,10 +490,10 @@
<a NAME="MarkdownProvider.header" ID="MarkdownProvider.header"></a>
<h4>MarkdownProvider.header</h4>
<b>header</b>(<i>editor, level</i>)
-
<p>
Public method to generate a header.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -511,10 +508,10 @@
<a NAME="MarkdownProvider.headerLevels" ID="MarkdownProvider.headerLevels"></a>
<h4>MarkdownProvider.headerLevels</h4>
<b>headerLevels</b>(<i></i>)
-
<p>
Public method to determine the available header levels.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -530,10 +527,10 @@
<a NAME="MarkdownProvider.hyperlink" ID="MarkdownProvider.hyperlink"></a>
<h4>MarkdownProvider.hyperlink</h4>
<b>hyperlink</b>(<i>editor</i>)
-
<p>
Public method to generate hyperlink text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -544,10 +541,10 @@
<a NAME="MarkdownProvider.image" ID="MarkdownProvider.image"></a>
<h4>MarkdownProvider.image</h4>
<b>image</b>(<i>editor</i>)
-
<p>
Public method to generate image text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -558,10 +555,10 @@
<a NAME="MarkdownProvider.italic" ID="MarkdownProvider.italic"></a>
<h4>MarkdownProvider.italic</h4>
<b>italic</b>(<i>editor</i>)
-
<p>
Public method to generate italic text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -572,10 +569,10 @@
<a NAME="MarkdownProvider.kind" ID="MarkdownProvider.kind"></a>
<h4>MarkdownProvider.kind</h4>
<b>kind</b>(<i></i>)
-
<p>
Public method to get the markup kind.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -591,10 +588,10 @@
<a NAME="MarkdownProvider.line" ID="MarkdownProvider.line"></a>
<h4>MarkdownProvider.line</h4>
<b>line</b>(<i>editor</i>)
-
<p>
Public method to generate a horizontal line text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -605,10 +602,10 @@
<a NAME="MarkdownProvider.numberedList" ID="MarkdownProvider.numberedList"></a>
<h4>MarkdownProvider.numberedList</h4>
<b>numberedList</b>(<i>editor</i>)
-
<p>
Public method to generate numbered list text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -619,10 +616,10 @@
<a NAME="MarkdownProvider.quote" ID="MarkdownProvider.quote"></a>
<h4>MarkdownProvider.quote</h4>
<b>quote</b>(<i>editor</i>)
-
<p>
Public method to generate block quote text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -633,10 +630,10 @@
<a NAME="MarkdownProvider.strikethrough" ID="MarkdownProvider.strikethrough"></a>
<h4>MarkdownProvider.strikethrough</h4>
<b>strikethrough</b>(<i>editor</i>)
-
<p>
Public method to generate strikethrough text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -650,10 +647,10 @@
<a NAME="createProvider" ID="createProvider"></a>
<h2>createProvider</h2>
<b>createProvider</b>(<i></i>)
-
<p>
Function to instantiate a markup provider object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -668,4 +665,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
