Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.UI.CodeDocumentationViewerTemplate.html
eric7/Documentation/Source/eric7.UI.CodeDocumentationViewerTemplate.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.UI.CodeDocumentationViewerTemplate</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing functions to prepare an HTML documentation view. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>_stylesheetsCache</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 | |
| 40 <table> | |
| 41 | |
| 42 <tr> | |
| 43 <td><a href="#_stylesheet">_stylesheet</a></td> | |
| 44 <td>Function to get the stylesheet matching the desktop environment.</td> | |
| 45 </tr> | |
| 46 <tr> | |
| 47 <td><a href="#prepareDocumentationViewerHtmlDocWarningDocument">prepareDocumentationViewerHtmlDocWarningDocument</a></td> | |
| 48 <td>Public function to prepare a HTML warning document.</td> | |
| 49 </tr> | |
| 50 <tr> | |
| 51 <td><a href="#prepareDocumentationViewerHtmlDocument">prepareDocumentationViewerHtmlDocument</a></td> | |
| 52 <td>Public function to prepare the HTML document.</td> | |
| 53 </tr> | |
| 54 <tr> | |
| 55 <td><a href="#prepareDocumentationViewerHtmlWarningDocument">prepareDocumentationViewerHtmlWarningDocument</a></td> | |
| 56 <td>Public function to prepare a HTML warning document.</td> | |
| 57 </tr> | |
| 58 </table> | |
| 59 <hr /> | |
| 60 <hr /> | |
| 61 <a NAME="_stylesheet" ID="_stylesheet"></a> | |
| 62 <h2>_stylesheet</h2> | |
| 63 <b>_stylesheet</b>(<i></i>) | |
| 64 | |
| 65 <p> | |
| 66 Function to get the stylesheet matching the desktop environment. | |
| 67 </p> | |
| 68 <dl> | |
| 69 <dt>Return:</dt> | |
| 70 <dd> | |
| 71 stylesheet | |
| 72 </dd> | |
| 73 </dl> | |
| 74 <dl> | |
| 75 <dt>Return Type:</dt> | |
| 76 <dd> | |
| 77 str | |
| 78 </dd> | |
| 79 </dl> | |
| 80 <div align="right"><a href="#top">Up</a></div> | |
| 81 <hr /> | |
| 82 <hr /> | |
| 83 <a NAME="prepareDocumentationViewerHtmlDocWarningDocument" ID="prepareDocumentationViewerHtmlDocWarningDocument"></a> | |
| 84 <h2>prepareDocumentationViewerHtmlDocWarningDocument</h2> | |
| 85 <b>prepareDocumentationViewerHtmlDocWarningDocument</b>(<i>text</i>) | |
| 86 | |
| 87 <p> | |
| 88 Public function to prepare a HTML warning document. | |
| 89 </p> | |
| 90 <dl> | |
| 91 | |
| 92 <dt><i>text</i> (str)</dt> | |
| 93 <dd> | |
| 94 warning text to be shown | |
| 95 </dd> | |
| 96 </dl> | |
| 97 <dl> | |
| 98 <dt>Return:</dt> | |
| 99 <dd> | |
| 100 prepared HTML document | |
| 101 </dd> | |
| 102 </dl> | |
| 103 <dl> | |
| 104 <dt>Return Type:</dt> | |
| 105 <dd> | |
| 106 str | |
| 107 </dd> | |
| 108 </dl> | |
| 109 <div align="right"><a href="#top">Up</a></div> | |
| 110 <hr /> | |
| 111 <hr /> | |
| 112 <a NAME="prepareDocumentationViewerHtmlDocument" ID="prepareDocumentationViewerHtmlDocument"></a> | |
| 113 <h2>prepareDocumentationViewerHtmlDocument</h2> | |
| 114 <b>prepareDocumentationViewerHtmlDocument</b>(<i>documentationInfo</i>) | |
| 115 | |
| 116 <p> | |
| 117 Public function to prepare the HTML document. | |
| 118 </p> | |
| 119 <dl> | |
| 120 | |
| 121 <dt><i>documentationInfo</i> (dict)</dt> | |
| 122 <dd> | |
| 123 dictionary containing the various documentation | |
| 124 parts | |
| 125 </dd> | |
| 126 </dl> | |
| 127 <dl> | |
| 128 <dt>Return:</dt> | |
| 129 <dd> | |
| 130 prepared HTML document | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return Type:</dt> | |
| 135 <dd> | |
| 136 str | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <div align="right"><a href="#top">Up</a></div> | |
| 140 <hr /> | |
| 141 <hr /> | |
| 142 <a NAME="prepareDocumentationViewerHtmlWarningDocument" ID="prepareDocumentationViewerHtmlWarningDocument"></a> | |
| 143 <h2>prepareDocumentationViewerHtmlWarningDocument</h2> | |
| 144 <b>prepareDocumentationViewerHtmlWarningDocument</b>(<i>text</i>) | |
| 145 | |
| 146 <p> | |
| 147 Public function to prepare a HTML warning document. | |
| 148 </p> | |
| 149 <dl> | |
| 150 | |
| 151 <dt><i>text</i> (str)</dt> | |
| 152 <dd> | |
| 153 warning text to be shown | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <dl> | |
| 157 <dt>Return:</dt> | |
| 158 <dd> | |
| 159 prepared HTML document | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <dl> | |
| 163 <dt>Return Type:</dt> | |
| 164 <dd> | |
| 165 str | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <div align="right"><a href="#top">Up</a></div> | |
| 169 <hr /> | |
| 170 </body></html> |
