src/eric7/Documentation/Source/eric7.UI.CodeDocumentationViewerTemplate.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.UI.CodeDocumentationViewerTemplate</h1> 9 <h1>eric7.UI.CodeDocumentationViewerTemplate</h1>
10
11 <p> 10 <p>
12 Module implementing functions to prepare an HTML documentation view. 11 Module implementing functions to prepare an HTML documentation view.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>_stylesheetsCache</td></tr> 16 <tr><td>_stylesheetsCache</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22 <tr><td>None</td></tr> 21 <tr><td>None</td></tr>
23 </table> 22 </table>
23
24 <h3>Functions</h3> 24 <h3>Functions</h3>
25
26 <table> 25 <table>
27
28 <tr> 26 <tr>
29 <td><a href="#_stylesheet">_stylesheet</a></td> 27 <td><a href="#_stylesheet">_stylesheet</a></td>
30 <td>Function to get the stylesheet matching the desktop environment.</td> 28 <td>Function to get the stylesheet matching the desktop environment.</td>
31 </tr> 29 </tr>
32 <tr> 30 <tr>
40 <tr> 38 <tr>
41 <td><a href="#prepareDocumentationViewerHtmlWarningDocument">prepareDocumentationViewerHtmlWarningDocument</a></td> 39 <td><a href="#prepareDocumentationViewerHtmlWarningDocument">prepareDocumentationViewerHtmlWarningDocument</a></td>
42 <td>Public function to prepare a HTML warning document.</td> 40 <td>Public function to prepare a HTML warning document.</td>
43 </tr> 41 </tr>
44 </table> 42 </table>
43
45 <hr /> 44 <hr />
46 <hr /> 45 <hr />
47 <a NAME="_stylesheet" ID="_stylesheet"></a> 46 <a NAME="_stylesheet" ID="_stylesheet"></a>
48 <h2>_stylesheet</h2> 47 <h2>_stylesheet</h2>
49 <b>_stylesheet</b>(<i></i>) 48 <b>_stylesheet</b>(<i></i>)
50
51 <p> 49 <p>
52 Function to get the stylesheet matching the desktop environment. 50 Function to get the stylesheet matching the desktop environment.
53 </p> 51 </p>
52
54 <dl> 53 <dl>
55 <dt>Return:</dt> 54 <dt>Return:</dt>
56 <dd> 55 <dd>
57 stylesheet 56 stylesheet
58 </dd> 57 </dd>
67 <hr /> 66 <hr />
68 <hr /> 67 <hr />
69 <a NAME="prepareDocumentationViewerHtmlDocWarningDocument" ID="prepareDocumentationViewerHtmlDocWarningDocument"></a> 68 <a NAME="prepareDocumentationViewerHtmlDocWarningDocument" ID="prepareDocumentationViewerHtmlDocWarningDocument"></a>
70 <h2>prepareDocumentationViewerHtmlDocWarningDocument</h2> 69 <h2>prepareDocumentationViewerHtmlDocWarningDocument</h2>
71 <b>prepareDocumentationViewerHtmlDocWarningDocument</b>(<i>text</i>) 70 <b>prepareDocumentationViewerHtmlDocWarningDocument</b>(<i>text</i>)
72
73 <p> 71 <p>
74 Public function to prepare a HTML warning document. 72 Public function to prepare a HTML warning document.
75 </p> 73 </p>
74
76 <dl> 75 <dl>
77 76
78 <dt><i>text</i> (str)</dt> 77 <dt><i>text</i> (str)</dt>
79 <dd> 78 <dd>
80 warning text to be shown 79 warning text to be shown
96 <hr /> 95 <hr />
97 <hr /> 96 <hr />
98 <a NAME="prepareDocumentationViewerHtmlDocument" ID="prepareDocumentationViewerHtmlDocument"></a> 97 <a NAME="prepareDocumentationViewerHtmlDocument" ID="prepareDocumentationViewerHtmlDocument"></a>
99 <h2>prepareDocumentationViewerHtmlDocument</h2> 98 <h2>prepareDocumentationViewerHtmlDocument</h2>
100 <b>prepareDocumentationViewerHtmlDocument</b>(<i>documentationInfo</i>) 99 <b>prepareDocumentationViewerHtmlDocument</b>(<i>documentationInfo</i>)
101
102 <p> 100 <p>
103 Public function to prepare the HTML document. 101 Public function to prepare the HTML document.
104 </p> 102 </p>
103
105 <dl> 104 <dl>
106 105
107 <dt><i>documentationInfo</i> (dict)</dt> 106 <dt><i>documentationInfo</i> (dict)</dt>
108 <dd> 107 <dd>
109 dictionary containing the various documentation 108 dictionary containing the various documentation
126 <hr /> 125 <hr />
127 <hr /> 126 <hr />
128 <a NAME="prepareDocumentationViewerHtmlWarningDocument" ID="prepareDocumentationViewerHtmlWarningDocument"></a> 127 <a NAME="prepareDocumentationViewerHtmlWarningDocument" ID="prepareDocumentationViewerHtmlWarningDocument"></a>
129 <h2>prepareDocumentationViewerHtmlWarningDocument</h2> 128 <h2>prepareDocumentationViewerHtmlWarningDocument</h2>
130 <b>prepareDocumentationViewerHtmlWarningDocument</b>(<i>text</i>) 129 <b>prepareDocumentationViewerHtmlWarningDocument</b>(<i>text</i>)
131
132 <p> 130 <p>
133 Public function to prepare a HTML warning document. 131 Public function to prepare a HTML warning document.
134 </p> 132 </p>
133
135 <dl> 134 <dl>
136 135
137 <dt><i>text</i> (str)</dt> 136 <dt><i>text</i> (str)</dt>
138 <dd> 137 <dd>
139 warning text to be shown 138 warning text to be shown

eric ide

mercurial