| Tor Norbye | 7675366 | 2013-10-15 19:49:27 -0700 | [diff] [blame^] | 1 | <html> |
| 2 | <body> |
| 3 | <table border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse"> |
| 4 | <tr> |
| 5 | <td><font face="verdana" size="-1">This is a built-in template used each time you create a new package-info.java file, by |
| 6 | selecting <i>New | package-info.java</i> from the popup menu in one of the project views.<br> |
| 7 | The template is editable. Along with Java expressions and comments, you can also use predefined variables |
| 8 | (listed below) that will then be expanded like macros into the corresponding values.<br> |
| 9 | It is also possible to specify an arbitrary number of custom variables in the format |
| 10 | <b>${<VARIABLE_NAME>}</b>. In this case, before the new |
| 11 | file is created, you will be prompted with a dialog where you can define particular values for all |
| 12 | custom variables.<br> |
| 13 | Using the <b>#parse</b> directive, you can include templates from the <i>Includes</i> |
| 14 | tab, by specifying the full name of the desired template as a parameter in quotation marks. |
| 15 | For example:<br> |
| 16 | <b>#parse("File Header.java")</b> |
| 17 | </font></td> |
| 18 | </tr> |
| 19 | </table> |
| 20 | <table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse"> |
| 21 | <tr> |
| 22 | <td colspan="3"><font face="verdana" size="-1">Predefined variables will take the following values:</font></td> |
| 23 | </tr> |
| 24 | <tr> |
| 25 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${PACKAGE_NAME}</b></font></nobr></td> |
| 26 | <td width="10"> </td> |
| 27 | <td valign="top"><font face="verdana" size="-1">name of the package in which the new package-info.java file is created</font></td> |
| 28 | </tr> |
| 29 | <tr> |
| 30 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${USER}</b></font></nobr></td> |
| 31 | <td width="10"> </td> |
| 32 | <td valign="top"><font face="verdana" size="-1">current user system login name</font></td> |
| 33 | </tr> |
| 34 | <tr> |
| 35 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${DATE}</b></font></nobr></td> |
| 36 | <td width="10"> </td> |
| 37 | <td valign="top"><font face="verdana" size="-1">current system date</font></td> |
| 38 | </tr> |
| 39 | <tr> |
| 40 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${TIME}</b></font></nobr></td> |
| 41 | <td width="10"> </td> |
| 42 | <td valign="top"><font face="verdana" size="-1">current system time</font></td> |
| 43 | </tr> |
| 44 | <tr> |
| 45 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${YEAR}</b></font></nobr></td> |
| 46 | <td width="10"> </td> |
| 47 | <td valign="top"><font face="verdana" size="-1">current year</font></td> |
| 48 | </tr> |
| 49 | <tr> |
| 50 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${MONTH}</b></font></nobr></td> |
| 51 | <td width="10"> </td> |
| 52 | <td valign="top"><font face="verdana" size="-1">current month</font></td> |
| 53 | </tr> |
| 54 | <tr> |
| 55 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${MONTH_NAME_SHORT}</b></font></nobr></td> |
| 56 | <td width="10"> </td> |
| 57 | <td valign="top"><font face="verdana" size="-1">first 3 letters of the current month name. Example: Jan, Feb, etc.</font></td> |
| 58 | </tr> |
| 59 | <tr> |
| 60 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${MONTH_NAME_FULL}</b></font></nobr></td> |
| 61 | <td width="10"> </td> |
| 62 | <td valign="top"><font face="verdana" size="-1">full name of the current month. Example: January, February, etc.</font></td> |
| 63 | </tr> |
| 64 | <tr> |
| 65 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${DAY}</b></font></nobr></td> |
| 66 | <td width="10"> </td> |
| 67 | <td valign="top"><font face="verdana" size="-1">current day of the month</font></td> |
| 68 | </tr> |
| 69 | <tr> |
| 70 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${HOUR}</b></font></nobr></td> |
| 71 | <td width="10"> </td> |
| 72 | <td valign="top"><font face="verdana" size="-1">current hour</font></td> |
| 73 | </tr> |
| 74 | <tr> |
| 75 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${MINUTE}</b></font></nobr></td> |
| 76 | <td width="10"> </td> |
| 77 | <td valign="top"><font face="verdana" size="-1">current minute</font></td> |
| 78 | </tr> |
| 79 | <tr> |
| 80 | <td valign="top"><nobr><font face="verdana" size="-2"><b>${PROJECT_NAME}</b></font></nobr></td> |
| 81 | <td width="10"> </td> |
| 82 | <td valign="top"><font face="verdana" size="-1">the name of the current project</font></td> |
| 83 | </tr> |
| 84 | </table> |
| 85 | </body> |
| 86 | </html> |