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