Issue-288 - Add description to template

Andrii Chornyi · Andrii Chornyi · commit f23ab6fd9b3e · 2020-11-11T13:07:21.000+02:00
diff --git a/resources/fileTemplates/internal/Magento Module UI Component Form Xml.xml.html b/resources/fileTemplates/internal/Magento Module UI Component Form Xml.xml.html
@@ -7,12 +7,52 @@
 <html lang="en">
 <body>
 <p face="verdana" size="-1">
-    The <a href="https://devdocs.magento.com/guides/v2.3/ui_comp_guide/components/ui-listing-grid.html">Form component</a> configuration.
+    The <a href="https://devdocs.magento.com/guides/v2.4/ui_comp_guide/components/ui-form.html">Form component</a> configuration.
 </p>
 
 <table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
     <tr>
-        <td colspan="3"><font face="verdana" size="-1">Template's predefined variables:</font></td>
+        <td colspan="3"><font face="verdana" size="-1">Predefined variables will take the following values:</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${NAME}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">Name for the UI Component Form. The name will be used for configuration file.</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${LABEL}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">Label for form elements (fieldset, button, input, etc..)</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${BUTTONS}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">Buttons that should be added to form.</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${ROUTE}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">Route name</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${SUBMIT_CONTROLLER}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">Class name for the controller.</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${SUBMIT_ACTION}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">Specifies the action class name.</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${DATA_PROVIDER}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">Class name for the data provider class.</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${PRIMARY_FIELD}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">Resource model primary field name.</font></td>
     </tr>
 </table>
 </body>
