Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.install-i18n.html
Documentation/Source/eric4.install-i18n.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.install-i18n</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.install-i18n</h1> | |
| 24 <p> | |
| 25 Installation script for the eric4 IDE translation files. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>configDir</td></tr><tr><td>privateInstall</td></tr><tr><td>progName</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr><td>None</td></tr> | |
| 34 </table> | |
| 35 <h3>Functions</h3> | |
| 36 <table> | |
| 37 <tr> | |
| 38 <td><a href="#getConfigDir">getConfigDir</a></td> | |
| 39 <td>Global function to get the name of the directory storing the config data.</td> | |
| 40 </tr><tr> | |
| 41 <td><a href="#installTranslations">installTranslations</a></td> | |
| 42 <td>Install the translation files into the right place.</td> | |
| 43 </tr><tr> | |
| 44 <td><a href="#main">main</a></td> | |
| 45 <td>The main function of the script.</td> | |
| 46 </tr><tr> | |
| 47 <td><a href="#usage">usage</a></td> | |
| 48 <td>Display a usage message and exit.</td> | |
| 49 </tr> | |
| 50 </table> | |
| 51 <hr /><hr /> | |
| 52 <a NAME="getConfigDir" ID="getConfigDir"></a> | |
| 53 <h2>getConfigDir</h2> | |
| 54 <b>getConfigDir</b>(<i></i>) | |
| 55 <p> | |
| 56 Global function to get the name of the directory storing the config data. | |
| 57 </p><dl> | |
| 58 <dt>Returns:</dt> | |
| 59 <dd> | |
| 60 directory name of the config dir (string) | |
| 61 </dd> | |
| 62 </dl> | |
| 63 <div align="right"><a href="#top">Up</a></div> | |
| 64 <hr /><hr /> | |
| 65 <a NAME="installTranslations" ID="installTranslations"></a> | |
| 66 <h2>installTranslations</h2> | |
| 67 <b>installTranslations</b>(<i></i>) | |
| 68 <p> | |
| 69 Install the translation files into the right place. | |
| 70 </p> | |
| 71 <div align="right"><a href="#top">Up</a></div> | |
| 72 <hr /><hr /> | |
| 73 <a NAME="main" ID="main"></a> | |
| 74 <h2>main</h2> | |
| 75 <b>main</b>(<i>argv</i>) | |
| 76 <p> | |
| 77 The main function of the script. | |
| 78 </p><dl> | |
| 79 <dt><i>argv</i></dt> | |
| 80 <dd> | |
| 81 list of command line arguments (list of strings) | |
| 82 </dd> | |
| 83 </dl> | |
| 84 <div align="right"><a href="#top">Up</a></div> | |
| 85 <hr /><hr /> | |
| 86 <a NAME="usage" ID="usage"></a> | |
| 87 <h2>usage</h2> | |
| 88 <b>usage</b>(<i>rcode = 2</i>) | |
| 89 <p> | |
| 90 Display a usage message and exit. | |
| 91 </p><dl> | |
| 92 <dt><i>rcode</i></dt> | |
| 93 <dd> | |
| 94 return code passed back to the calling process (integer) | |
| 95 </dd> | |
| 96 </dl> | |
| 97 <div align="right"><a href="#top">Up</a></div> | |
| 98 <hr /> | |
| 99 </body></html> |
