Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.UI.CodeDocumentationViewerTemplate.html
Documentation/Source/eric6.UI.CodeDocumentationViewerTemplate.html
- changeset 5926
- 69482290dbdd
equal
deleted
inserted
replaced
| 5925:0174aece0923 | 5926:69482290dbdd |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.UI.CodeDocumentationViewerTemplate</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.UI.CodeDocumentationViewerTemplate</h1> | |
| 23 <p> | |
| 24 Module implementing functions to prepare an HTML documentation view. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Functions</h3> | |
| 35 <table> | |
| 36 <tr> | |
| 37 <td><a href="#prepareDocumentationViewerHtmlDocWarningDocument">prepareDocumentationViewerHtmlDocWarningDocument</a></td> | |
| 38 <td>Public function to prepare a HTML warning document.</td> | |
| 39 </tr><tr> | |
| 40 <td><a href="#prepareDocumentationViewerHtmlDocument">prepareDocumentationViewerHtmlDocument</a></td> | |
| 41 <td>Public function to prepare the HTML document.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#prepareDocumentationViewerHtmlWarningDocument">prepareDocumentationViewerHtmlWarningDocument</a></td> | |
| 44 <td>Public function to prepare a HTML warning document.</td> | |
| 45 </tr> | |
| 46 </table> | |
| 47 <hr /><hr /> | |
| 48 <a NAME="prepareDocumentationViewerHtmlDocWarningDocument" ID="prepareDocumentationViewerHtmlDocWarningDocument"></a> | |
| 49 <h2>prepareDocumentationViewerHtmlDocWarningDocument</h2> | |
| 50 <b>prepareDocumentationViewerHtmlDocWarningDocument</b>(<i>text</i>) | |
| 51 <p> | |
| 52 Public function to prepare a HTML warning document. | |
| 53 </p><dl> | |
| 54 <dt><i>text</i> (str)</dt> | |
| 55 <dd> | |
| 56 warning text to be shown | |
| 57 </dd> | |
| 58 </dl><dl> | |
| 59 <dt>Returns:</dt> | |
| 60 <dd> | |
| 61 prepared HTML document | |
| 62 </dd> | |
| 63 </dl><dl> | |
| 64 <dt>Return Type:</dt> | |
| 65 <dd> | |
| 66 str | |
| 67 </dd> | |
| 68 </dl> | |
| 69 <div align="right"><a href="#top">Up</a></div> | |
| 70 <hr /><hr /> | |
| 71 <a NAME="prepareDocumentationViewerHtmlDocument" ID="prepareDocumentationViewerHtmlDocument"></a> | |
| 72 <h2>prepareDocumentationViewerHtmlDocument</h2> | |
| 73 <b>prepareDocumentationViewerHtmlDocument</b>(<i>documentationInfo</i>) | |
| 74 <p> | |
| 75 Public function to prepare the HTML document. | |
| 76 </p><dl> | |
| 77 <dt><i>documentationInfo</i> (dict)</dt> | |
| 78 <dd> | |
| 79 dictionary containing the various documentation | |
| 80 parts | |
| 81 </dd> | |
| 82 </dl><dl> | |
| 83 <dt>Returns:</dt> | |
| 84 <dd> | |
| 85 prepared HTML document | |
| 86 </dd> | |
| 87 </dl><dl> | |
| 88 <dt>Return Type:</dt> | |
| 89 <dd> | |
| 90 str | |
| 91 </dd> | |
| 92 </dl> | |
| 93 <div align="right"><a href="#top">Up</a></div> | |
| 94 <hr /><hr /> | |
| 95 <a NAME="prepareDocumentationViewerHtmlWarningDocument" ID="prepareDocumentationViewerHtmlWarningDocument"></a> | |
| 96 <h2>prepareDocumentationViewerHtmlWarningDocument</h2> | |
| 97 <b>prepareDocumentationViewerHtmlWarningDocument</b>(<i>text</i>) | |
| 98 <p> | |
| 99 Public function to prepare a HTML warning document. | |
| 100 </p><dl> | |
| 101 <dt><i>text</i> (str)</dt> | |
| 102 <dd> | |
| 103 warning text to be shown | |
| 104 </dd> | |
| 105 </dl><dl> | |
| 106 <dt>Returns:</dt> | |
| 107 <dd> | |
| 108 prepared HTML document | |
| 109 </dd> | |
| 110 </dl><dl> | |
| 111 <dt>Return Type:</dt> | |
| 112 <dd> | |
| 113 str | |
| 114 </dd> | |
| 115 </dl> | |
| 116 <div align="right"><a href="#top">Up</a></div> | |
| 117 <hr /> | |
| 118 </body></html> |
