Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.install-i18n.html
Documentation/Source/eric5.install-i18n.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 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>eric5.install-i18n</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.install-i18n</h1> | |
| 12 <p> | |
| 13 Installation script for the eric5 IDE translation files. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>configDir</td></tr><tr><td>privateInstall</td></tr><tr><td>progName</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr><td>None</td></tr> | |
| 22 </table> | |
| 23 <h3>Functions</h3> | |
| 24 <table> | |
| 25 <tr> | |
| 26 <td><a href="#getConfigDir">getConfigDir</a></td> | |
| 27 <td>Global function to get the name of the directory storing the config data.</td> | |
| 28 </tr><tr> | |
| 29 <td><a href="#installTranslations">installTranslations</a></td> | |
| 30 <td>Install the translation files into the right place.</td> | |
| 31 </tr><tr> | |
| 32 <td><a href="#main">main</a></td> | |
| 33 <td>The main function of the script.</td> | |
| 34 </tr><tr> | |
| 35 <td><a href="#usage">usage</a></td> | |
| 36 <td>Display a usage message and exit.</td> | |
| 37 </tr> | |
| 38 </table> | |
| 39 <hr /><hr /> | |
| 40 <a NAME="getConfigDir" ID="getConfigDir"></a> | |
| 41 <h2>getConfigDir</h2> | |
| 42 <b>getConfigDir</b>(<i></i>) | |
| 43 <p> | |
| 44 Global function to get the name of the directory storing the config data. | |
| 45 </p><dl> | |
| 46 <dt>Returns:</dt> | |
| 47 <dd> | |
| 48 directory name of the config dir (string) | |
| 49 </dd> | |
| 50 </dl> | |
| 51 <div align="right"><a href="#top">Up</a></div> | |
| 52 <hr /><hr /> | |
| 53 <a NAME="installTranslations" ID="installTranslations"></a> | |
| 54 <h2>installTranslations</h2> | |
| 55 <b>installTranslations</b>(<i></i>) | |
| 56 <p> | |
| 57 Install the translation files into the right place. | |
| 58 </p> | |
| 59 <div align="right"><a href="#top">Up</a></div> | |
| 60 <hr /><hr /> | |
| 61 <a NAME="main" ID="main"></a> | |
| 62 <h2>main</h2> | |
| 63 <b>main</b>(<i>argv</i>) | |
| 64 <p> | |
| 65 The main function of the script. | |
| 66 </p><dl> | |
| 67 <dt><i>argv</i></dt> | |
| 68 <dd> | |
| 69 list of command line arguments (list of strings) | |
| 70 </dd> | |
| 71 </dl> | |
| 72 <div align="right"><a href="#top">Up</a></div> | |
| 73 <hr /><hr /> | |
| 74 <a NAME="usage" ID="usage"></a> | |
| 75 <h2>usage</h2> | |
| 76 <b>usage</b>(<i>rcode = 2</i>) | |
| 77 <p> | |
| 78 Display a usage message and exit. | |
| 79 </p><dl> | |
| 80 <dt><i>rcode</i></dt> | |
| 81 <dd> | |
| 82 return code passed back to the calling process (integer) | |
| 83 </dd> | |
| 84 </dl> | |
| 85 <div align="right"><a href="#top">Up</a></div> | |
| 86 <hr /> | |
| 87 </body></html> |
