Documentation for variables
[idea/community.git] / resources-en / src / fileTemplates / includes / default.html
1 <html>
2 <body>
3 <table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
4   <tr>
5     <td><font face="verdana" size="-1">In this template, you can specify a code fragment to be included into file templates
6       (<i>Templates</i> tab) with the help of the <b>#parse</b> directive.<br>
7       One template can be shared by several file templates.<br>
8       Along with static text, code and comments, you can also use predefined variables
9       that will then be expanded like macros into the corresponding values.</font><br>
10     </td>
11   </tr>
12 </table>
13 <table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
14   <tr>
15     <td colspan="3"><font face="verdana" size="-1">Predefined variables will take the following values:</font></td>
16   </tr>
17   <tr>
18     <td valign="top"><nobr><font face="verdana" size="-2"><b>${PACKAGE_NAME}</b></font></nobr></td>
19     <td width="10">&nbsp;</td>
20     <td width="100%" valign="top"><font face="verdana" size="-1">name of the package in which the new file is created</font></td>
21   </tr>
22   <tr>
23     <td valign="top"><nobr><font face="verdana" size="-2"><b>${USER}</b></font></nobr></td>
24     <td width="10">&nbsp;</td>
25     <td width="100%" valign="top"><font face="verdana" size="-1">current user system login name</font></td>
26   </tr>
27   <tr>
28     <td valign="top"><nobr><font face="verdana" size="-2"><b>${DATE}</b></font></nobr></td>
29     <td width="10">&nbsp;</td>
30     <td width="100%" valign="top"><font face="verdana" size="-1">current system date</font></td>
31   </tr>
32   <tr>
33     <td valign="top"><nobr><font face="verdana" size="-2"><b>${TIME}</b></font></nobr></td>
34     <td width="10">&nbsp;</td>
35     <td width="100%" valign="top"><font face="verdana" size="-1">current system time</font></td>
36   </tr>
37   <tr>
38     <td valign="top"><nobr><font face="verdana" size="-2"><b>${YEAR}</b></font></nobr></td>
39     <td width="10">&nbsp;</td>
40     <td width="100%" valign="top"><font face="verdana" size="-1">current year</font></td>
41   </tr>
42   <tr>
43     <td valign="top"><nobr><font face="verdana" size="-2"><b>${MONTH}</b></font></nobr></td>
44     <td width="10">&nbsp;</td>
45     <td width="100%" valign="top"><font face="verdana" size="-1">current month</font></td>
46   </tr>
47   <tr>
48     <td valign="top"><nobr><font face="verdana" size="-2"><b>${MONTH_NAME_SHORT}</b></font></nobr></td>
49     <td width="10">&nbsp;</td>
50     <td width="100%" valign="top"><font face="verdana" size="-1">first 3 letters of the current month name. Example: Jan, Feb, etc.</font></td>
51   </tr>
52   <tr>
53     <td valign="top"><nobr><font face="verdana" size="-2"><b>${MONTH_NAME_FULL}</b></font></nobr></td>
54     <td width="10">&nbsp;</td>
55     <td width="100%" valign="top"><font face="verdana" size="-1">full name of the current month. Example: January, February, etc.</font></td>
56   </tr>
57   <tr>
58     <td valign="top"><nobr><font face="verdana" size="-2"><b>${DAY}</b></font></nobr></td>
59     <td width="10">&nbsp;</td>
60     <td width="100%" valign="top"><font face="verdana" size="-1">current day of the month</font></td>
61   </tr>
62   <tr>
63     <td valign="top"><nobr><font face="verdana" size="-2"><b>${DAY_NAME_SHORT}</b></font></nobr></td>
64     <td width="10">&nbsp;</td>
65     <td width="100%" valign="top"><font face="verdana" size="-1">first 3 letters of the current day name. Example: Mon, Tue, etc.</font></td>
66   </tr>
67   <tr>
68     <td valign="top"><nobr><font face="verdana" size="-2"><b>${DAY_NAME_FULL}</b></font></nobr></td>
69     <td width="10">&nbsp;</td>
70     <td width="100%" valign="top"><font face="verdana" size="-1">full name of the current day. Example: Monday, Tuesday, etc.</font></td>
71   </tr>
72   <tr>
73     <td valign="top"><nobr><font face="verdana" size="-2"><b>${HOUR}</b></font></nobr></td>
74     <td width="10">&nbsp;</td>
75     <td width="100%" valign="top"><font face="verdana" size="-1">current hour</font></td>
76   </tr>
77   <tr>
78     <td valign="top"><nobr><font face="verdana" size="-2"><b>${MINUTE}</b></font></nobr></td>
79     <td width="10">&nbsp;</td>
80     <td width="100%" valign="top"><font face="verdana" size="-1">current minute</font></td>
81   </tr>
82   <tr>
83     <td valign="top"><nobr><font face="verdana" size="-2"><b>${PROJECT_NAME}</b></font></nobr></td>
84     <td width="10">&nbsp;</td>
85     <td width="100%" valign="top"><font face="verdana" size="-1">the name of the current project</font></td>
86   </tr>
87 </table>
88 </body>
89 </html>