Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.DocumentationTools.QtHelpGenerator.html
Documentation/Source/eric6.DocumentationTools.QtHelpGenerator.html
- changeset 3673
- e26d7d0c1088
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.DocumentationTools.QtHelpGenerator</h1> | |
| 23 <p> | |
| 24 Module implementing the QtHelp generator for the builtin documentation | |
| 25 generator. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <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> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#QtHelpGenerator">QtHelpGenerator</a></td> | |
| 35 <td>Class implementing the QtHelp generator for the builtin documentation generator.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a> | |
| 44 <h2>QtHelpGenerator</h2> | |
| 45 <p> | |
| 46 Class implementing the QtHelp generator for the builtin documentation | |
| 47 generator. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 object | |
| 51 <h3>Class Attributes</h3> | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Class Methods</h3> | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | |
| 58 </table> | |
| 59 <h3>Methods</h3> | |
| 60 <table> | |
| 61 <tr> | |
| 62 <td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#QtHelpGenerator.__convertEol">__convertEol</a></td> | |
| 66 <td>Private method to convert the newline characters.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td> | |
| 69 <td>Private method to generate the sections part.</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td> | |
| 72 <td>Public method to generate all index files.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#QtHelpGenerator.remember">remember</a></td> | |
| 75 <td>Public method to remember a documentation file.</td> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <h3>Static Methods</h3> | |
| 79 <table> | |
| 80 <tr><td>None</td></tr> | |
| 81 </table> | |
| 82 <a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a> | |
| 83 <h4>QtHelpGenerator (Constructor)</h4> | |
| 84 <b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection</i>) | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p><dl> | |
| 88 <dt><i>htmlDir</i></dt> | |
| 89 <dd> | |
| 90 directory containing the HTML files (string) | |
| 91 </dd><dt><i>outputDir</i></dt> | |
| 92 <dd> | |
| 93 output directory for the files (string) | |
| 94 </dd><dt><i>namespace</i></dt> | |
| 95 <dd> | |
| 96 namespace to be used (string) | |
| 97 </dd><dt><i>virtualFolder</i></dt> | |
| 98 <dd> | |
| 99 virtual folder to be used (string) | |
| 100 </dd><dt><i>filterName</i></dt> | |
| 101 <dd> | |
| 102 name of the custom filter (string) | |
| 103 </dd><dt><i>filterAttributes</i></dt> | |
| 104 <dd> | |
| 105 ':' separated list of filter attributes | |
| 106 (string) | |
| 107 </dd><dt><i>title</i></dt> | |
| 108 <dd> | |
| 109 title to be used for the generated help (string) | |
| 110 </dd><dt><i>createCollection</i></dt> | |
| 111 <dd> | |
| 112 flag indicating the generation of the | |
| 113 collection files (boolean) | |
| 114 </dd> | |
| 115 </dl><a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a> | |
| 116 <h4>QtHelpGenerator.__convertEol</h4> | |
| 117 <b>__convertEol</b>(<i>txt, newline</i>) | |
| 118 <p> | |
| 119 Private method to convert the newline characters. | |
| 120 </p><dl> | |
| 121 <dt><i>txt</i></dt> | |
| 122 <dd> | |
| 123 text to be converted (string) | |
| 124 </dd><dt><i>newline</i></dt> | |
| 125 <dd> | |
| 126 newline character to be used (string) | |
| 127 </dd> | |
| 128 </dl><dl> | |
| 129 <dt>Returns:</dt> | |
| 130 <dd> | |
| 131 converted text (string) | |
| 132 </dd> | |
| 133 </dl><a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> | |
| 134 <h4>QtHelpGenerator.__generateSections</h4> | |
| 135 <b>__generateSections</b>(<i>package, level</i>) | |
| 136 <p> | |
| 137 Private method to generate the sections part. | |
| 138 </p><dl> | |
| 139 <dt><i>package</i></dt> | |
| 140 <dd> | |
| 141 name of the package to process (string) | |
| 142 </dd><dt><i>level</i></dt> | |
| 143 <dd> | |
| 144 indentation level (integer) | |
| 145 </dd> | |
| 146 </dl><dl> | |
| 147 <dt>Returns:</dt> | |
| 148 <dd> | |
| 149 sections part (string) | |
| 150 </dd> | |
| 151 </dl><a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> | |
| 152 <h4>QtHelpGenerator.generateFiles</h4> | |
| 153 <b>generateFiles</b>(<i>basename="", newline=None</i>) | |
| 154 <p> | |
| 155 Public method to generate all index files. | |
| 156 </p><dl> | |
| 157 <dt><i>basename</i></dt> | |
| 158 <dd> | |
| 159 The basename of the file hierarchy to be documented. | |
| 160 The basename is stripped off the filename if it starts with | |
| 161 the basename. | |
| 162 </dd><dt><i>newline</i></dt> | |
| 163 <dd> | |
| 164 newline character to be used (string) | |
| 165 </dd> | |
| 166 </dl><a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> | |
| 167 <h4>QtHelpGenerator.remember</h4> | |
| 168 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | |
| 169 <p> | |
| 170 Public method to remember a documentation file. | |
| 171 </p><dl> | |
| 172 <dt><i>file</i></dt> | |
| 173 <dd> | |
| 174 The filename to be remembered. (string) | |
| 175 </dd><dt><i>moduleDocument</i></dt> | |
| 176 <dd> | |
| 177 The ModuleDocument object containing the | |
| 178 information for the file. | |
| 179 </dd><dt><i>basename</i></dt> | |
| 180 <dd> | |
| 181 The basename of the file hierarchy to be documented. | |
| 182 The basename is stripped off the filename if it starts with | |
| 183 the basename. | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <div align="right"><a href="#top">Up</a></div> | |
| 187 <hr /> | |
| 188 </body></html> |
