Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.DocumentationTools.QtHelpGenerator.html
eric7/Documentation/Source/eric7.DocumentationTools.QtHelpGenerator.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.DocumentationTools.QtHelpGenerator</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.DocumentationTools.QtHelpGenerator</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the QtHelp generator for the builtin documentation | |
| 27 generator. | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>HelpCollection</td></tr><tr><td>HelpCollectionFile</td></tr><tr><td>HelpCollectionProjectFile</td></tr><tr><td>HelpHelpFile</td></tr><tr><td>HelpProject</td></tr><tr><td>HelpProjectFile</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 | |
| 36 <table> | |
| 37 | |
| 38 <tr> | |
| 39 <td><a href="#QtHelpGenerator">QtHelpGenerator</a></td> | |
| 40 <td>Class implementing the QtHelp generator for the builtin documentation generator.</td> | |
| 41 </tr> | |
| 42 </table> | |
| 43 <h3>Functions</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <hr /> | |
| 49 <hr /> | |
| 50 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a> | |
| 51 <h2>QtHelpGenerator</h2> | |
| 52 | |
| 53 <p> | |
| 54 Class implementing the QtHelp generator for the builtin documentation | |
| 55 generator. | |
| 56 </p> | |
| 57 <h3>Derived from</h3> | |
| 58 None | |
| 59 <h3>Class Attributes</h3> | |
| 60 | |
| 61 <table> | |
| 62 <tr><td>None</td></tr> | |
| 63 </table> | |
| 64 <h3>Class Methods</h3> | |
| 65 | |
| 66 <table> | |
| 67 <tr><td>None</td></tr> | |
| 68 </table> | |
| 69 <h3>Methods</h3> | |
| 70 | |
| 71 <table> | |
| 72 | |
| 73 <tr> | |
| 74 <td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td> | |
| 75 <td>Constructor</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#QtHelpGenerator.__convertEol">__convertEol</a></td> | |
| 79 <td>Private method to convert the newline characters.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td> | |
| 83 <td>Private method to generate the sections part.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td> | |
| 87 <td>Public method to generate all index files.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#QtHelpGenerator.remember">remember</a></td> | |
| 91 <td>Public method to remember a documentation file.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 | |
| 100 <a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a> | |
| 101 <h4>QtHelpGenerator (Constructor)</h4> | |
| 102 <b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection</i>) | |
| 103 | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p> | |
| 107 <dl> | |
| 108 | |
| 109 <dt><i>htmlDir</i></dt> | |
| 110 <dd> | |
| 111 directory containing the HTML files (string) | |
| 112 </dd> | |
| 113 <dt><i>outputDir</i></dt> | |
| 114 <dd> | |
| 115 output directory for the files (string) | |
| 116 </dd> | |
| 117 <dt><i>namespace</i></dt> | |
| 118 <dd> | |
| 119 namespace to be used (string) | |
| 120 </dd> | |
| 121 <dt><i>virtualFolder</i></dt> | |
| 122 <dd> | |
| 123 virtual folder to be used (string) | |
| 124 </dd> | |
| 125 <dt><i>filterName</i></dt> | |
| 126 <dd> | |
| 127 name of the custom filter (string) | |
| 128 </dd> | |
| 129 <dt><i>filterAttributes</i></dt> | |
| 130 <dd> | |
| 131 ':' separated list of filter attributes | |
| 132 (string) | |
| 133 </dd> | |
| 134 <dt><i>title</i></dt> | |
| 135 <dd> | |
| 136 title to be used for the generated help (string) | |
| 137 </dd> | |
| 138 <dt><i>createCollection</i></dt> | |
| 139 <dd> | |
| 140 flag indicating the generation of the | |
| 141 collection files (boolean) | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a> | |
| 145 <h4>QtHelpGenerator.__convertEol</h4> | |
| 146 <b>__convertEol</b>(<i>txt, newline</i>) | |
| 147 | |
| 148 <p> | |
| 149 Private method to convert the newline characters. | |
| 150 </p> | |
| 151 <dl> | |
| 152 | |
| 153 <dt><i>txt</i></dt> | |
| 154 <dd> | |
| 155 text to be converted (string) | |
| 156 </dd> | |
| 157 <dt><i>newline</i></dt> | |
| 158 <dd> | |
| 159 newline character to be used (string) | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <dl> | |
| 163 <dt>Return:</dt> | |
| 164 <dd> | |
| 165 converted text (string) | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> | |
| 169 <h4>QtHelpGenerator.__generateSections</h4> | |
| 170 <b>__generateSections</b>(<i>package, level</i>) | |
| 171 | |
| 172 <p> | |
| 173 Private method to generate the sections part. | |
| 174 </p> | |
| 175 <dl> | |
| 176 | |
| 177 <dt><i>package</i></dt> | |
| 178 <dd> | |
| 179 name of the package to process (string) | |
| 180 </dd> | |
| 181 <dt><i>level</i></dt> | |
| 182 <dd> | |
| 183 indentation level (integer) | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <dl> | |
| 187 <dt>Return:</dt> | |
| 188 <dd> | |
| 189 sections part (string) | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> | |
| 193 <h4>QtHelpGenerator.generateFiles</h4> | |
| 194 <b>generateFiles</b>(<i>basename="", newline=None</i>) | |
| 195 | |
| 196 <p> | |
| 197 Public method to generate all index files. | |
| 198 </p> | |
| 199 <dl> | |
| 200 | |
| 201 <dt><i>basename</i></dt> | |
| 202 <dd> | |
| 203 The basename of the file hierarchy to be documented. | |
| 204 The basename is stripped off the filename if it starts with | |
| 205 the basename. | |
| 206 </dd> | |
| 207 <dt><i>newline</i></dt> | |
| 208 <dd> | |
| 209 newline character to be used (string) | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> | |
| 213 <h4>QtHelpGenerator.remember</h4> | |
| 214 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | |
| 215 | |
| 216 <p> | |
| 217 Public method to remember a documentation file. | |
| 218 </p> | |
| 219 <dl> | |
| 220 | |
| 221 <dt><i>file</i></dt> | |
| 222 <dd> | |
| 223 The filename to be remembered. (string) | |
| 224 </dd> | |
| 225 <dt><i>moduleDocument</i></dt> | |
| 226 <dd> | |
| 227 The ModuleDocument object containing the | |
| 228 information for the file. | |
| 229 </dd> | |
| 230 <dt><i>basename</i></dt> | |
| 231 <dd> | |
| 232 The basename of the file hierarchy to be documented. | |
| 233 The basename is stripped off the filename if it starts with | |
| 234 the basename. | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <div align="right"><a href="#top">Up</a></div> | |
| 238 <hr /> | |
| 239 </body></html> |
