Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.UI.CodeDocumentationViewerTemplate.html
eric6/Documentation/Source/eric6.UI.CodeDocumentationViewerTemplate.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7721
- 331ecfa0e716
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.UI.CodeDocumentationViewerTemplate</h1> | 23 <h1>eric6.UI.CodeDocumentationViewerTemplate</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing functions to prepare an HTML documentation view. | 26 Module implementing functions to prepare an HTML documentation view. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 32 <tr><td>None</td></tr> | 36 <tr><td>None</td></tr> |
| 33 </table> | 37 </table> |
| 34 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 | |
| 35 <table> | 40 <table> |
| 41 | |
| 36 <tr> | 42 <tr> |
| 37 <td><a href="#prepareDocumentationViewerHtmlDocWarningDocument">prepareDocumentationViewerHtmlDocWarningDocument</a></td> | 43 <td><a href="#prepareDocumentationViewerHtmlDocWarningDocument">prepareDocumentationViewerHtmlDocWarningDocument</a></td> |
| 38 <td>Public function to prepare a HTML warning document.</td> | 44 <td>Public function to prepare a HTML warning document.</td> |
| 39 </tr><tr> | 45 </tr> |
| 46 <tr> | |
| 40 <td><a href="#prepareDocumentationViewerHtmlDocument">prepareDocumentationViewerHtmlDocument</a></td> | 47 <td><a href="#prepareDocumentationViewerHtmlDocument">prepareDocumentationViewerHtmlDocument</a></td> |
| 41 <td>Public function to prepare the HTML document.</td> | 48 <td>Public function to prepare the HTML document.</td> |
| 42 </tr><tr> | 49 </tr> |
| 50 <tr> | |
| 43 <td><a href="#prepareDocumentationViewerHtmlWarningDocument">prepareDocumentationViewerHtmlWarningDocument</a></td> | 51 <td><a href="#prepareDocumentationViewerHtmlWarningDocument">prepareDocumentationViewerHtmlWarningDocument</a></td> |
| 44 <td>Public function to prepare a HTML warning document.</td> | 52 <td>Public function to prepare a HTML warning document.</td> |
| 45 </tr> | 53 </tr> |
| 46 </table> | 54 </table> |
| 47 <hr /><hr /> | 55 <hr /> |
| 56 <hr /> | |
| 48 <a NAME="prepareDocumentationViewerHtmlDocWarningDocument" ID="prepareDocumentationViewerHtmlDocWarningDocument"></a> | 57 <a NAME="prepareDocumentationViewerHtmlDocWarningDocument" ID="prepareDocumentationViewerHtmlDocWarningDocument"></a> |
| 49 <h2>prepareDocumentationViewerHtmlDocWarningDocument</h2> | 58 <h2>prepareDocumentationViewerHtmlDocWarningDocument</h2> |
| 50 <b>prepareDocumentationViewerHtmlDocWarningDocument</b>(<i>text</i>) | 59 <b>prepareDocumentationViewerHtmlDocWarningDocument</b>(<i>text</i>) |
| 60 | |
| 51 <p> | 61 <p> |
| 52 Public function to prepare a HTML warning document. | 62 Public function to prepare a HTML warning document. |
| 53 </p><dl> | 63 </p> |
| 64 <dl> | |
| 65 | |
| 54 <dt><i>text</i> (str)</dt> | 66 <dt><i>text</i> (str)</dt> |
| 55 <dd> | 67 <dd> |
| 56 warning text to be shown | 68 warning text to be shown |
| 57 </dd> | 69 </dd> |
| 58 </dl><dl> | 70 </dl> |
| 71 <dl> | |
| 59 <dt>Returns:</dt> | 72 <dt>Returns:</dt> |
| 60 <dd> | 73 <dd> |
| 61 prepared HTML document | 74 prepared HTML document |
| 62 </dd> | 75 </dd> |
| 63 </dl><dl> | 76 </dl> |
| 77 <dl> | |
| 64 <dt>Return Type:</dt> | 78 <dt>Return Type:</dt> |
| 65 <dd> | 79 <dd> |
| 66 str | 80 str |
| 67 </dd> | 81 </dd> |
| 68 </dl> | 82 </dl> |
| 69 <div align="right"><a href="#top">Up</a></div> | 83 <div align="right"><a href="#top">Up</a></div> |
| 70 <hr /><hr /> | 84 <hr /> |
| 85 <hr /> | |
| 71 <a NAME="prepareDocumentationViewerHtmlDocument" ID="prepareDocumentationViewerHtmlDocument"></a> | 86 <a NAME="prepareDocumentationViewerHtmlDocument" ID="prepareDocumentationViewerHtmlDocument"></a> |
| 72 <h2>prepareDocumentationViewerHtmlDocument</h2> | 87 <h2>prepareDocumentationViewerHtmlDocument</h2> |
| 73 <b>prepareDocumentationViewerHtmlDocument</b>(<i>documentationInfo</i>) | 88 <b>prepareDocumentationViewerHtmlDocument</b>(<i>documentationInfo</i>) |
| 89 | |
| 74 <p> | 90 <p> |
| 75 Public function to prepare the HTML document. | 91 Public function to prepare the HTML document. |
| 76 </p><dl> | 92 </p> |
| 93 <dl> | |
| 94 | |
| 77 <dt><i>documentationInfo</i> (dict)</dt> | 95 <dt><i>documentationInfo</i> (dict)</dt> |
| 78 <dd> | 96 <dd> |
| 79 dictionary containing the various documentation | 97 dictionary containing the various documentation |
| 80 parts | 98 parts |
| 81 </dd> | 99 </dd> |
| 82 </dl><dl> | 100 </dl> |
| 101 <dl> | |
| 83 <dt>Returns:</dt> | 102 <dt>Returns:</dt> |
| 84 <dd> | 103 <dd> |
| 85 prepared HTML document | 104 prepared HTML document |
| 86 </dd> | 105 </dd> |
| 87 </dl><dl> | 106 </dl> |
| 107 <dl> | |
| 88 <dt>Return Type:</dt> | 108 <dt>Return Type:</dt> |
| 89 <dd> | 109 <dd> |
| 90 str | 110 str |
| 91 </dd> | 111 </dd> |
| 92 </dl> | 112 </dl> |
| 93 <div align="right"><a href="#top">Up</a></div> | 113 <div align="right"><a href="#top">Up</a></div> |
| 94 <hr /><hr /> | 114 <hr /> |
| 115 <hr /> | |
| 95 <a NAME="prepareDocumentationViewerHtmlWarningDocument" ID="prepareDocumentationViewerHtmlWarningDocument"></a> | 116 <a NAME="prepareDocumentationViewerHtmlWarningDocument" ID="prepareDocumentationViewerHtmlWarningDocument"></a> |
| 96 <h2>prepareDocumentationViewerHtmlWarningDocument</h2> | 117 <h2>prepareDocumentationViewerHtmlWarningDocument</h2> |
| 97 <b>prepareDocumentationViewerHtmlWarningDocument</b>(<i>text</i>) | 118 <b>prepareDocumentationViewerHtmlWarningDocument</b>(<i>text</i>) |
| 119 | |
| 98 <p> | 120 <p> |
| 99 Public function to prepare a HTML warning document. | 121 Public function to prepare a HTML warning document. |
| 100 </p><dl> | 122 </p> |
| 123 <dl> | |
| 124 | |
| 101 <dt><i>text</i> (str)</dt> | 125 <dt><i>text</i> (str)</dt> |
| 102 <dd> | 126 <dd> |
| 103 warning text to be shown | 127 warning text to be shown |
| 104 </dd> | 128 </dd> |
| 105 </dl><dl> | 129 </dl> |
| 130 <dl> | |
| 106 <dt>Returns:</dt> | 131 <dt>Returns:</dt> |
| 107 <dd> | 132 <dd> |
| 108 prepared HTML document | 133 prepared HTML document |
| 109 </dd> | 134 </dd> |
| 110 </dl><dl> | 135 </dl> |
| 136 <dl> | |
| 111 <dt>Return Type:</dt> | 137 <dt>Return Type:</dt> |
| 112 <dd> | 138 <dd> |
| 113 str | 139 str |
| 114 </dd> | 140 </dd> |
| 115 </dl> | 141 </dl> |
