Documentation/Source/eric6.UI.CodeDocumentationViewerTemplate.html

<!DOCTYPE html>
<html><head>
<title>eric6.UI.CodeDocumentationViewerTemplate</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric6.UI.CodeDocumentationViewerTemplate</h1>
<p>
Module implementing functions to prepare an HTML documentation view.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#prepareDocumentationViewerHtmlDocWarningDocument">prepareDocumentationViewerHtmlDocWarningDocument</a></td>
<td>Public function to prepare a HTML warning document.</td>
</tr><tr>
<td><a href="#prepareDocumentationViewerHtmlDocument">prepareDocumentationViewerHtmlDocument</a></td>
<td>Public function to prepare the HTML document.</td>
</tr><tr>
<td><a href="#prepareDocumentationViewerHtmlWarningDocument">prepareDocumentationViewerHtmlWarningDocument</a></td>
<td>Public function to prepare a HTML warning document.</td>
</tr>
</table>
<hr /><hr />
<a NAME="prepareDocumentationViewerHtmlDocWarningDocument" ID="prepareDocumentationViewerHtmlDocWarningDocument"></a>
<h2>prepareDocumentationViewerHtmlDocWarningDocument</h2>
<b>prepareDocumentationViewerHtmlDocWarningDocument</b>(<i>text</i>)
<p>
    Public function to prepare a HTML warning document.
</p><dl>
<dt><i>text</i> (str)</dt>
<dd>
warning text to be shown
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
prepared HTML document
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="prepareDocumentationViewerHtmlDocument" ID="prepareDocumentationViewerHtmlDocument"></a>
<h2>prepareDocumentationViewerHtmlDocument</h2>
<b>prepareDocumentationViewerHtmlDocument</b>(<i>documentationInfo</i>)
<p>
    Public function to prepare the HTML document.
</p><dl>
<dt><i>documentationInfo</i> (dict)</dt>
<dd>
dictionary containing the various documentation
        parts
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
prepared HTML document
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="prepareDocumentationViewerHtmlWarningDocument" ID="prepareDocumentationViewerHtmlWarningDocument"></a>
<h2>prepareDocumentationViewerHtmlWarningDocument</h2>
<b>prepareDocumentationViewerHtmlWarningDocument</b>(<i>text</i>)
<p>
    Public function to prepare a HTML warning document.
</p><dl>
<dt><i>text</i> (str)</dt>
<dd>
warning text to be shown
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
prepared HTML document
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>