Merge pull request #9515 from ester-nl/appext/1055-add-warning-name-validation

Warning for invalid name

Author: quinntracy

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/web/get-started.md

@@ -9,6 +9,8 @@ weight: 2
 
 Studio Pro extensions can be developed using typescript and use standard web development technologies to extend the Studio Pro development environment. This guide shows you how to set up a basic development environment for building an extension using the web extensibility API.
 
+For more information see the [Mendix Studio Pro Web Extensibility API](http://apidocs.rnd.mendix.com/10/extensions-api/index.html).
+
 ### Prerequisites
 
 You will need the following prerequisites:
@@ -97,17 +99,21 @@ To test the extension, do the following in File Explorer.
 
 1. Start Studio Pro with the following command line parameters to tell it to use the extensions in the folder.
 
-    `--enable-extension-development --enable-webview-debugging`
+    `--enable-extension-development --webview-remote-debugging`
 
     These flags instruct Studio Pro to do the following:
 
-    * Load extensions from the webextensions folder
+    * Load extensions from the `webextensions` folder
     * Enable web debugging tools which will be useful when developing your extension
 
 1. In Studio Pro, open the new app. 
 
     You will see a new `Extensions` item in the top menu.
 
+{{% alert color="warning" %}}
+Extension names used in place of `myextension` must only contain digits, letters, dashes, and underscores. Extensions with an invalid name will not be loaded and will display an error.
+{{% /alert %}}
+
 ## Conclusion
 
 Using this guide we have:

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/web/web-extensions-howtos/menu-api.md

@@ -19,7 +19,7 @@ In this section, you will add a simple menu to your extension.
 
 The code below will:
 
-* create a menu item under the menu that was added in [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-10/getting-started/)
+* create a menu item with the caption "My First Menu"
 * show a dialog when the menu is clicked
 
 Replace your `src/main/index.ts` file with the following:

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-howtos/create-modal-web-view.md

@@ -88,6 +88,7 @@ To open static pages, you need to source them from either a file system path or
 namespace MyCompany.MyProject.MendixExtension;
 
 [Export(typeof(WebServerExtension))]
+[method: ImportingConstructor]
 class ContentServer : WebServerExtension
 {
     private const string Content = """

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-reference-guide/web-view.md

@@ -44,3 +44,25 @@ For serving content to the web view and communicating both ways with it, see [Bu
 {{% alert color="warning" %}}
 {{% snippet file="/static/_includes/apidocs-mxsdk/warning-wwwroot.md" %}}
 {{% /alert %}}
+
+## Troubleshooting
+
+### Web Content Fails to Load
+
+If your pane or tab was open when Studio Pro was closed, your web content might fail to load when you reopen Studio Pro. This is because the `WebServerBaseUrl` property is null due to timing issues in the startup sequence.
+
+To resolve this, listen to `OnWebServerBaseUrlChanged` in your `WebServerExtension`. This will get the URL when it gets re-initialized.
+
+You can use the following code:
+
+```csharp
+[Export(typeof(WebServerExtension))]
+class ContentServer : WebServerExtension
+{
+    [ImportingConstructor]
+    public ContentServer(INotificationPopupService notificationPopupService)
+    {
+        OnWebServerBaseUrlChanged += () =>  notificationPopupService.ShowNotification("Web Server Base Url Initialized", WebServerBaseUrl.ToString(), null, 2);
+    }
+}
+```

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/_index.md

@@ -15,6 +15,10 @@ weight: 20
 
 Extensions can be written in Typescript or other web languages, described here, or using a C# API which is documented separately in [Extensibility API for C# Developers](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/).
 
+{{% alert color="info" %}}
+Please note that extension development is only possible by starting Studio Pro with the `--enable-extension-development` feature flag.
+{{% /alert %}}
+
 ## Prerequisites
 
 * You need at least a basic understanding of the Mendix platform.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/get-started.md

@@ -9,6 +9,8 @@ weight: 2
 
 Studio Pro extensions can be developed using typescript and use standard web development technologies to extend the Studio Pro development environment. This guide shows you how to set up a basic development environment for building an extension using the web extensibility API.
 
+For more information, see the [Mendix Studio Pro Web Extensibility API](http://apidocs.rnd.mendix.com/11/extensions-api/index.html).
+
 ### Prerequisites
 
 You will need the following prerequisites:
@@ -22,6 +24,10 @@ You will need the following prerequisites:
 Extensions can be built on any operating system as the underlying framework is cross-platform.
 {{% /alert %}}
 
+{{% alert color="info" %}}
+Please note that extension development is only possible by starting Studio Pro with the `--enable-extension-development` feature flag.
+{{% /alert %}}
+
 ## Creating Your First Extension
 
 This section will show you how to build and test an extension.
@@ -97,7 +103,7 @@ To test the extension, do the following in File Explorer.
 
 1. Start Studio Pro with the following command line parameters to tell it to use the extensions in the folder.
 
-    `--enable-extension-development --enable-webview-debugging`
+    `--enable-extension-development --webview-remote-debugging`
 
     These flags instruct Studio Pro to do the following:
 
@@ -108,6 +114,10 @@ To test the extension, do the following in File Explorer.
 
     You will see a new `Extensions` item in the top menu.
 
+{{% alert color="warning" %}}
+Extension names used in place of `myextension` must only contain digits, letters, dashes, and underscores. Extensions with an invalid name will not be loaded and will display an error.
+{{% /alert %}}
+
 ## Conclusion
 
 Using this guide we have:

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/menu-api.md

@@ -19,7 +19,7 @@ In this section, you will add a simple menu to your extension.
 
 The code below will:
 
-* create a menu item under the menu that was added in [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/)
+* create a menu item with the caption "My First Menu"
 * show a dialog when the menu is clicked
 
 Replace your `src/main/index.ts` file with the following:

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-9/_index.md

@@ -3,7 +3,7 @@ title: "APIs for Studio Pro 9"
 url: /apidocs-mxsdk/apidocs/apis-for-studio-pro-9/
 no_list: false
 description_list: true
-description: "Provides the documentation of APIs for Studio Pro 9, including Extensibility API and Mendix Runtime API."
+description: "Provides the documentation of APIs for Studio Pro 9, such as Mendix Runtime API."
 weight: 7
 linktitle: "Studio Pro 9"
 ---