Merge pull request #349 from konarshankar07/routes-xml-template-description

coderimus · web-flow · commit 7889b1fd3bbe · 2020-10-23T16:43:15.000+03:00
#291 :- Add routes.xml code template description
diff --git a/resources/fileTemplates/internal/Magento Php Preference Class.php.html b/resources/fileTemplates/internal/Magento Php Preference Class.php.html
@@ -20,7 +20,7 @@
                     Read more About the preferences in the <a href="https://devdocs.magento.com/guides/v2.3/extension-dev-guide/build/di-xml-file.html#abstraction-implementation-mappings">DevDocs</a>.
                 </font><br>
                 </td>
-            </tr
+            </tr>
         </table>
         <table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
             <tr>
diff --git a/resources/fileTemplates/internal/Magento Routes Xml.xml.html b/resources/fileTemplates/internal/Magento Routes Xml.xml.html
@@ -0,0 +1,43 @@
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<html>
+<body>
+<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
+    <tr>
+        <td><font face="verdana" size="-1">
+            The routes.xml file maps which module to use for a URL with a specific frontName and area.
+            The location of the routes.xml file in a module, either etc/frontend or etc/adminhtml, specifies where those routes are active.
+        </font><br>
+        </td>
+    </tr>
+    <tr>
+        <td><font face="verdana" size="-1">
+            Read more About the routes.xml in the
+            <a href="https://devdocs.magento.com/guides/v2.4/extension-dev-guide/routing.html#routesxml">
+                DevDocs</a>.
+        </font><br>
+        </td>
+    </tr>
+</table>
+<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
+    <tr>
+        <td colspan="3"><font face="verdana" size="-1">Predefined variables explanation:</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${ROUTER_ID}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">specifies the name of the router in Magento.
+            See the reference tables in the
+            <a href="https://devdocs.magento.com/guides/v2.4/extension-dev-guide/routing.html#router-class">
+                Router class section
+            </a>.
+        </font>
+        </td>
+    </tr>
+</table>
+</body>
+</html>
