Add warning about name needing to start ui_

Author: Dave Conway-Jones

docs/api.md

@@ -29,18 +29,18 @@ To support new widgets, the following runtime API is exported from the Node-RED
   | :--- | :------------------------- | :----------------------------------------------------------- |
   | 1    | node*                      | controlling node.<br/>optional if scope is "global".                                             |
   | 2    | format                     | HTML code of widget.<br />Accepts HTML same as one for Template Dashboard widget node. |
-  | 3    | group*                     | group node object to which widget belongs                    |
+  | 3    | group                      | group node object to which widget belongs                    |
   | 4    | width*                     | width of widget                                              |
   | 5    | height*                    | height of widget                                             |
-  | 6    | templateScope              | scope of widget ("global" or "local")                        |
-  | 7    | emitOnlyNewValues*         | send message if changed                                      |
-  | 8    | forwardInputMessages*      | forward input messages to output                             |
-  | 9    | storeFrontEndInputAsState* | store received message                                       |
-  | 10   | convert*                   | callback to convert value to front-end                       |
-  | 11   | beforeEmit*                | callback to prepare message                                  |
-  | 12   | convertBack*               | callback to convert sent message                             |
-  | 13   | beforeSend*                | callback to prepare message                                  |
-  | 14   | order                      | order in group                                               |
+  | 6    | order                      | order in group                                               |
+  | 7    | templateScope              | scope of widget ("global" or "local")                        |
+  | 8    | emitOnlyNewValues*         | send message if changed                                      |
+  | 9    | forwardInputMessages*      | forward input messages to output                             |
+  | 10   | storeFrontEndInputAsState* | store received message                                       |
+  | 11   | convert*                   | callback to convert value to front-end                       |
+  | 12   | beforeEmit*                | callback to prepare message                                  |
+  | 13   | convertBack*               | callback to convert sent message                             |
+  | 14   | beforeSend*                | callback to prepare message                                  |
   | 15   | initController*            | callback to initialize in controller                         |
 
   `addWidget` returns a callback that should be called on close of controlling node.
@@ -142,7 +142,7 @@ To support new widgets, the following runtime API is exported from the Node-RED
             return conf;
         };
 
-        RED.nodes.registerType('ui_cal', mk_conf('cal'));
+        RED.nodes.registerType('ui_cal', mk_conf('cal')); // NOTE: The type MUST start with "ui_"
     </script>
     ```
     Use `ui_group` for configuring belonging group, and `elementSizer` for configuring widget size.
@@ -205,6 +205,6 @@ To support new widgets, the following runtime API is exported from the Node-RED
           }
           node.on("close", done);
       }
-      RED.nodes.registerType('ui_cal', CalNode);
+      RED.nodes.registerType('ui_cal', CalNode); // NOTE: The type MUST start with "ui_"
   };
   ```

node-red-ui-node-lineargauge/linear_gauge.html

@@ -11,7 +11,7 @@
   limitations under the License.
 -->
 <script type="text/javascript">
-    RED.nodes.registerType('ui_lineargauge',{
+    RED.nodes.registerType('ui_lineargauge',{    // type MUST start with ui_
         category: 'dashboard',
         color: 'rgb( 63, 173, 181)',
         defaults: {
@@ -76,7 +76,7 @@
     <div class="form-row">
         <label for="node-input-colorLowArea"><i class="fa fa-paint-brush"></i> Low Area Color</span></label>
         <input type="color" id="node-input-colorLowArea"/>
-    </div>    
+    </div>
     <div class="form-row">
         <label for="node-input-unit"><i class="fa fa-asterisk" aria-hidden="true"></i> Unit</span></label>
         <input type="text" id="node-input-unit"/>
@@ -102,4 +102,3 @@
     <p>Actual Value: <code>msg.payload</code></p>
 
 </script>
-

node-red-ui-node-lineargauge/linear_gauge.js

@@ -279,6 +279,7 @@
 	/**
 	 *  REQUIRED
 	 * Registers the node with a name, and a configuration.
+     * Type MUST start with ui_
 	 */
     RED.nodes.registerType("ui_lineargauge", LinearGaugeNode);
 };

ui_list/ui_list.html

@@ -14,7 +14,7 @@
   limitations under the License.
 -->
 
-<script type="text/x-red" data-template-name="ui_list">
+<script type="text/x-red" data-template-name="ui_list">  // type MUST start with ui_
     <!-- common input elements for dashboard widget -->
     <div class="form-row" id="template-row-group">
         <label for="node-input-group"><i class="fa fa-table"></i> <span data-i18n="ui_list.label.group"></span></label>

ui_list/ui_list.js

@@ -180,5 +180,6 @@ ${(allowMenu ? md_menu : "")}
         });
     }
     // register ui_list node
+    // type MUST start with ui_
     RED.nodes.registerType('ui_list', ListNode);
 };