From 0abba7f76d914361cb87908df1c0a9ae6b7347bf Mon Sep 17 00:00:00 2001 From: Zerlord Santiago Date: Wed, 10 Jul 2024 01:12:40 +0800 Subject: [PATCH 1/3] Accessibility check --- docs/howto/configmobile.md | 8 +-- docs/howto/dicreatenativeapp.md | 8 +-- docs/howto/importvoltformula.md | 4 +- docs/howto/logginglevel.md | 4 +- docs/howto/regunregconfig.md | 4 +- docs/references/earlyaccesschanges.md | 22 +++--- docs/references/troubleshoot.md | 39 +--------- docs/references/whatsnew/v202.md | 4 +- docs/topicguides/datamodel.md | 6 +- docs/topicguides/rosettavmxgo.md | 2 +- docs/topicguides/voltformulaintro.md | 4 ++ docs/tutorials/adaptertutorial.md | 34 ++------- docs/tutorials/designimport.md | 100 +++++++++++++------------- docs/tutorials/voltformula.md | 53 +++++--------- 14 files changed, 107 insertions(+), 185 deletions(-) diff --git a/docs/howto/configmobile.md b/docs/howto/configmobile.md index 2fc8025..056252b 100644 --- a/docs/howto/configmobile.md +++ b/docs/howto/configmobile.md @@ -7,15 +7,15 @@ This procedure describes how to configure the mobile app browser before building ## Procedure 1. Go to the **Design** tab. -2. In your **Project**, go to **Forms**, click the **Start-Up form** (e.g, frmLogin). +2. In your **Project**, go to **Forms** and click the **Start-Up form**, for example the `frmLogin`. - ![](../assets/images/didesignproj.png) + ![Project tab](../assets/images/didesignproj.png) 3. Click the login button and click the **Properties** tab. 4. Under **Properties**, click the **Action** tab. 5. Click **Edit** next to the **onClick** item. The **Action Editor** opens. - ![](../assets/images/didesignaction.png) + ![Action tab](../assets/images/didesignaction.png) 6. Click the **Invoke service**. @@ -25,6 +25,6 @@ This procedure describes how to configure the mobile app browser before building 7. Select **Use Device Browser** under **Select Browser Widget**. - ![](../assets/images/didesigninvoke.png ) + ![Action Editor](../assets/images/didesigninvoke.png) 8. Click **Save**. \ No newline at end of file diff --git a/docs/howto/dicreatenativeapp.md b/docs/howto/dicreatenativeapp.md index ff921ad..def46dc 100644 --- a/docs/howto/dicreatenativeapp.md +++ b/docs/howto/dicreatenativeapp.md @@ -16,19 +16,19 @@ Walks you through the process of creating a new project for a mobile or tablet p 1. In the top menu of Volt MX Go Iris, select **Project** → **New Project**. 2. In the **What do you want to start with now?** dialog, select **Native App** and click **Next**. - ![](../assets/images/didevice.png){: style="height:80%;width:80%"} + ![What do you want to start with now dialog](../assets/images/didevice.png){: style="height:80%;width:80%"} 3. In the **Which device size do you want to start building for first?** dialog, select **Mobile** or **Tablet** and click **Next**. - ![](../assets/images/distart.png){: style="height:80%;width:80%"} + ![Project Name](../assets/images/distart.png){: style="height:80%;width:80%"} 4. Enter your **Project Name** and click **Create**. - ![](../assets/images/diprojectnamemob.png){: style="height:80%;width:80%"} + ![Project Name](../assets/images/diprojectnamemob.png){: style="height:80%;width:80%"} You have now created a new native app project. You can see your project name in the upper-left corner of the **Volt MX Go Iris** canvass. -![](../assets/images/diappnamemob.png){: style="height:80%;width:80%"} +![New native app project](../assets/images/diappnamemob.png){: style="height:80%;width:80%"} !!!tip diff --git a/docs/howto/importvoltformula.md b/docs/howto/importvoltformula.md index e27351b..1c5295f 100644 --- a/docs/howto/importvoltformula.md +++ b/docs/howto/importvoltformula.md @@ -18,14 +18,14 @@ Guides you through the process of importing the **Domino app** and integrating t 2. Finished all the steps in the **VoltMX Design Import Wizard**. 3. On the Volt MX Go Iris project, open the form that has the **actions** (i.e., Create Customer) button imported from Domino view. - ![](../assets/images/dibutton.png) + ![Form with actions button imported](../assets/images/dibutton.png) 4. On **Action** properties tab, select **onClick**. 5. Click **Edit**. The **Action Editor** page will appear. 6. Double-click **Add Formula** in the flowchart. 7. The formula language window will appear containing the *Formula Language* and `voltmmx.rosettajs` syntax. - ![](../assets/images/divoltformula.png) + ![Formula Language editor](../assets/images/divoltformula.png) 8. Click **Save**. diff --git a/docs/howto/logginglevel.md b/docs/howto/logginglevel.md index 29ef5c3..1d3e110 100644 --- a/docs/howto/logginglevel.md +++ b/docs/howto/logginglevel.md @@ -29,12 +29,12 @@ Guides you on how to check and set the logging level, and access the log files. - For Windows: - ![](../assets/images/diloggingwin.png){: style="height:80%;width:80%"} + ![Windows directory](../assets/images/diloggingwin.png){: style="height:80%;width:80%"} - For Mac: - ![](../assets/images/dilogging.png){: style="height:80%;width:80%"} + ![Mac directory](../assets/images/dilogging.png){: style="height:80%;width:80%"} 2. Open the `iris_development.log` file to view the logs. diff --git a/docs/howto/regunregconfig.md b/docs/howto/regunregconfig.md index 6c8d1e8..8d8b416 100644 --- a/docs/howto/regunregconfig.md +++ b/docs/howto/regunregconfig.md @@ -15,7 +15,7 @@ You have lauched Volt MX Go Iris. 1. Go to **Project Settings**, and select **VoltFormula**. 2. On the **Register Custom API** text box, click the **Browse** icon. - ![](../assets/images/vfreg.png) + ![Register Custom API text box](../assets/images/vfreg.png) 3. Select your custom API `.json` file. 4. Click **Done**. @@ -25,7 +25,7 @@ You have lauched Volt MX Go Iris. 1. Go to the **Project Settings**, and select **VoltFormula**. 2. On the **Register Custom API** text box, click **X** to remove the custom API. - ![](../assets/images/vfunreg.png) + ![Register Custom API text box](../assets/images/vfunreg.png) 3. Click **Done**. diff --git a/docs/references/earlyaccesschanges.md b/docs/references/earlyaccesschanges.md index f986a6b..81a7b3b 100644 --- a/docs/references/earlyaccesschanges.md +++ b/docs/references/earlyaccesschanges.md @@ -10,20 +10,20 @@ The section provides information on the features, improvements, and resolved iss - Added readiness and liveness probes support to the Domino REST API Helm chart. The readiness probe is used by a service to know if a container is available to handle requests. If it fails the configured thresholds, the service is marked as not ready and won't route requests. The liveness probe is similar to the readiness probe. However, if it fails the configured thresholds, the container is killed and restarted. These probes are present and customizable. - Added installers for **Domino REST API** and **Volt MX Go Foundry**. -##### VoltFormula +#### VoltFormula - Added Typeahead IntelliSense in the [configuration](../howto/configrosetta.md) which can be seen in the rosetta formula. -##### Design Import +#### Design Import - Added support for multi-value fields configured in Domino Rest API with the value returned to the imported Domino App as a bulleted list. - Added **Collapse All** and **Expand All** features in **VoltMX Design Import Wizard**. - Added unconfigured and configured forms in **VoltMX Design Import Wizard**. ### Improvements -##### First Touch +#### First Touch - Users can now view and explore the First Touch Recipe Catalog app by launching it from Volt MX Go Foundry. -##### Domino Adapter +#### Domino Adapter - Updated the Rich Text field format in Volt MX Go Foundry Object Services to Base64-encoded HTML - Added support for the PATCH method for form-based data models. - Support OData filter parameter for the GET method on form-based data models to return a document’s unknown form name using the document's UNID. For more information, see [Supported OData filter parameters, form-based GET](../topicguides/method.md#supported-odata-query-parameters-for-form-based-get-method). @@ -33,7 +33,7 @@ The section provides information on the features, improvements, and resolved iss - The CREATE form allows users to specify the rich text field content using the Summernote Editor Iris component. - The UPDATE form allows users to edit the rich text using the Summernote Editor Iris component. -##### VoltFormula +#### VoltFormula - IntelliSense improvements on category beside each formula. - Update the Rosetta API and Rosetta converter which can be seen in [Rosetta API reference documentation](https://help.hcltechsw.com/docs/voltmxgo/javadoc/index.html). ##### Design Import @@ -44,7 +44,7 @@ The section provides information on the features, improvements, and resolved iss ### Resolve Issues -##### Design Import +#### Design Import - An error occurred when choosing a new scope in the Scope and Form step in the **VoltMX Design Import Wizard**. - The list of scopes wasn't fetched again when the service was changed. @@ -59,22 +59,22 @@ The section provides information on the features, improvements, and resolved iss ### New Features -##### Design Import +#### Design Import - Added user-selectable [logging levels](reflogginglevels.md) for better monitoring and evaluation of activities and events. ### Improvements -##### First Touch +#### First Touch - Simplified [uninstall procedure](../howto/uninstallfirsttouch.md) and improved progress view for both install and uninstall for better user experience. -##### Domino Adapter +#### Domino Adapter - Supports [OData filter parameters for the GET method on view-based data models](../topicguides/method.md#supported-odata-query-parameters-for-view-based-get-method). - Added Domino form alias names to `@form` attribute metadata in form-based data models. -##### Design Import +#### Design Import - Implemented UI improvements on the **VoltMX Design Import Wizard** for better user experience. -##### VoltFormula +#### VoltFormula - Updated the list of Notes and Open formulas in [Rosetta API reference documentation](https://help.hcltechsw.com/docs/voltmxgo/javadoc/index.html). diff --git a/docs/references/troubleshoot.md b/docs/references/troubleshoot.md index ef6e2e5..36a7272 100644 --- a/docs/references/troubleshoot.md +++ b/docs/references/troubleshoot.md @@ -24,7 +24,7 @@ List of issues and corresponding resolutions. You might encounter the following issues when importing Domino applications using Design Import. While you may proceed with the import, there is no guarantee that the resulting application will function correctly. - ![](../assets/images/didrapissues.png) + ![Design Import error dialog](../assets/images/didrapissues.png) - **Field value mismatch between modes** @@ -56,40 +56,3 @@ Contact your Domino Rest API administrator for assistance in complying with the - **The kubectl commands fail after restarting Windows or Rancher Desktop** When your kubectl commands fail after restarting Windows or Rancher Desktop, you must run the `kubectl config set-context --current --namespace=mxgo` command in your Ubuntu terminal session to set the current namespace context. - - - - \ No newline at end of file diff --git a/docs/references/whatsnew/v202.md b/docs/references/whatsnew/v202.md index 03cc131..77dc7b9 100644 --- a/docs/references/whatsnew/v202.md +++ b/docs/references/whatsnew/v202.md @@ -54,12 +54,12 @@ ### VoltFormula -##### Rosetta API +#### Rosetta API - An issue occurred when generating definitions for custom API extensions. - Replace Notes function wasn't providing accurate results when multiple instances used the same replacement values. -##### Rosetta Converter +#### Rosetta Converter - Issues occurred with date-time conversion parameters when using the `@Explode` formula function.  - The `=` sign was removed during OpenFormula conversion.  diff --git a/docs/topicguides/datamodel.md b/docs/topicguides/datamodel.md index f409d91..c86eaecb 100644 --- a/docs/topicguides/datamodel.md +++ b/docs/topicguides/datamodel.md @@ -40,11 +40,11 @@ Field data types in the generated Volt MX Go Foundry data model are effectively For common data types, the field type in the generated Volt MX Go Foundry object models will match the data type in the Domino REST API schema. In the example image, the number of *Servings* is a `float` in the Domino REST API `schema`. -![](../assets/images/recipe-servings-keepschema.png) +![Domino REST API schema](../assets/images/recipe-servings-keepschema.png) In the Volt MX Go Foundry object model, the field type of *Servings* is `number`: -![](../assets/images/recipe-servings-foundrymodel.png) +![Volt MX Go Foundry object model](../assets/images/recipe-servings-foundrymodel.png) For Domino object types not found in Volt MX Go Foundry, the Volt MX Go Foundry object field type is set to `string` and Domino type information is retained as properties in the field metadata attribute. @@ -53,7 +53,7 @@ Two properties are used for Domino data type information: - `dominoSpecialType` property indicates if the data is `Rich Text`, `Array` (multi-value), or `Date Only`. - `dominoArrayComponentType` property indicates the array type for multi-value fields, for example, a multi-value array of strings as shown in the following example: -![](../assets/images/recipe-richtext.png) +![Metadata dialog](../assets/images/recipe-richtext.png) The table shows a simplified list of data-type mappings between Domino REST API and Volt MX Go Foundry: diff --git a/docs/topicguides/rosettavmxgo.md b/docs/topicguides/rosettavmxgo.md index 167db62..79039df 100644 --- a/docs/topicguides/rosettavmxgo.md +++ b/docs/topicguides/rosettavmxgo.md @@ -2,4 +2,4 @@ ## Flow overview -![](../assets/images/vfrosetta.png) \ No newline at end of file +![Rosetta flow overview](../assets/images/vfrosetta.png) \ No newline at end of file diff --git a/docs/topicguides/voltformulaintro.md b/docs/topicguides/voltformulaintro.md index 921019b..87f91e9 100644 --- a/docs/topicguides/voltformulaintro.md +++ b/docs/topicguides/voltformulaintro.md @@ -7,7 +7,11 @@ What ideas do you think of whenever you hear the word *formula*? It refers to a ## Two formula languages exposed as one implementation by VoltFormula - [OpenFormula](https://docs.oasis-open.org/office/OpenDocument/v1.3/OpenDocument-v1.3-part4-formula.html){: target="_blank" rel="noopener noreferrer"} + - [Notes Formula Language](https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_NOTES_FORMULA_LANGUAGE.html){: target="_blank" rel="noopener noreferrer" title="Notes Formula Language"} + These two are wrapped into one parent formula language that encapsulates both implementations. We call this **VoltFormula**, aka RosettaJS. By nature of being a JavaScript exposed API library, the formula language can be extended via helper registration methods. diff --git a/docs/tutorials/adaptertutorial.md b/docs/tutorials/adaptertutorial.md index f56a5b1..f46df8f 100644 --- a/docs/tutorials/adaptertutorial.md +++ b/docs/tutorials/adaptertutorial.md @@ -86,7 +86,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr !!!warning "Important" Make sure that the name of the scope you enter in the **Scope** text box matches the name of the scope that you have configured in your app in Domino REST API. - ![](../assets/images/identityproviderdetails.png) + ![Identity service configuration page](../assets/images/identityproviderdetails.png) 5. Under **Client Details**: @@ -126,7 +126,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 5. Click **Test Connection** to verify that the entered URL is correct. If the test is successful, a check mark appears beside the **Server** tab. 6. Click **Save**. - ![](../assets/images/addenvironment.png) + ![Add a New Environment dialog](../assets/images/addenvironment.png) ## Configure an Object service @@ -137,7 +137,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr 5. Select **HCL Domino** under **Business Adapters** for the **Endpoint Type**. 4. Set the **Metadata Security Level** to **Authenticated App Users** to restrict the download of object service metadata to users that have successfully authenticated using the Identity Service. - ![](../assets/images/objectendpointtype.png) + ![New object service configuration page](../assets/images/objectendpointtype.png) 5. Under **Connection Parameters**: @@ -152,8 +152,6 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr !!!note Entering true in the **Return documents from Bulk Update** text field ensures the return of documents updated using the BULK UPDATE method. For more information, see [Methods](../topicguides/method.md). - - !!!tip To test the connection parameters, select the environment you added from the **Select an Environment** drop-down list and then click **Test Connection**. You will see a *Connection Successful* message if the configured connection parameters are correct. @@ -165,7 +163,7 @@ At the end of this tutorial, you can manually create an app in Volt MX Go Foundr !!!tip Click **Test Login** to test the authentication. If the configuration works, you might need to enter your Domino REST API administrator username and password in the Domino REST API login dialog and then click **Allow** in the Domino REST API **Access consent required** dialog. You might also only see the **Permission Requested** dialog without needing to enter anything. A *Test Login Successful* message is then displayed. - ![](../assets/images/objectauthentication.png) + ![Authentication section](../assets/images/objectauthentication.png) 7. Click **Save and Configure**. @@ -305,27 +303,3 @@ For more information on supported parameters, see [Supported OData query paramet 6. Click **Save** after viewing. - - diff --git a/docs/tutorials/designimport.md b/docs/tutorials/designimport.md index 5a5b026..8224cd2 100644 --- a/docs/tutorials/designimport.md +++ b/docs/tutorials/designimport.md @@ -14,12 +14,12 @@ The tutorial implements two user experiences: !!!info If you have granted access to any of the following roles: **Volt MX Go Foundry admin, Domino REST API admin,** or the **Volt MX Go Iris developer**, please follow the specific instructions for **each user**. -### Volt MX Go Foundry admin +### For Volt MX Go Foundry admin - You must the [Volt MX Go installation](installfoundry.md). - You must create a Volt MX Go Foundry admin account to the Volt MX Go Iris developer. -### Domino REST API admin +### For Domino REST API admin - You have completed the [Domino REST API installation](https://opensource.hcltechsw.com/Domino-rest-api/tutorial/installconfig/index.html). @@ -43,7 +43,7 @@ The tutorial implements two user experiences: - Provide the Domino REST API URL, Client ID, Client Secret and scope to the Volt MX Go Iris developer from your Domino REST API app. -#### For Volt MX Go Iris Developer +### For Volt MX Go Iris Developer - You must install [Volt MX Go Iris](installiris.md) - You must have a Volt MX Go Foundry admin account. @@ -90,19 +90,19 @@ The tutorial implements two user experiences: 2. On the **What do you want to start with now?** dialog, select **Web App** and click **Next**. For other platforms, please see [Native App]( ../howto/dicreatenativeapp.md). - ![](../assets/images/didevice.png){: style="height:80%;width:80%"} + ![Design Import Wizard dialog](../assets/images/didevice.png){: style="height:80%;width:80%"} 3. On the **Which device size do you want to start building for first?** dialog, select **Desktop** for Web App and click **Next**. - ![](../assets/images/distart.png){: style="height:80%;width:80%"} + ![Design Import Wizard dialog](../assets/images/distart.png){: style="height:80%;width:80%"} 4. Enter your **Project Name** and click **Create**. - ![](../assets/images/diprojectname.png){: style="height:80%;width:80%"} + ![Design Import Wizard dialog](../assets/images/diprojectname.png){: style="height:80%;width:80%"} You can now see your project name in the upper-left corner of the **Volt MX Go Iris** UI. -![](../assets/images/diappname.png){: style="height:80%;width:80%"} +![Volt MX Go Iris user interface](../assets/images/diappname.png){: style="height:80%;width:80%"} ## Import a Domino Application using a new Volt MX Go Foundry app @@ -111,15 +111,15 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I 2. On **Getting Started**, click **Next**. - ![](../assets/images/diwizard.png) + ![Design Import Wizard dialog](../assets/images/diwizard.png) 3. On **Associate Foundry App** step, click **Create New**. - ![](../assets/images/difoundryapp.png) + ![Design Import Wizard dialog](../assets/images/difoundryapp.png) The default name is the same as your **Project Name**. - ![](../assets/images/difoundrybackend.png) + ![Design Import Wizard dialog](../assets/images/difoundrybackend.png) 4. On **Identity Service**. @@ -135,11 +135,11 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I |Client Secret| This is the App Secret in Domino REST API app management. Once you configured and added your App, you may see your `App ID` and your `App Secret`. | |Service Name:| Any name that identifies the Volt MX Go Foundry Identity Services. | - ![](../assets/images/dikeep.png) + ![Design Import Wizard dialog](../assets/images/dikeep.png) - 2. Select the **identity service** - for example, MXGOISMyApp. + 2. Select the **Identity Service** - for example, MXGOISMyApp. - ![](../assets/images/didrapi.png) + ![Design Import Wizard dialog](../assets/images/didrapi.png) !!!warning "Important" - It's important to get your **callback URL** in Volt MX Go Foundry and send it to Domino REST API admin. Form more information. see [copy callback URL in Volt MX Go Foundry](#copy-callback-url-in-volt-mx-go-foundry). Be sure that your Domino REST API admin updated the callback URL in your Domino REST API application immediately without closing the wizard. @@ -152,14 +152,14 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I 4. Login with your **Domino credentials** within this wizard dialog and click **Allow**. - ![](../assets/images/didrapilogin.png) + ![Domino REST API permission request dialog](../assets/images/didrapilogin.png) 5. Select your **Foundry App Identity Service** name associated to Domino REST API and click **Next**. - ![](../assets/images/difoundry.png) + ![Design Import Wizard dialog](../assets/images/difoundry.png) !!!warning "Important" - The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [troubleshooting](../references/troubleshoot.md#domino-database-acl-and-domino-rest-api-maximum-access-level). + The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [troubleshooting](../references/troubleshoot.md#design-import). 5. On **Scope and Forms** @@ -169,11 +169,11 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I 1. Select the **scope** that you’ve configured in Domino REST API. !!!warning "Important" - The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [importing Domino Application](../tutorials/designimport.md#before-you-start). + The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [importing Domino Application](../tutorials/designimport.md#before-you-begin). - ![](../assets/images/discope.png) + ![Design Import Wizard dialog](../assets/images/discope.png) - When a **Domino REST API Issues Report** prompt appears, check [Domino REST API schema issues](../references/troubleshoot.md#domino-rest-api-schema-issues). + When a **Domino REST API Issues Report** prompt appears, check [Domino REST API schema issues](../references/troubleshoot.md#design-import). 2. **Select** or **deselect** the active `forms`, `fields` in each form, `views`, `agents`, `actions` and click **Next**. @@ -181,17 +181,17 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I - The following lists show the forms, views and action you have **active** and **inactive** in the **Domino REST API**. When selecting items, you can only choose those that are active, such as forms, views, agents, and actions. Inactive items on the other hand, only display their disabled form, action, and agent names. - These **actions**, which are basically *buttons*, can be added to your imported app. These **actions** are often active within the Domino database `.nsf` and can only be modified in the **Domino Designer**. - a. On the **Forms** tab, you may select or deselect **form**, **field within forms** and **actions**. + 1. On the **Forms** tab, you may select or deselect **form**, **field within forms** and **actions**. - ![](../assets/images/discopeform.png) + ![Design Import Wizard dialog](../assets/images/discopeform.png) - b. On the **Views** tab, you may select or deselect **views** and **actions**. + 2. On the **Views** tab, you may select or deselect **views** and **actions**. - ![](../assets/images/didbviews.png) + ![Design Import Wizard dialog](../assets/images/didbviews.png) - c. On the **Agents** tab, you may select or deselect **agents**. + 3. On the **Agents** tab, you may select or deselect **agents**. - ![alt text](../assets/images/diagents.png) + ![Design Import Wizard dialog](../assets/images/diagents.png) Follow this link to learn more on [showing Domino Agents as part of the Design Import app](../howto/diagents.md) @@ -200,7 +200,7 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I !!!note - It may take a while to complete the publishing of the imported Domino app. - ![](../assets/images/disummary.png) + ![Design Import Wizard dialog](../assets/images/disummary.png) 7. On **Result**, see the final `forms`, `views`, `actions`,`agent` and then click **Done**. @@ -211,11 +211,11 @@ You can now see your project name in the upper-left corner of the **Volt MX Go I - Turn on the **Show only error** toggle to see all the fields with the error icon. - When selecting a scope with ***active Agents***, the **Agents** tab appears. Otherwise, the **AppForms** tab is displayed. - ![](../assets/images/diresult.png) + ![Design Import Wizard dialog](../assets/images/diresult.png) Once you click **Done**, each of the selected forms, views, and agents are imported into Volt MX Go Iris through the use of `forms`. **The App Events [desktop]** appears. -![](../assets/images/dioutput.png) +![Volt MX Go Iris UI](../assets/images/dioutput.png) !!!note - You can view the final result of the Domino database `.nsf` that you configured in Domino REST API. @@ -226,21 +226,21 @@ Once you click **Done**, each of the selected forms, views, and agents are impor 1. On the top menu, select **Project** → **Import** → **Domino Application**. The **VoltMX Design Import Wizard** opens. 2. On **Getting Started**, click **Next**. - ![](../assets/images/diwizard.png) + ![Design Import Wizard dialog](../assets/images/diwizard.png) 3. On **Associate Foundry App** step: 1. Click **Use Existing**. - ![](../assets/images/dicreatenew.png) + ![Design Import Wizard dialog](../assets/images/dicreatenew.png) 2. Select **Foundry Apps**, click **Associate** and close the form. - ![](../assets/images/diassociate.png) + ![Design Import Wizard dialog](../assets/images/diassociate.png) 3. Click **Next**. - ![](../assets/images/diexfoundry.png) + ![Design Import Wizard dialog](../assets/images/diexfoundry.png) !!!info - If you have an existing Domino Application Project on your UI and you want to import and associate it with another Volt MX Go Foundry app, click the **Unlink App**. @@ -248,11 +248,11 @@ Once you click **Done**, each of the selected forms, views, and agents are impor 4. On **Identity Service**, select existing identity service. - ![](../assets/images/diexistingid.png) + ![Design Import Wizard dialog](../assets/images/diexistingid.png) 1. Select the **identity service** - for example, MXGOISMyApp. - ![](../assets/images/didrapi.png) + ![Design Import Wizard dialog](../assets/images/didrapi.png) !!!warning "Important" - It's important to get your **callback URL** in Volt MX Go Foundry and send it to Domino REST API admin. Form more information. see [copy callback URL in Volt MX Go Foundry](#copy-callback-url-in-volt-mx-go-foundry). Be sure that your Domino REST API admin updated the callback URL in your Domino REST API application immediately without closing the wizard. Otherwise, the wizard will close. @@ -261,14 +261,14 @@ Once you click **Done**, each of the selected forms, views, and agents are impor 3. Login with your **Domino credentials** within this wizard dialog and click **Allow**. - ![](../assets/images/didrapilogin.png) + ![Domino REST API permission request dialog](../assets/images/didrapilogin.png) 4. Select your **App Identity Service** name associated to Domino REST API and click **Next**. - ![](../assets/images/difoundry.png) + ![Design Import Wizard dialog](../assets/images/difoundry.png) !!!warning "Important" - The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [troubleshooting](../references/troubleshoot.md#domino-database-acl-and-domino-rest-api-maximum-access-level) + The wizard expects to stop if your login credentials don't have *Designer* access in Domino REST API on your scope, or if your Domino database ACL doesn't give you a *Designer* role. For more information, see [troubleshooting](../references/troubleshoot.md#design-import) 5. On **Scope and Forms** @@ -278,11 +278,11 @@ Once you click **Done**, each of the selected forms, views, and agents are impor 1. Select the **scope** that you’ve configured in Domino REST API. !!!warning "Important" - The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [importing Domino Application](../tutorials/designimport.md#before-you-start). + The scope name should be no more than 30 characters. If it exceeds this limit, a prompt will appear. In this case, contact your Domino REST API admin to configure your scope. Please take note of the prerequisites required for [importing Domino Application](../tutorials/designimport.md#before-you-begin). - ![](../assets/images/discope.png) + ![Design Import Wizard dialog](../assets/images/discope.png) - When a **Domino REST API Issues Report** prompt appears, check [Domino REST API schema issues](../references/troubleshoot.md#domino-rest-api-schema-issues). + When a **Domino REST API Issues Report** prompt appears, check [Domino REST API schema issues](../references/troubleshoot.md#design-import). 2. **Select** or **deselect** the active `forms`, `views`, `agents` and `actions` and click **Next**. @@ -290,17 +290,17 @@ Once you click **Done**, each of the selected forms, views, and agents are impor - The following lists show the forms, views and action you have **active** and **inactive** in the **Domino REST API**. When selecting items, you can only choose those that are active, such as forms, views, agents, and actions. Inactive items, on the other hand, only display their disabled form, action, and agent names. - These **actions**, which are basically *buttons*, can be added to your imported app. These **actions** are often configured within the Domino database `.nsf` and can only be modified in the **Domino Designer**. - a. On the **Forms** tab, you may select or deselect **form**, **field within forms** and **actions**. + 1. On the **Forms** tab, you may select or deselect **form**, **field within forms** and **actions**. - ![](../assets/images/discopeform.png) + ![Forms tab](../assets/images/discopeform.png) - b. On the **Views** tab, you may select or deselect **views** and **actions**. + 2. On the **Views** tab, you may select or deselect **views** and **actions**. - ![](../assets/images/didbviews.png) + ![Views tab](../assets/images/didbviews.png) - c. On the **Agents** tab, you may select or deselect **agents**. + 3. On the **Agents** tab, you may select or deselect **agents**. - ![alt text](../assets/images/diagents.png) + ![Agents tab](../assets/images/diagents.png) Follow this link to learn more on [showing Domino Agents as part of the Design Import app](../howto/diagents.md) @@ -309,18 +309,18 @@ Once you click **Done**, each of the selected forms, views, and agents are impor !!!note - It may take a while to complete the publishing of the imported Domino app. - ![](../assets/images/disummary.png) + ![Design Import Wizard dialog](../assets/images/disummary.png) 7. On **Result**, see the final `forms`, `views`, `actions` and `agents`, and then click **Done**. !!!note When selecting a scope with active Agents, the **Agents** tab appears. Otherwise, the **AppForms** tab is displayed. - ![](../assets/images/diresult.png) + ![Design Import Wizard dialog](../assets/images/diresult.png) Once you click **Done**, each of the selected forms, views, and agents have imported into the Volt MX Go Iris. **The App Events [desktop]** appears. -![](../assets/images/dioutput.png) +![Volt MX Go Iris user interface](../assets/images/dioutput.png) ## Copy callback URL in Volt MX Go Foundry @@ -421,7 +421,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo 2. Click **Open**. If the file is pre-existing, a dialog prompt will appear with the option to overwrite it. - ![](../assets/images/dieditsave.png) + ![Update form](../assets/images/dieditsave.png) 6. Click **Save**. diff --git a/docs/tutorials/voltformula.md b/docs/tutorials/voltformula.md index 659ea9b..47baba1 100644 --- a/docs/tutorials/voltformula.md +++ b/docs/tutorials/voltformula.md @@ -38,28 +38,6 @@ This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert for 2. Enter your email and password for Volt MX Go Foundry on the **Sign in to your account** page. 3. Click **Sign In**. Your username appears next to the profile icon. - - ## Open VoltFormula using the Action Editor !!!Tip @@ -69,22 +47,22 @@ This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert for 2. On the Project window, find the `Forms`. Once you click the `form`, the form appears on the canvass. 3. On the `form` canvass, select the widget or object you want to apply action to. **Right-click** it, and then select one of the action sequences, such as `onTouchStart`, `onClick` and others. - ![](../assets/images/vfaction.png){: style="height:80%;width:80%"} + ![Context menu](../assets/images/vfaction.png){: style="height:80%;width:80%"} The **Action Editor** opens and creates an action sequence for you to configure. 4. On the left side of the **Action Editor**, go to **Formula** and click the **Add Formula**. - ![](../assets/images/vfactioneditor.png){: style="height:80%;width:80%"} + ![Formula Editor](../assets/images/vfactioneditor.png){: style="height:80%;width:80%"} ## Translate OpenFormula and NotesFormula into JavaScript -1. On the **action editor**, click the **Add Formula** on the diagram. On the right side of the **action editor** window, you can see the properties of the voltFormula. +1. On the **Action Editor**, click the **Add Formula** on the diagram. On the right side of the **Action Editor** window, you can see the properties of the VoltFormula. - **window for the translated OpenFormula and NotesFormula in JavaScript.** - **window for the formula language** - OpenFormula and NotesFormula are the accepted formulas to add in this window. - **window for the formula results**. - ![](../assets/images/vfactioneditor.png){: style="height:90%;width:90%"} + ![Action Editor](../assets/images/vfactioneditor.png){: style="height:90%;width:90%"} 2. Click on **Formula Language** window and enter a valid formula. @@ -95,21 +73,23 @@ This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert for You can see automatically the JavaScript code with the formula you type in the **Formula Language** window. - ![](../assets/images/vfactionformula.png){: style="height:90%;width:90%"} + ![Formula Language window](../assets/images/vfactionformula.png){: style="height:90%;width:90%"} You can also see the result upon clicking the **Results** button. - ![](../assets/images/vfjavaresults.png){: style="height:90%;width:90%"} + ![Formula Results window](../assets/images/vfjavaresults.png){: style="height:90%;width:90%"} 4. Click **Save**. ## Use VoltFormula in a Controller module + ### Add formula in a controller + 1. Open a controller on **Project Explorer.** 2. Select and open your controller. This opens the code window. 3. Right-click the code window and select **Add Code from Formula**. The Formula Language window appear. - ![](../assets/images/vfaddcode.png){: style="height:90%;width:90%"} + ![Selecting Add Code from Formula](../assets/images/vfaddcode.png){: style="height:90%;width:90%"} 4. Add the code in the **Formula Language** window. @@ -120,13 +100,14 @@ This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert for - Each formula is accompanied by its category. - If you don't know how to convert the JavaScript in Volt MX Go `rosettajs` from **OpenFormula** and **NotesFormula**, you may use the Formula Language window to do so. - ![](../assets/images/vfsyntax.png){: style="height:90%;width:90%"} + ![Add code in Formula Language window](../assets/images/vfsyntax.png){: style="height:90%;width:90%"} - The code you enter in **Formula Language** is translated to autogenerated rosettajs code in the code window. + The code you enter in **Formula Language** is translated to autogenerated RosettaJS code in the code window. - ![](../assets/images/vfrosoutput.png){: style="height:90%;width:90%"} + ![Translated Formula Language](../assets/images/vfrosoutput.png){: style="height:90%;width:90%"} ### Edit formula in a controller + 1. Open a controller on **Project Explorer**. 2. Select and open your controller. This opens the code window. @@ -146,18 +127,18 @@ This tutorial shows you how to use VoltFormula in Volt MX Go Iris to convert for - **=** character for *OpenFormula* - You can see the code hinting or the IntelliSense for the formula that you choose. - Each formula is accompanied by its category. - - If you don't know how to convert the JavaScript in Volt MX Go `rosettajs` from **OpenFormula** and **NotesFormula**, you may use the Formula Language window to do so. + - If you don't know how to convert the JavaScript in Volt MX Go `RosettaJS` from **OpenFormula** and **NotesFormula**, you may use the Formula Language window to do so. - You can add or edit code in the formula language window as long as you follow the syntax. - You can add more than one line of code. - ![](../assets/images/vfsyntax1.png){: style="height:90%;width:90%"} + ![Formula Language editor](../assets/images/vfsyntax1.png){: style="height:90%;width:90%"} !!!Note - - The code you enter in **Formula Language** is translated to autogenerated `rosettajs` code in the code window. + - The code you enter in **Formula Language** is translated to autogenerated `RosettaJS` code in the code window. - You can also see the result in **Formula Results** tab. - ![](../assets/images/vfresedit.png){: style="height:90%;width:90%"} + ![Formula Language editor](../assets/images/vfresedit.png){: style="height:90%;width:90%"} ### Edit Rosetta JavaScript From e8b27101bca682f0db684a2bcfc788af618c9d27 Mon Sep 17 00:00:00 2001 From: Zerlord Santiago Date: Thu, 11 Jul 2024 01:08:27 +0800 Subject: [PATCH 2/3] Accessibility improvements --- docs/assets/css/voltmxgo.css | 4 +++ docs/howto/configrosetta.md | 4 +-- docs/howto/diagents.md | 14 ++++----- docs/howto/drapiingress.md | 2 +- docs/index.md | 10 +++---- docs/references/docguide.md | 6 ++-- docs/references/earlyaccesschanges.md | 4 +-- docs/references/index.md | 41 ++++++++++++++------------- docs/references/troubleshoot.md | 4 +-- docs/topicguides/declvariables.md | 10 +++---- docs/tutorials/designimport.md | 2 +- docs/tutorials/webinar.md | 26 ++++++++--------- 12 files changed, 66 insertions(+), 61 deletions(-) diff --git a/docs/assets/css/voltmxgo.css b/docs/assets/css/voltmxgo.css index 664e641..bc3b0cc 100644 --- a/docs/assets/css/voltmxgo.css +++ b/docs/assets/css/voltmxgo.css @@ -82,4 +82,8 @@ pre { } tr.lostLinkItem:nth-child(even) { background-color: #eeeeee; + } + + .newpageicon { + font-size: x-small; } \ No newline at end of file diff --git a/docs/howto/configrosetta.md b/docs/howto/configrosetta.md index 63c86ba..d36e490 100644 --- a/docs/howto/configrosetta.md +++ b/docs/howto/configrosetta.md @@ -30,8 +30,8 @@ You have launched Volt MX Go Iris. |Rosetta area | Rosetta area sections | Description| |-------------|------------|------------| |**API Configuration**| |Allows you to configure options specific to the APIs' implementation and execution. | - | |**Register Custom API**|Allows you to upload a file with custom APIs. Refer to the [API reference documentation](../javadoc/index.html){: target="_blank" rel="noopener noreferrer"} under the rosetta-api module for method `registerAPI` for more details on expected file format and parameters.| - | |**Preferred API Implementation**| Allows you to specify whether to execute the **Notes Formula** or the **Open Formula** implementation when calling an API method, which has an existing implementation in either formula language. Example, `@Abs()` and `=ABS()` are encapsulated by Rosettas `abs()` method. Selecting `Notes` option makes Rosetta call the Notes implementation. Usually, either implementation behaves the same. But in other cases, there may be differences in parameters, execution, or returned results. For example, most Notes formula functions allow lists to be passed in as arguments while OpenFormula allows lists as ranges for only a number of methods. Refer to the [Rosetta API reference documentation](../javadoc/index.html){: target="_blank" rel="noopener noreferrer"} for details on each API.| + | |**Register Custom API**|Allows you to upload a file with custom APIs. Refer to the [**Rosetta API reference documentation**](../javadoc/index.html) under the rosetta-api module for method `registerAPI` for more details on expected file format and parameters.| + | |**Preferred API Implementation**| Allows you to specify whether to execute the **Notes Formula** or the **Open Formula** implementation when calling an API method, which has an existing implementation in either formula language. Example, `@Abs()` and `=ABS()` are encapsulated by Rosettas `abs()` method. Selecting `Notes` option makes Rosetta call the Notes implementation. Usually, either implementation behaves the same. But in other cases, there may be differences in parameters, execution, or returned results. For example, most Notes formula functions allow lists to be passed in as arguments while OpenFormula allows lists as ranges for only a number of methods. Refer to the [**Rosetta API reference documentation**](../javadoc/index.html) for details on each API.| | **Intellisense Configuration**| |Allows you to include or exclude names of formulas that won't be implemented and not yet implemented in the formula list IntelliSense. When **Include no plans to implement items** is selected, the names of the formulas that won't be implemented are shown as ~~strikethrough text~~. If **Include not yet implemented items** is selected, the names of the formulas that aren't yet implemented are shown but appears dimmed.| |**Converter Configuration**| |Allows you to configure options related to how formulas are converted into their corresponding Rosetta-enabled JavaScript.| | |**Passthrough unrecognized formula language into JavasSript conversion results**|Allows you to specify whether the converter allows unrecognized formula code to be part of the JavaScript conversion results without any massaging, or if it should throw an error when encountering unrecognizable formula code. This allows greater flexibility but also exposes the API to injection of code. **Use with care**.| diff --git a/docs/howto/diagents.md b/docs/howto/diagents.md index a21b58e..68a2f49 100644 --- a/docs/howto/diagents.md +++ b/docs/howto/diagents.md @@ -16,7 +16,7 @@ Shows you how the **Agents** are imported to the Volt MX Iris Go Design Import. ## Procedure -1. You must finished the procedure [importing Domino Application](../tutorials/designimport.md#import-a-domino-application-using-the-new-volt-mx-go-foundry-app). +1. You must finished the procedure [importing Domino Application](../tutorials/designimport.md#import-a-domino-application-using-a-new-volt-mx-go-foundry-app). !!!important - For the Volt MX Go release v2.0.4, only limited Agents are supported. @@ -36,32 +36,32 @@ Shows you how the **Agents** are imported to the Volt MX Iris Go Design Import. 1. On the **Views**, click the **Customers B ByRegion**. - ![alt text](../assets/images/diviewagent.png) + ![Dashboard](../assets/images/diviewagent.png) The **Customers B ByRegion** will open. - ![alt text](../assets/images/diagentview.png) + ![Customers B ByRegion window](../assets/images/diagentview.png) 2. **Agents** action will be available on the navigation bar. Click the **Agents**. - ![alt text](../assets/images/diactions.png) + ![Agents context menu](../assets/images/diactions.png) The four configured Agent will appear as **actions**. These **actions** are imported from the Domino Agent, which is already set up inside the `nsf` file. 3. Click the **actions** *West to East*. - ![alt text](../assets/images/diactionclick.png) + ![Select West to East action](../assets/images/diactionclick.png) 4. It will give a prompt that the Agent has been done processing. Click **OK**. - ![alt text](../assets/images/diagtmsg.png) + ![Notification prompt](../assets/images/diagtmsg.png) 5. All customers in the *West* Region will move to the *East* Region. - ![alt text](../assets/images/diactionsresult.png) + ![Customers B ByRegion window](../assets/images/diactionsresult.png) diff --git a/docs/howto/drapiingress.md b/docs/howto/drapiingress.md index d5a0cf0..361026f 100644 --- a/docs/howto/drapiingress.md +++ b/docs/howto/drapiingress.md @@ -182,5 +182,5 @@ ingress.tls.drapiManagementCustomCert.key: “drapi-management-server.key” - The `drapiCustomCert.cert`, `drapiCustomCert.key`, `drapiManagementCustomCert.cert`, and `drapiManagementCustomCert.key` details can be omitted when using the default cluster certificate. If you go with this approach, make sure that the DNS hostname which you will access the deployment with matches the host name details in the certificate. Otherwise, the backend communication will fail because the host name doesn't match. -Return to [Deploy Domino REST API](../tutorials/downloadhelmchart.md#2-deploy-domino-rest-api) +Return to [**Deploy Domino REST API**](../tutorials/downloadhelmchart.md#2-deploy-domino-rest-api). diff --git a/docs/index.md b/docs/index.md index 8ed180e..834cbd4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ Volt MX Go modernizes and extends the value of your Domino applications with the - expanding who can code applications built in Domino, allowing for app modernization or migration without requiring a complete rewrite of the code - importing existing Domino views, forms, and fields into Volt MX Go Foundry to get a head start on your Volt MX Go applications -To learn more, see [Introducing Volt MX Go](topicguides/introvoltmxgo.md). +To learn more, see [**Introducing Volt MX Go**](topicguides/introvoltmxgo.md). --- ## Get started @@ -27,13 +27,13 @@ To learn more, see [Introducing Volt MX Go](topicguides/introvoltmxgo.md). --- ## What's new -For the latest release information about Volt MX Go, see [What's new](references/whatsnew/whatisnew.md). +For the latest release information about Volt MX Go, see [**What's new**](references/whatsnew/whatisnew.md). --- ## Quick links -- [Rosetta API reference documentation](javadoc/index.html){: target="_blank" rel="noopener noreferrer"} +- [Rosetta API reference documentation](javadoc/index.html) - [Known limitations](references/knownlimitation.md) - [Support](references/index.md#support) - [Documentation references](references/index.md#documentation-references) @@ -41,7 +41,7 @@ For the latest release information about Volt MX Go, see [What's new](references --- ## How the documentation is organized -The Volt MX Go documentation is based on the [Diátaxis framework](https://diataxis.fr/){: target="_blank" rel="noopener noreferrer"}, which organizes documentation into the following modes to address users' documentation needs at different times and in different circumstances. Below shows an overview that guides you on where to look for needed information: +The Volt MX Go documentation is based on the [**Diátaxis framework** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://diataxis.fr/ "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"}, which organizes documentation into the following modes to address users' documentation needs at different times and in different circumstances. Below shows an overview that guides you on where to look for needed information: **[Tutorials](tutorials/index.md)** - Hands-on introduction to Volt MX Go @@ -52,5 +52,5 @@ The Volt MX Go documentation is based on the [Diátaxis framework](https://diata **[References](references/index.md)** - Technical references and descriptions on using Volt MX Go !!!tip - For more information on effectively using the Volt MX Go documentation, see [Guide to documentation](references/docguide.md). + For more information on using the Volt MX Go documentation, see [**Guide to documentation**](references/docguide.md). diff --git a/docs/references/docguide.md b/docs/references/docguide.md index 3591116..31f3bc5 100644 --- a/docs/references/docguide.md +++ b/docs/references/docguide.md @@ -29,7 +29,7 @@ The Volt MX Go documentation has a top menu bar that includes the main document Each topic page has a main body, containing the content, and sidebars. The left sidebar shows all the topics under the selected main document section. The right sidebar shows all the sections in the topic page. -A topic page may include links to other topics within the documentation and links to external references. The links to topics within the documentation open in the same browser tab, while links to external references open in new browser tabs. +A topic page may include links to other topics within the documentation and links to external references. The links are distinguishable by a different font color. The links to topics within the documentation open in the same browser tab, while links to external references open in new browser tabs and are distinguishable by the :fontawesome-solid-up-right-from-square:{.newpageicon} icon. ## Searching for information @@ -39,6 +39,6 @@ The search result shows the number of documents with content matching all or any ## Support and community -- To open support tickets, go to the [Customer Support](https://support.hcltechsw.com/csm){: target="_blank" rel="noopener noreferrer"} portal. -- To share information, ask questions, and learn about Volt MX Go, go to the [Community](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d){: target="_blank" rel="noopener noreferrer"} portal. +- To open support tickets, go to the [**Customer Support** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/csm "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} portal. +- To share information, ask questions, and learn about Volt MX Go, go to the [**Community** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} portal. diff --git a/docs/references/earlyaccesschanges.md b/docs/references/earlyaccesschanges.md index 81a7b3b..d656877 100644 --- a/docs/references/earlyaccesschanges.md +++ b/docs/references/earlyaccesschanges.md @@ -35,7 +35,7 @@ The section provides information on the features, improvements, and resolved iss #### VoltFormula - IntelliSense improvements on category beside each formula. -- Update the Rosetta API and Rosetta converter which can be seen in [Rosetta API reference documentation](https://help.hcltechsw.com/docs/voltmxgo/javadoc/index.html). +- Update the Rosetta API and Rosetta converter which can be seen in [Rosetta API reference documentation](../javadoc/index.html). ##### Design Import - Improvements on the error toggle button on the **VoltMX Design Import Wizard**. - Improve the sort configuration in importing the forms generated. @@ -75,7 +75,7 @@ The section provides information on the features, improvements, and resolved iss - Implemented UI improvements on the **VoltMX Design Import Wizard** for better user experience. #### VoltFormula -- Updated the list of Notes and Open formulas in [Rosetta API reference documentation](https://help.hcltechsw.com/docs/voltmxgo/javadoc/index.html). +- Updated the list of Notes and Open formulas in [Rosetta API reference documentation](../javadoc/index.html). ### Others diff --git a/docs/references/index.md b/docs/references/index.md index 2a0e915..358b4e2 100644 --- a/docs/references/index.md +++ b/docs/references/index.md @@ -4,74 +4,75 @@ Provides technical references and descriptions for using Volt MX Go. ## What's new -Check the [latest information](whatsnew/whatisnew.md) about Volt MX Go. +Check the [**latest information**](whatsnew/whatisnew.md) about Volt MX Go. -To know the details in the early access version, see [Early Access Version changes](earlyaccesschanges.md){: target="blank"}. +To know the details in the early access version, see [**Early Access Version changes**](earlyaccesschanges.md){: target="blank"}. ## System requirements -Check the minimum [System requirements](../tutorials/sysreq.md) for deploying Volt MX Go. +Check the minimum [**System requirements**](../tutorials/sysreq.md) for deploying Volt MX Go. ## Compatibility matrix -Check [version compatibility](compatibilitymatrix.md) between Volt MX Go and Domino REST API. +Check [**version compatibility**](compatibilitymatrix.md) between Volt MX Go and Domino REST API. ## Rosetta API reference documentation -The full specification of the API is available in a structured format in the [Rosetta API reference documentation](../javadoc/index.html){: target="_blank" rel="noopener noreferrer"}. +The full specification of the API is available in a structured format in the [**Rosetta API reference documentation**](../javadoc/index.html). -For the implementation status, see [Rosetta API implementation status](../javadoc/api_status.html){: target="_blank" rel="noopener noreferrer"}. +For the implementation status, see [**Rosetta API implementation status**](../javadoc/api_status.html). ## VoltFormula coding practices -Recommended [VoltFormula coding practices](../topicguides/vfcodingguides.md) in Volt MX Go Iris. +Recommended [**VoltFormula coding practices**](../topicguides/vfcodingguides.md) in Volt MX Go Iris. ## Helm and Kubectl commands -Useful [Helm and Kubectl commands](kubecheatsheet.md) related to [Volt MX Go installation](../tutorials/installation.md). +Useful [**Helm and Kubectl commands**](kubecheatsheet.md) related to [**Volt MX Go installation**](../tutorials/installation.md). ## Logging levels -Describes different [logging levels](reflogginglevels.md) for better monitoring and evaluation of activities and events. +Describes different [**logging levels**](reflogginglevels.md) for better monitoring and evaluation of activities and events. ## Documentation references -[HCL Volt MX Documentation](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/index.html){: target="_blank" rel="noopener noreferrer"} +[**HCL Volt MX Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/index.html "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} - Provides documentation and more information about Volt MX Iris and Volt MX Foundry. -[HCL Domino REST API Documentation](https://opensource.hcltechsw.com/Domino-rest-api/index.html){: target="_blank" rel="noopener noreferrer"} +[**HCL Domino REST API Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://opensource.hcltechsw.com/Domino-rest-api/index.html "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} - Provides documentation and more information about Domino REST API. -[HCL Domino Documentation](https://help.hcltechsw.com/domino/welcome/index.html){: target="_blank" rel="noopener noreferrer"} +[**HCL Domino Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://help.hcltechsw.com/domino/welcome/index.html "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} - Provides documentation and more information on how to install, configure, and manage Domino servers and related components. -[HCL Software Product Documentation](https://help.hcltechsw.com/){: target="_blank" rel="noopener noreferrer"} +[**HCL Software Product Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://help.hcltechsw.com/ "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} - Provides a complete list of links to the documentation of different HCL Software products. -[VoltScript](https://help.hcltechsw.com/docs/voltscript/early-access/index.html){: target="_blank" rel="noopener noreferrer"} +[**VoltScript** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://help.hcltechsw.com/docs/voltscript/early-access/index.html "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} - Provides documentation and more information about the **early access version** of VoltScript and related components. ## Known limitations -List of [known limitations](knownlimitation.md) of Volt MX Go. +List of [**known limitations**](knownlimitation.md) of Volt MX Go. ## Troubleshooting -To learn about identified issues and their corresponding workarounds and resolutions, see [Troubleshooting](troubleshoot.md). +To learn about identified issues and their corresponding workarounds and resolutions, see [**Troubleshooting**](troubleshoot.md). + ## Support -- To open support tickets, go to the [Customer Support](https://support.hcltechsw.com/csm){: target="_blank" rel="noopener noreferrer"} portal. +- To open support tickets, go to the [**Customer Support** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/csm "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} portal. -- To share information, ask questions, and learn about Volt MX Go, go to the [Community](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d){: target="_blank" rel="noopener noreferrer"} portal. +- To share information, ask questions, and learn about Volt MX Go, go to the [**Community** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} portal. ## Summernote Editor -[Summernote Editor](summernotewidget.md) enables you to add a WYSIWYG editor to your form for handling rich text. +[**Summernote Editor**](summernotewidget.md) enables you to add a WYSIWYG editor to your form for handling rich text. ## Guide to documentation -Provides a [guide](docguide.md) on effectively using the Volt MX Go documentation. \ No newline at end of file +Provides a [**guide**](docguide.md) on using the Volt MX Go documentation. \ No newline at end of file diff --git a/docs/references/troubleshoot.md b/docs/references/troubleshoot.md index 36a7272..94119e9 100644 --- a/docs/references/troubleshoot.md +++ b/docs/references/troubleshoot.md @@ -8,13 +8,13 @@ List of issues and corresponding resolutions. - 403 Insufficient access error due to incorrect Maximum Access Level[^1] of scope: - ![alt text](../assets/images/didrapierr.png) + ![Error dialog](../assets/images/didrapierr.png) You should contact your Domino REST API administrator to update your scope's Maximum Access Level to *Designer*. - 403 Insufficient access error due to incorrect database access level: - ![alt text](../assets/images/diaclerr.png) + ![Error dialog](../assets/images/diaclerr.png) You should contact your Domino administrator to update your assigned access level to the Domino database to *Designer*. diff --git a/docs/topicguides/declvariables.md b/docs/topicguides/declvariables.md index 6d99592..0106c47 100644 --- a/docs/topicguides/declvariables.md +++ b/docs/topicguides/declvariables.md @@ -16,7 +16,7 @@ There are two mechanisms by which the Rosetta Converter accepts and converts var ``` =LET(x, 5, SUM(x, 1)) ``` -![alt text](../assets/images/vflet.png) +![LET function example](../assets/images/vflet.png) ## Using JSP style syntax @@ -26,7 +26,7 @@ Example: - **OpenFormula:** - ![alt text](../assets/images/vfjsp.png) + ![OpenFormula example](../assets/images/vfjsp.png) Although Notes formula language already provides means to declare variables, the converter can also use the **JSP expression** syntax in a ***Notes*** formula. @@ -34,13 +34,13 @@ Examples: - **Notes formula** with native notes variable declaration expression: - ![alt text](../assets/images/vfnotesnative.png) + ![Notes formula example](../assets/images/vfnotesnative.png) - **Notes formula** with JSP-based variable declaration expression: - ![alt text](../assets/images/vfnotesjsp.png) + ![Notes formula example](../assets/images/vfnotesjsp.png) !!!note - To use JSP expression in formulas, select **Passthrough unrecognized formula language into JavasSript conversion results** checkbox. For more information, see [Configure VoltFormula's Rosetta API Options](../howto/configrosetta.md). + To use JSP expression in formulas, select **Passthrough unrecognized formula language into JavasSript conversion results** checkbox. For more information, see [**Configure VoltFormula's Rosetta API Options**](../howto/configrosetta.md). diff --git a/docs/tutorials/designimport.md b/docs/tutorials/designimport.md index 8224cd2..a91cc8a 100644 --- a/docs/tutorials/designimport.md +++ b/docs/tutorials/designimport.md @@ -329,7 +329,7 @@ Once you click **Done**, each of the selected forms, views, and agents have impo 3. On the **Configure Services tab** → **Identity tab**, select and click your *Identity Service* name. 4. Find and click *copy* of **Callback URL** field. - ![alt text](../assets/images/dicallbackurl.png) + ![Callback URL field](../assets/images/dicallbackurl.png) 5. Send the **callback URL** to Domino REST API admin. diff --git a/docs/tutorials/webinar.md b/docs/tutorials/webinar.md index 64a3626..21bcbef 100644 --- a/docs/tutorials/webinar.md +++ b/docs/tutorials/webinar.md @@ -5,13 +5,13 @@ Check the following platforms to learn how to modernize your Domino applications ## HCLSoftware U !!!info "Embark On Your Journey" - Realize the power of possibility for you and your business. Visit **[HCLSoftware U](https://hclsoftwareu.hcltechsw.com/){: target="_blank" rel="noopener noreferrer"}** for technical education on all products in the HCL Software portfolio. Start learning today! + Realize the power of possibility for you and your business. Visit [**HCLSoftware U** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsoftwareu.hcltechsw.com/ "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} for technical education on all products in the HCL Software portfolio. Start learning today! -Get hands-on development experience modernizing a Domino application with Volt MX Go and learn how to install and configure HCL Volt MX Go as an administrator. Check out the [Volt MX Go learning journey in HCLSoftware U](https://hclsoftwareu.hcltechsw.com/volt-mx-go){: target="_blank" rel="noopener noreferrer"}. +Get hands-on development experience modernizing a Domino application with Volt MX Go and learn how to install and configure HCL Volt MX Go as an administrator. Check out the [**Volt MX Go learning journey in HCLSoftware U** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsoftwareu.hcltechsw.com/volt-mx-go "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"}. ## Volt MX Go Webinar Series -Watch the [Volt MX Go Webinar series](https://www.youtube.com/playlist?list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF){: target="_blank" rel="noopener noreferrer"} to better understand how to modernize your Domino apps while avoiding the cost, time, and risk of a total rewrite. The webinar series shows you how to: +Watch the [**Volt MX Go Webinar series** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/playlist?list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} to better understand how to modernize your Domino apps while avoiding the cost, time, and risk of a total rewrite. The webinar series shows you how to: - extend existing Domino apps with multi-experience capabilities and advanced UX while retaining existing business logic - maximize your years of investment in Domino apps and skills @@ -20,18 +20,18 @@ Watch the [Volt MX Go Webinar series](https://www.youtube.com/playlist?list=PLEj The webinar series includes the following webinars: -- [Modernizing Domino Apps with Volt MX Go](https://www.youtube.com/watch?v=90GAEFmKvng&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=1&pp=iAQB){: target="_blank" rel="noopener noreferrer"} -- [Volt MX Go: VoltFormula](https://www.youtube.com/watch?v=a_d0y0OJzfc&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=2&pp=iAQB){: target="_blank" rel="noopener noreferrer"} -- [Volt MX Go: First Touch, Domino REST API, and Design Import](https://www.youtube.com/watch?v=ipelDFuYjHw&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=3&pp=iAQB){: target="_blank" rel="noopener noreferrer"} -- [Get started with Volt MX Go Iris and Foundry](https://www.youtube.com/watch?v=rWQKhgb_Ang&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=4&pp=iAQB){: target="_blank" rel="noopener noreferrer"} -- [Try VoltScript with Early Access](https://www.youtube.com/watch?v=Nfl6LCFySPA&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=5&pp=iAQB){: target="_blank" rel="noopener noreferrer"} -- [Build beautiful apps with Volt MX Go and Domino](https://www.youtube.com/watch?v=IqQcBGMcjl4&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=6&pp=iAQB){: target="_blank" rel="noopener noreferrer"} +- [Modernizing Domino Apps with Volt MX Go :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=90GAEFmKvng&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=1&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +- [Volt MX Go: VoltFormula :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=a_d0y0OJzfc&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=2&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +- [Volt MX Go: First Touch, Domino REST API, and Design Import :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=ipelDFuYjHw&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=3&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +- [Get started with Volt MX Go Iris and Foundry :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=rWQKhgb_Ang&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=4&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +- [Try VoltScript with Early Access :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=Nfl6LCFySPA&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=5&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +- [Build beautiful apps with Volt MX Go and Domino :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=IqQcBGMcjl4&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=6&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} ## Volt MX Go on HCL SoFy -Explore everything Volt MX Go can do in a free, hosted trial environment on [HCL SoFy](https://hclsofy.com/){: target="_blank" rel="noopener noreferrer"}. Your sandbox will be up and running in 10 minutes and provides access to a hosted Domino server (where you can copy or replicate your own Domino applications), the Domino REST API, Volt MX Go Foundry, and Volt MX Go Iris, a step-by-step wizard to connect Volt MX to Domino, Design Import, and VoltFormula. Check the following links for more information: +Explore everything Volt MX Go can do in a free, hosted trial environment on [**HCL SoFy** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/ "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"}. Your sandbox will be up and running in 10 minutes and provides access to a hosted Domino server (where you can copy or replicate your own Domino applications), the Domino REST API, Volt MX Go Foundry, and Volt MX Go Iris, a step-by-step wizard to connect Volt MX to Domino, Design Import, and VoltFormula. Check the following links for more information: -- [Overview of Volt MX Go](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=documentation.md){: target="_blank" rel="noopener noreferrer"} -- [Using Volt MX Go on Sofy](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=using-voltmxgo.md){: target="_blank" rel="noopener noreferrer"} -- [Video Walkthrough](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=video-walkthrough.md){: target="_blank" rel="noopener noreferrer"} \ No newline at end of file +- [Overview of Volt MX Go :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=documentation.md "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +- [Using Volt MX Go on Sofy :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=using-voltmxgo.md "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +- [Video Walkthrough :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=video-walkthrough.md "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} \ No newline at end of file From c2dec444b40746bf9e48e40bb8aac81fefd33ed9 Mon Sep 17 00:00:00 2001 From: Zerlord Santiago Date: Thu, 11 Jul 2024 19:24:07 +0800 Subject: [PATCH 3/3] Accessibility improvements --- docs/howto/clearfunction.md | 60 ++++++++++++++++++------------------- docs/index.md | 2 +- docs/references/docguide.md | 4 +-- docs/references/index.md | 14 ++++----- docs/tutorials/webinar.md | 26 ++++++++-------- 5 files changed, 53 insertions(+), 53 deletions(-) diff --git a/docs/howto/clearfunction.md b/docs/howto/clearfunction.md index bfe31b4..532c9d7 100644 --- a/docs/howto/clearfunction.md +++ b/docs/howto/clearfunction.md @@ -13,81 +13,81 @@ Shows you how to clear JavaScript code and formulas in **Controller** and **Acti ## Procedure in Controller -**For removing formula using Clear button** +### For removing formula using Clear button 1. Go to your **Project** → **Responsive Web/ Desktop/ Mobile** → **Controller**. -2. Click the **Controller** you want change. +2. Click the **Controller** you want to change. 3. Click **Clear** to delete the formula and the JavaScript code in the editor. - ![alt text](../assets/images/vfclearformula.png) + ![Clear button in Formula Editor](../assets/images/vfclearformula.png) -4. A confirmation dialog shows to confirm delete. Click **Yes** to delete the formula and JavaScript code. +4. A confirmation dialog shows to confirm deletion. Click **Yes** to delete the formula and JavaScript code. - ![alt text](../assets/images/vfdeldialog.png) + ![Delete confirmation dialog](../assets/images/vfdeldialog.png) - The **Clear** button deleted the formula and the JavaScript code. + The Formula Editor after deleting the formula and the JavaScript code. - ![alt text](../assets/images/vfremoveform.png) + ![Formula editor after deletion](../assets/images/vfremoveform.png) -**For removing formula using Delete Formula button** +### For removing formula using Delete Formula button 1. Go to your **Project** → **Responsive Web/ Desktop/ Mobile** → **Controller**. -2. Click the **Controller** you want change. +2. Click the **Controller** you want to change. -3. Right-click on the JavaScript code and click the **Delete button** +3. Right-click on the JavaScript code and select **Delete Formula**. - ![alt text](../assets/images/vfclearformula2.png) + ![Selecting Delete Formula from the context menu](../assets/images/vfclearformula2.png) -4. A confirmation dialog shows to confirm delete. Click **Yes** to delete the formula and JavaScript code. +4. A confirmation dialog shows to confirm deletion. Click **Yes** to delete the formula and JavaScript code. - ![alt text](../assets/images/vfdeldialog2.png) + ![Delete confirmation dialog](../assets/images/vfdeldialog2.png) - The **Clear** button deleted the formula and the JavaScript code. + The Formula Editor after deleting the formula and the JavaScript code. - ![alt text](../assets/images/vfremoveform2.png) + ![Formula editor after deletion](../assets/images/vfremoveform2.png) ## Procedure in Action Editor -**For deleting formula and JavaScript code using Clear button** +### For deleting formula and JavaScript code using Clear button -1. Go to your **Project** → **Responsive Web/ Desktop/ Mobile** → **Forms**. For example, you have created a **button** on your form. +1. Go to your **Project** → **Responsive Web/ Desktop/ Mobile** → **Forms**. For example, you have created a **Button** on your form. 2. Click **Edit** on **Action** tab. For example, **onClick**. - ![alt text](../assets/images/vfbutton.png) + ![Edit button on Action tab](../assets/images/vfbutton.png) -3. The **Action Editor** window opens. Click **Clear** button to delete the formula and the JavaScript code in the editor. +3. The **Action Editor** window opens. Click **Clear** to delete the formula and the JavaScript code in the editor. - ![alt text](../assets/images/vfclearformula3.png) + ![Action Editor](../assets/images/vfclearformula3.png) 4. A confirmation dialog shows to confirm delete. Click **Yes** to delete the formula and JavaScript code. - ![alt text](../assets/images/vfdeldialog3.png) + ![Delete confirmation dialog](../assets/images/vfdeldialog3.png) - The **Clear** button deleted the formula and the JavaScript code. + The **Action Editor** after deleting the formula and the JavaScript code. - ![alt text](../assets/images/vfremoveform3.png) + ![Action Editor after completing delete](../assets/images/vfremoveform3.png) -**For removing formula using Delete Formula button** +### For removing formula using Delete Formula button 1. Go to your **Project** → **Responsive Web/ Desktop/ Mobile** → **Forms**. 2. Click **Edit** on **Action** tab. For example, **onClick**. - ![alt text](../assets/images/vfbutton.png) + ![Action tab](../assets/images/vfbutton.png) -3. The **Action Editor** window opens. Right-click on the JavaScript code and click the **Delete button**. +3. The **Action Editor** window opens. Right-click on the JavaScript code and click **Delete Formula**. - ![alt text](../assets/images/vfclearformula4.png) + ![Selecting Delete Formula](../assets/images/vfclearformula4.png) 4. A confirmation dialog shows to confirm delete. Click **Yes** to delete the formula and JavaScript code. - ![alt text](../assets/images/vfdeldialog4.png) + ![Delete confirmation dialog](../assets/images/vfdeldialog4.png) - The **Clear** button deleted the formula and the JavaScript code. + The **Action Editor** after deleting the formula and the JavaScript code. - ![alt text](../assets/images/vfremoveform4.png) \ No newline at end of file + ![Action Editor](../assets/images/vfremoveform4.png) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 834cbd4..04ae583 100644 --- a/docs/index.md +++ b/docs/index.md @@ -41,7 +41,7 @@ For the latest release information about Volt MX Go, see [**What's new**](refere --- ## How the documentation is organized -The Volt MX Go documentation is based on the [**Diátaxis framework** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://diataxis.fr/ "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"}, which organizes documentation into the following modes to address users' documentation needs at different times and in different circumstances. Below shows an overview that guides you on where to look for needed information: +The Volt MX Go documentation is based on the [**Diátaxis framework** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://diataxis.fr/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"}, which organizes documentation into the following modes to address users' documentation needs at different times and in different circumstances. Below shows an overview that guides you on where to look for needed information: **[Tutorials](tutorials/index.md)** - Hands-on introduction to Volt MX Go diff --git a/docs/references/docguide.md b/docs/references/docguide.md index 31f3bc5..3957a3d 100644 --- a/docs/references/docguide.md +++ b/docs/references/docguide.md @@ -39,6 +39,6 @@ The search result shows the number of documents with content matching all or any ## Support and community -- To open support tickets, go to the [**Customer Support** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/csm "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} portal. -- To share information, ask questions, and learn about Volt MX Go, go to the [**Community** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} portal. +- To open support tickets, go to the [**Customer Support** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/csm "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} portal. +- To share information, ask questions, and learn about Volt MX Go, go to the [**Community** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} portal. diff --git a/docs/references/index.md b/docs/references/index.md index 358b4e2..5af0244 100644 --- a/docs/references/index.md +++ b/docs/references/index.md @@ -35,23 +35,23 @@ Describes different [**logging levels**](reflogginglevels.md) for better monitor ## Documentation references -[**HCL Volt MX Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/index.html "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +[**HCL Volt MX Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/index.html "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} - Provides documentation and more information about Volt MX Iris and Volt MX Foundry. -[**HCL Domino REST API Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://opensource.hcltechsw.com/Domino-rest-api/index.html "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +[**HCL Domino REST API Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://opensource.hcltechsw.com/Domino-rest-api/index.html "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} - Provides documentation and more information about Domino REST API. -[**HCL Domino Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://help.hcltechsw.com/domino/welcome/index.html "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +[**HCL Domino Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://help.hcltechsw.com/domino/welcome/index.html "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} - Provides documentation and more information on how to install, configure, and manage Domino servers and related components. -[**HCL Software Product Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://help.hcltechsw.com/ "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +[**HCL Software Product Documentation** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://help.hcltechsw.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} - Provides a complete list of links to the documentation of different HCL Software products. -[**VoltScript** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://help.hcltechsw.com/docs/voltscript/early-access/index.html "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +[**VoltScript** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://help.hcltechsw.com/docs/voltscript/early-access/index.html "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} - Provides documentation and more information about the **early access version** of VoltScript and related components. @@ -65,9 +65,9 @@ To learn about identified issues and their corresponding workarounds and resolut ## Support -- To open support tickets, go to the [**Customer Support** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/csm "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} portal. +- To open support tickets, go to the [**Customer Support** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/csm "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} portal. -- To share information, ask questions, and learn about Volt MX Go, go to the [**Community** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} portal. +- To share information, ask questions, and learn about Volt MX Go, go to the [**Community** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} portal. ## Summernote Editor diff --git a/docs/tutorials/webinar.md b/docs/tutorials/webinar.md index 21bcbef..530e47f 100644 --- a/docs/tutorials/webinar.md +++ b/docs/tutorials/webinar.md @@ -5,13 +5,13 @@ Check the following platforms to learn how to modernize your Domino applications ## HCLSoftware U !!!info "Embark On Your Journey" - Realize the power of possibility for you and your business. Visit [**HCLSoftware U** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsoftwareu.hcltechsw.com/ "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} for technical education on all products in the HCL Software portfolio. Start learning today! + Realize the power of possibility for you and your business. Visit [**HCLSoftware U** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsoftwareu.hcltechsw.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} for technical education on all products in the HCL Software portfolio. Start learning today! -Get hands-on development experience modernizing a Domino application with Volt MX Go and learn how to install and configure HCL Volt MX Go as an administrator. Check out the [**Volt MX Go learning journey in HCLSoftware U** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsoftwareu.hcltechsw.com/volt-mx-go "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"}. +Get hands-on development experience modernizing a Domino application with Volt MX Go and learn how to install and configure HCL Volt MX Go as an administrator. Check out the [**Volt MX Go learning journey in HCLSoftware U** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsoftwareu.hcltechsw.com/volt-mx-go "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"}. ## Volt MX Go Webinar Series -Watch the [**Volt MX Go Webinar series** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/playlist?list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} to better understand how to modernize your Domino apps while avoiding the cost, time, and risk of a total rewrite. The webinar series shows you how to: +Watch the [**Volt MX Go Webinar series** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/playlist?list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} to better understand how to modernize your Domino apps while avoiding the cost, time, and risk of a total rewrite. The webinar series shows you how to: - extend existing Domino apps with multi-experience capabilities and advanced UX while retaining existing business logic - maximize your years of investment in Domino apps and skills @@ -20,18 +20,18 @@ Watch the [**Volt MX Go Webinar series** :fontawesome-solid-up-right-from-s The webinar series includes the following webinars: -- [Modernizing Domino Apps with Volt MX Go :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=90GAEFmKvng&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=1&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} -- [Volt MX Go: VoltFormula :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=a_d0y0OJzfc&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=2&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} -- [Volt MX Go: First Touch, Domino REST API, and Design Import :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=ipelDFuYjHw&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=3&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} -- [Get started with Volt MX Go Iris and Foundry :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=rWQKhgb_Ang&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=4&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} -- [Try VoltScript with Early Access :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=Nfl6LCFySPA&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=5&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} -- [Build beautiful apps with Volt MX Go and Domino :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=IqQcBGMcjl4&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=6&pp=iAQB "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} +- [Modernizing Domino Apps with Volt MX Go :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=90GAEFmKvng&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=1&pp=iAQB "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} +- [Volt MX Go: VoltFormula :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=a_d0y0OJzfc&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=2&pp=iAQB "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} +- [Volt MX Go: First Touch, Domino REST API, and Design Import :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=ipelDFuYjHw&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=3&pp=iAQB "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} +- [Get started with Volt MX Go Iris and Foundry :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=rWQKhgb_Ang&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=4&pp=iAQB "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} +- [Try VoltScript with Early Access :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=Nfl6LCFySPA&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=5&pp=iAQB "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} +- [Build beautiful apps with Volt MX Go and Domino :fontawesome-solid-up-right-from-square:{.newpageicon}](https://www.youtube.com/watch?v=IqQcBGMcjl4&list=PLEjl4yzB6ckEi3PDf0UKyotYpojLzUIDF&index=6&pp=iAQB "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} ## Volt MX Go on HCL SoFy -Explore everything Volt MX Go can do in a free, hosted trial environment on [**HCL SoFy** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/ "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"}. Your sandbox will be up and running in 10 minutes and provides access to a hosted Domino server (where you can copy or replicate your own Domino applications), the Domino REST API, Volt MX Go Foundry, and Volt MX Go Iris, a step-by-step wizard to connect Volt MX to Domino, Design Import, and VoltFormula. Check the following links for more information: +Explore everything Volt MX Go can do in a free, hosted trial environment on [**HCL SoFy** :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/ "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"}. Your sandbox will be up and running in 10 minutes and provides access to a hosted Domino server (where you can copy or replicate your own Domino applications), the Domino REST API, Volt MX Go Foundry, and Volt MX Go Iris, a step-by-step wizard to connect Volt MX to Domino, Design Import, and VoltFormula. Check the following links for more information: -- [Overview of Volt MX Go :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=documentation.md "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} -- [Using Volt MX Go on Sofy :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=using-voltmxgo.md "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} -- [Video Walkthrough :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=video-walkthrough.md "Link opens in a new window"){: target="_blank" rel="noopener noreferrer"} \ No newline at end of file +- [Overview of Volt MX Go :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=documentation.md "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} +- [Using Volt MX Go on Sofy :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=using-voltmxgo.md "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} +- [Video Walkthrough :fontawesome-solid-up-right-from-square:{.newpageicon}](https://hclsofy.com/sofy/catalog/hcl-voltmxgo-small?view=doc&file=video-walkthrough.md "Link opens a new tab"){: target="_blank" rel="noopener noreferrer"} \ No newline at end of file