Skip to content

Commit

Permalink
Merge pull request #201 from Volt-MX-GO/zerlordMXGo-070924
Browse files Browse the repository at this point in the history
Zerlord mx go 070924
  • Loading branch information
zerlordsantiago authored and GitHub Enterprise committed Jul 11, 2024
2 parents d583f8d + c2dec44 commit 8b00fb3
Show file tree
Hide file tree
Showing 24 changed files with 203 additions and 276 deletions.
4 changes: 4 additions & 0 deletions docs/assets/css/voltmxgo.css
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,8 @@ pre {
}
tr.lostLinkItem:nth-child(even) {
background-color: #eeeeee;
}

.newpageicon {
font-size: x-small;
}
60 changes: 30 additions & 30 deletions docs/howto/clearfunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![Action Editor](../assets/images/vfremoveform4.png)
8 changes: 4 additions & 4 deletions docs/howto/configmobile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

Expand All @@ -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**.
4 changes: 2 additions & 2 deletions docs/howto/configrosetta.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.|
Expand Down
14 changes: 7 additions & 7 deletions docs/howto/diagents.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)



Expand Down
8 changes: 4 additions & 4 deletions docs/howto/dicreatenativeapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/drapiingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

4 changes: 2 additions & 2 deletions docs/howto/importvoltformula.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

4 changes: 2 additions & 2 deletions docs/howto/logginglevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

4 changes: 2 additions & 2 deletions docs/howto/regunregconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand All @@ -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**.

Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -27,21 +27,21 @@ 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)

---
## 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 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

Expand All @@ -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).

Loading

0 comments on commit 8b00fb3

Please sign in to comment.