Merge pull request #308 from doc4d/main

edits in R2

.doc_preprocessing.json

@@ -16,17 +16,19 @@
         "languages":["de", "es", "fr", "ja", "pt"]
     },
     "build_syntax": {
-        "path":"./docs/API/",
+        "path":"./docs/",
+        "exclude_list":["ViewPro"],
         "syntax_output":"./syntax/en.lproj/syntaxEN.json",
-        "config":"../preprocessing.conf",
+        "config":"preprocessing.conf",
         "syntax_only":true,
         "syntax_pretty":true
     },
     "build_syntax_translated": {
-        "path":"./i18n/%language%/docusaurus-plugin-content-docs/current/API/",
+        "path":"./i18n/%language%/docusaurus-plugin-content-docs/current/",
         "languages":["de", "es", "fr", "ja", "pt"],
+        "exclude_list":["ViewPro"],
         "syntax_output":"./syntax/%language%.lproj/syntax%LANGUAGE%.json",
-        "config":"../../../../../docs/preprocessing.conf",
+        "config":"../../../../docs/preprocessing.conf",
         "syntax_only":true,
         "syntax_pretty":true
     },

docs/API/WebFormClass.md

@@ -0,0 +1,131 @@
+---
+id: WebFormClass
+title: WebForm
+---
+
+<details><summary>History</summary>
+
+|Version|Changes|
+|---|---|
+|v20 R2|Added|
+
+</details>
+
+
+The `WebForm` class contains functions and properties allowing to handle your Qodly webform components. This class is detailed in the [Qodly documentation](https://developer.qodly.com/docs/language/WebFormClass).
+
+
+
+
+### Commands and functions
+
+||
+|---|
+|[<!-- INCLUDE #WebFormClass.componentName.Syntax -->](#componentname)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #WebFormClass.componentName.Summary -->|
+|[<!-- INCLUDE #WebFormClass.setError().Syntax -->](#seterror)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #WebFormClass.setError().Summary -->|
+|[<!-- INCLUDE #WebFormClass.setMessage().Syntax -->](#setmessage)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #WebFormClass.setMessage().Summary -->|
+|[<!-- INCLUDE #WebFormClass.setWarning().Syntax -->](#setwarning)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #WebFormClass.setWarning().Summary -->|
+|[<!-- INCLUDE #_command_.Web Form.Syntax -->](#web-form)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #_command_.Web Form.Summary -->|
+|[<!-- INCLUDE #_command_.Web Event.Syntax -->](#web-event)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #_command_.Web Event.Summary -->|
+
+
+
+### *.componentName*
+
+<!-- REF #WebFormClass.componentName.Syntax -->***.componentName*** : [4D.WebFormItem](WebFormItemclass.md)<!-- END REF -->
+
+#### Description
+
+The components of webforms are <!-- REF #WebFormClass.componentName.Summary -->objects that are available directly as properties<!-- END REF --> of these webforms.
+
+For more information, please refer to the [`.componentName` description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormClass#componentname). 
+
+
+
+### .setError()
+
+<!-- REF #WebFormClass.setError().Syntax -->
+**.setError**( *msg* : string)<!-- END REF -->
+
+<!-- REF #WebFormClass.setError().Params -->
+|Parameter|Type||Description|
+|---------|--- |:---:|------|
+|msg|string|->|Error message to display in the web form|
+<!-- END REF -->
+
+#### Description
+
+The `.setError()` function <!-- REF #WebFormClass.setError().Summary -->sends *msg* as an error message to the web form<!-- END REF -->.
+
+For more information, please refer to the [`.setError()` description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormClass#seterror). 
+
+
+
+### .setMessage()
+
+<!-- REF #WebFormClass.setMessage().Syntax -->
+**.setMessage**( *msg* : string)<!-- END REF -->
+
+<!-- REF #WebFormClass.setMessage().Params -->
+|Parameter|Type||Description|
+|---------|--- |:---:|------|
+|msg|string|->|Information message to display in the web form|
+<!-- END REF -->
+
+#### Description
+
+The `.setMessage()` function <!-- REF #WebFormClass.setMessage().Summary -->sends *msg* as an information message to the web form<!-- END REF -->.
+
+For more information, please refer to the [`.setMessage()` description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormClass#setmessage). 
+
+
+### .setWarning()
+
+<!-- REF #WebFormClass.setWarning().Syntax -->
+**.setWarning**( *msg* : string)<!-- END REF -->
+
+<!-- REF #WebFormClass.setWarning().Params -->
+|Parameter|Type||Description|
+|---------|--- |:---:|------|
+|msg|string|->|Warning message to display in the web form|
+<!-- END REF -->
+
+#### Description
+
+The `.setWarning()` function  <!-- REF #WebFormClass.setWarning().Summary -->sends *msg* as a warning message to the web form<!-- END REF -->.
+
+For more information, please refer to the [`.setWarning()` description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormClass#setwarning). 
+
+
+## Web Form
+
+<!-- REF #_command_.Web Form.Syntax -->**Web Form** : 4D.WebForm<!-- END REF -->
+
+<!-- REF #_command_.Web Form.Params -->
+|Parameter|Type||Description|
+|---------|--- |:---:|------|
+|Result|4D.WebForm|<-|New `WebForm` proxy object
+<!-- END REF -->
+
+#### Description
+
+The `Web Form` command <!-- REF #_command_.webForm.Summary --> returns a `4D.WebForm` proxy object that allows you to interact with the web form<!-- END REF -->. 
+
+For more information, please refer to the [`webForm` command description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormClass#webform). 
+
+
+## Web Event
+
+<!-- REF #_command_.Web Event.Syntax -->**Web Event** : object<!-- END REF -->
+
+<!-- REF #_command_.Web Event.Params -->
+|Parameter|Type||Description|
+|---------|--- |:---:|------|
+|Result|object|<-| object
+<!-- END REF -->
+
+#### Description
+
+The `Web Event` command <!-- REF #_command_.Web Event.Summary -->returns an object with information on a triggered event linked to a webform component<!-- END REF -->.
+
+For more information, please refer to the [`webEvent` command description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormClass#webevent). 

docs/API/WebFormItemClass.md

@@ -0,0 +1,107 @@
+---
+id: WebFormItemClass
+title: WebFormItem
+---
+
+<details><summary>History</summary>
+
+|Version|Changes|
+|---|---|
+|v20 R2|Added|
+
+</details>
+
+
+`4D.WebFormItem` objects are properties of the [`4D.WebForm`](WebFormItemClass.md) object returned by the [`Web Form`](WebFormClass.md#web-form) command. 
+
+The `WebFormItem` class is detailed in the [Qodly documentation](https://developer.qodly.com/docs/language/WebFormItemClass).
+
+
+### WebFormItem object
+
+||
+|---|
+|[<!-- INCLUDE #WebFormItemClass.addCSSClass().Syntax -->](#addclass)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #WebFormItemClass.addCSSClass().Summary -->|
+|[<!-- INCLUDE #WebFormItemClass.hide().Syntax -->](#hide)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #WebFormItemClass.hide().Summary -->|
+|[<!-- INCLUDE #WebFormItemClass.removeCSSClass().Syntax -->](#removeclass)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #WebFormItemClass.removeCSSClass().Summary -->|
+|[<!-- INCLUDE #WebFormItemClass.show().Syntax -->](#show)&nbsp;&nbsp;&nbsp;&nbsp;<!-- INCLUDE #WebFormItemClass.show().Summary -->|
+
+
+### .hide()
+
+<!-- REF #WebFormItemClass.hide().Syntax -->
+**.hide**()<!-- END REF -->
+
+<!-- REF #WebFormItemClass.hide().Params -->
+|Parameter|Type||Description|
+|---------|--- |:---:|------|
+||||Does not require any parameters|
+<!-- END REF -->
+
+
+#### Description
+
+The `.hide()` function <!-- REF #WebFormItemClass.hide().Summary -->hides the component<!-- END REF -->.
+
+
+For more information, please refer to the [`.hide()` description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormItemClass#hide). 
+
+
+### .show()
+
+<!-- REF #WebFormItemClass.show().Syntax -->
+**.show**()<!-- END REF -->
+
+
+<!-- REF #WebFormItemClass.show().Params -->
+|Parameter|Type||Description|
+|---------|--- |:---:|------|
+||||Does not require any parameters|
+<!-- END REF -->
+
+
+#### Description
+
+The `.show()` function <!-- REF #WebFormItemClass.show().Summary -->makes the component visible<!-- END REF -->.
+
+For more information, please refer to the [`.show()` description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormItemClass#show). 
+
+
+### .addCSSClass()
+
+<!-- REF #WebFormItemClass.addCSSClass().Syntax -->
+**.addCSSClass**(*className* : string)<!-- END REF -->
+
+<!-- REF #WebFormItemClass.addCSSClass().Params -->
+|Parameter|Type||Description|
+|---------|--- |:---:|------|
+|className|string|->|Name of the CSS class to add to the component|
+<!-- END REF -->
+
+#### Description
+
+The `.addCSSClass` function <!-- REF #WebFormItemClass.addCSSClass().Summary -->adds the class specified in *className* to the component<!-- END REF -->.
+
+For more information, please refer to the [`.addCSSClass` description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormItemClass#addcssclass). 
+
+
+### .removeCSSClass()
+
+
+<!-- REF #WebFormItemClass.removeCSSClass().Syntax -->
+**.removeCSSClass**(*className*: string)<!-- END REF -->
+
+<!-- REF #WebFormItemClass.removeCSSClass().Params -->
+|Parameter|Type||Description|
+|---------|--- |:---:|------|
+|className|string|->|Name of the CSS class to remove from the component|
+<!-- END REF -->
+
+#### Description
+
+The `.removeCSSClass()` function <!-- REF #WebFormItemClass.removeCSSClass().Summary -->removes the class specified in *className* from the component<!-- END REF -->.
+
+For more information, please refer to the [`.removeCSSClass()` description in the Qodly documentation](https://developer.qodly.com/docs/language/WebFormItemClass#removecssclass). 
+
+
+

docs/Backup/log.md

@@ -67,6 +67,13 @@ Without having to do anything else, all operations performed on the data are log
 
 You must create another log file if you create a new data file. You must set or create another log file if you open another data file that is not linked to a log file (or if the log file is missing).
 
+## Log file settings 
+
+The [log file settings](settings.md#log-file-management) are based on two pieces of information: a boolean value and a path.
+
+1. **Boolean Value**: indicating whether the "Use Log File" feature is enabled or disabled within the application. By default, the boolean value is stored in *catalog.4DCatalog*. However, when the [user settings](../Desktop/user-settings.md) are activated, the *catalog.4DCatalog* file configuration is overriden, and the boolean value can then be set either in the *Backup.4DSettings* file [next to the data file](../Project/architecture.md#settings-user-data) or the *Backup.4DSettings* file [in the project folder](../Project/architecture.md#settings-user) (see also the `JournalFileEnabled` xml backup key documentation on [doc.4d.com](https://doc.4d.com)).
+
+2. **Path**: a string pointing to where the log file is located. The log file path is always stored in the linked data file.
 
 
 ## Stopping a log file

docs/Backup/settings.md

@@ -41,7 +41,7 @@ The options found on this tab let you set and configure scheduled automatic back
 
 The Backup/Configuration page of the Structure Settings lets you set the backup files and their location, as well as that of the log file. These parameters are specific to each application opened by 4D or 4D Server.
 
-![](../assets/en/Backup/backup03.png)
+![](../assets/en/Backup/backup032.png)
 
 > **4D Server:** These parameters can only be set from the 4D Server machine.
 
@@ -67,13 +67,13 @@ To view the location of the files, click in the area in order to display their p
 
 To modify the location where these files are stored, click the **...** button. A selection dialog box appears, which allows you to select a folder or disk where the backups will be placed. The "Used Space" and "Free Space" areas are updated automatically and indicate the remaining space on the disk of the selected folder.
 
-### Log management  
+### Log management
 
-The **Use Log** option, when checked, indicates that the application uses a log file. Its pathname is specified below the option. When this option is checked, it is not possible to open the application without a log file. 
+The **Use Log File** option, when checked, indicates that the application uses a log file. The pathname of the log file for the current data file is specified below the option. When this option is checked, it is not possible to open the application without a log file. For more information about the log file, please refer to [log file](../log.md)
 
 By default, any project created with 4D uses a log file (option **Use Log File** checked in the **General Page** of the **Preferences**). The log file is named *data.journal* and is placed in the Data folder.
 
-> Activating a new log file requires the data of the application to be backed up beforehand. When you check this option, a warning message informs you that a backup is necessary. The creation of the log file is postponed and it will actually be created only after the next backup of the application.
+> Activating a new log file requires the data of the application to be backed up beforehand. When you check this option for the currently used data file, a warning message informs you that a backup is necessary. The creation of the log file is postponed and it will actually be created only after the next backup of the application.
 
 
 ## Backup & Restore

docs/Concepts/dt_blob.md

@@ -34,8 +34,8 @@ You cannot use operators on blobs.
 
 ## Checking if a variable holds a scalar blob or a `4D.Blob`
 
-Use the [Value type](https://doc.4d.com/4dv19R/help/command/en/page1509.html) command to determine if a value is of type Blob or Object.
-To check that an object is a blob object (`4D.Blob`), use [OB instance of](https://doc.4d.com/4dv19R/help/command/en/page1731.html):
+Use the [Value type](https://doc.4d.com/4dv20/help/command/en/page1509.html) command to determine if a value is of type Blob or Object.
+To check that an object is a blob object (`4D.Blob`), use [OB instance of](https://doc.4d.com/4dv20/help/command/en/page1731.html):
 
 ```4d
 var $myBlob: Blob