Merge pull request #430 from doc4d/main

fixes and translations

Author: arnaud4d

README.md

@@ -77,3 +77,14 @@ Exemple:
 -> regénérer page des thèmes en anglais
 
 
+## Classic Commands Update
+
+- new command:
+  1. create a page in commands folder
+  2. add reference in:
+    - commands/theme/ page
+    - sidebars.js
+    - commands/command-index.md (includes version added number) 
+- modified command (moved to commands):
+  1. move to commands (use move_command.exe)
+  2. same as above

crowdin.yml

@@ -4,6 +4,7 @@ files:
       - /docs/preprocessing.conf
       - /docs/commands-legacy/*.*
       - /docs/WritePro/commands-legacy/*.*
+      - /docs/*-legacy/*.*
     translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%
   - source: /i18n/en/docusaurus-plugin-content-docs/*.json
     ignore:
@@ -15,6 +16,7 @@ files:
       - /versioned_docs/**/commands-legacy/*.*
       - /versioned_docs/**/WritePro/commands-legacy/*.*
       - /versioned_docs/version-18/
+      - /versioned_docs/**/*-legacy/*.*
     translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%
   - source: /i18n/en/docusaurus-theme-classic/*.json
     translation: /i18n/%two_letters_code%/docusaurus-theme-classic/%original_file_name%

docs/API/DataStoreClass.md

@@ -467,7 +467,7 @@ The `.getInfo()` function <!-- REF #DataStoreClass.getInfo().Summary -->returns
 On a remote datastore:
 
 ```4d
-  var $remoteDS : cs.DataStore
+  var $remoteDS : 4D.DataStoreImplementation
   var $info; $connectTo : Object
 
  $connectTo:=New object("hostname";"111.222.33.44:8044";"user";"marie";"password";"aaaa")
@@ -1128,7 +1128,7 @@ You can nest several transactions (sub-transactions). Each transaction or sub-tr
 ```4d
  var $connect; $status : Object
  var $person : cs.PersonsEntity
- var $ds : cs.DataStore
+ var $ds : 4D.DataStoreImplementation
  var $choice : Text
  var $error : Boolean
 

docs/API/EntityClass.md

@@ -600,15 +600,14 @@ The following generic code duplicates any entity:
 
 </details>
 
-<!-- REF #EntityClass.getKey().Syntax -->**.getKey**( { *mode* : Integer } ) : Text<br/>**.getKey**( { *mode* : Integer } ) : Integer<!-- END REF -->
+<!-- REF #EntityClass.getKey().Syntax -->**.getKey**( { *mode* : Integer } ) : any<!-- END REF -->
 
 
 <!-- REF #EntityClass.getKey().Params -->
 |Parameter|Type||Description|
 |---------|--- |:---:|------|
 |mode|Integer|->|`dk key as string`: primary key is returned as a string, no matter the primary key type|
-|Result|Text|<-|Value of the text primary key of the entity|
-|Result|Integer|<-|Value of the numeric primary key of the entity|
+|Result|any|<-|Value of the primary key of the entity (Integer or Text)|
 
 <!-- END REF -->
 
@@ -1603,11 +1602,11 @@ Returns:
 
 #### Description
 
-The `.touched()` function <!-- REF #EntityClass.touched().Summary -->tests whether or not an entity attribute has been modified since the entity was loaded into memory or saved<!-- END REF -->.
+The `.touched()` function <!-- REF #EntityClass.touched().Summary -->returns True if at least one entity attribute has been modified since the entity was loaded into memory or saved<!-- END REF -->. You can use this function to determine if you need to save the entity. 
 
-If an attribute has been modified or calculated, the function returns True, else it returns False. You can use this function to determine if you need to save the entity.
+This only applies to attributes of [`kind`](DataClassClass.md#returned-object) "storage" or "relatedEntity".
 
-This function returns False for a new entity that has just been created (with [`.new( )`](DataClassClass.md#new)). Note however that if you use a function which calculates an attribute of the entity, the `.touched()` function will then return True. For example, if you call [`.getKey()`](#getkey) to calculate the primary key, `.touched()` returns True.
+For a new entity that has just been created (with [`.new()`](DataClassClass.md#new)), the function returns False. However in this context, if you access an attribute whose [`autoFilled` property](./DataClassClass.md#returned-object) is True, the `.touched()` function will then return True. For example, after you execute `$id:=ds.Employee.ID` for a new entity (assuming the ID attribute has the "Autoincrement" property), `.touched()` returns True.
 
 #### Example  
 
@@ -1649,7 +1648,7 @@ In this example, we check to see if it is necessary to save the entity:
 
 The `.touchedAttributes()` function <!-- REF #EntityClass.touchedAttributes().Summary -->returns the names of the attributes that have been modified since the entity was loaded into memory<!-- END REF -->.
 
-This applies for attributes of the [kind](DataClassClass.md#attributename) `storage` or `relatedEntity`.
+This only applies to attributes of [`kind`](DataClassClass.md#returned-object) "storage" or "relatedEntity".
 
 In the case of a related entity having been touched (i.e., the foreign key), the name of the related entity and its primary key's name are returned.
 

docs/API/FileClass.md

@@ -572,7 +572,7 @@ You want to rename "ReadMe.txt" in "ReadMe_new.txt":
 
 The `.setAppInfo()` function <!-- REF #FileClass.setAppInfo().Summary -->writes the *info* properties as information contents of an application file<!-- END REF -->.
 
-The function must be used with an existing, supported file: **.plist** (all platforms), **.exe**/**.dll** (Windows), or **macOS executable**. If the file does not exist on disk or is not a supported file, the function does nothing (no error is generated).
+The function can only be used with the following file types: **.plist** (all platforms), existing **.exe**/**.dll** (Windows), or **macOS executable**. If used with another file type or with a **.exe**/**.dll** file that does not already exist on disk, the function does nothing (no error is generated). 
 
 ***info* parameter object with a .plist file (all platforms)**
 
@@ -582,6 +582,8 @@ The function only supports .plist files in xml format (text-based). An error is
 
 :::
 
+If the .plist file already exists on the disk, it is updated. Otherwise, it is created.
+
 Each valid property set in the *info* object parameter is written in the .plist file as a key. Any key name is accepted. Value types are preserved when possible.
 
 If a key set in the *info* parameter is already defined in the .plist file, its value is updated while keeping its original type. Other existing keys in the .plist file are left untouched.  

docs/API/WebServerClass.md

@@ -607,7 +607,7 @@ The `.start()` function <!-- REF #WebServerClass.start().Summary -->starts the w
 
 The web server starts with default settings defined in the settings file of the project or (host database only) using the `WEB SET OPTION` command. However, using the *settings* parameter, you can define customized properties for the web server session.
 
-All settings of [Web Server objects](../commands/web-server.md-object) can be customized, except read-only properties ([.isRunning](#isrunning), [.name](#name), [.openSSLVersion](#opensslversion), [.perfectForwardSecrecy](#perfectforwardsecrecy), and [.sessionCookieName(#sessioncookiename)]).
+All settings of [Web Server objects](../commands/web-server.md-object) can be customized, except read-only properties ([.isRunning](#isrunning), [.name](#name), [.openSSLVersion](#opensslversion), [.perfectForwardSecrecy](#perfectforwardsecrecy), and [.sessionCookieName](#sessioncookiename)).
 
 Customized session settings will be reset when the [`.stop()`](#stop) function is called.
 

docs/Concepts/error-handling.md

@@ -100,7 +100,7 @@ Within a custom error method, you have access to several pieces of information t
 4D automatically maintains a number of variables called [**system variables**](variables.md#system-variables), meeting different needs. 
 :::
 
-- the [`Last errors`](../commands-legacy/last-errors.md) command that returns a collection of the current stack of errors that occurred in the 4D application. 
+- the [`Last errors`](../commands/last-errors.md) command that returns a collection of the current stack of errors that occurred in the 4D application. 
 - the `Call chain` command that returns a collection of objects describing each step of the method call chain within the current process. 
 
 
@@ -158,7 +158,7 @@ Try (expression) : any | Undefined
 
 If an error occurred during its execution, it is intercepted and no error dialog is displayed, whether an [error-handling method](#installing-an-error-handling-method) was installed or not before the call to `Try()`. If *expression* returns a value, `Try()` returns the last evaluated value, otherwise it returns `Undefined`. 
 
-You can handle the error(s) using the [`Last errors`](../commands-legacy/last-errors.md) command. If *expression* throws an error within a stack of `Try()` calls, the execution flow stops and returns to the latest executed `Try()` (the first found back in the call stack). 
+You can handle the error(s) using the [`Last errors`](../commands/last-errors.md) command. If *expression* throws an error within a stack of `Try()` calls, the execution flow stops and returns to the latest executed `Try()` (the first found back in the call stack). 
 
 :::note
 
@@ -255,7 +255,7 @@ For more information on *deferred* and *non-deferred* errors, please refer to th
 :::
 
 
-In the `Catch` code block, you can handle the error(s) using standard error handling commands. The [`Last errors`](../commands-legacy/last-errors.md) function contains the last errors collection. You can [declare an error-handling method](#installing-an-error-handling-method) in this code block, in which case it is called in case of error (otherwise the 4D error dialog box is displayed).
+In the `Catch` code block, you can handle the error(s) using standard error handling commands. The [`Last errors`](../commands/last-errors.md) function contains the last errors collection. You can [declare an error-handling method](#installing-an-error-handling-method) in this code block, in which case it is called in case of error (otherwise the 4D error dialog box is displayed).
 
 :::note
 
@@ -299,58 +299,12 @@ Function createInvoice($customer : cs.customerEntity; $items : Collection; $invo
 
 ## Error codes
 
-Exceptions that interrupt code execution are returned by 4D but can have different origins such as the OS, a device, the 4D kernel, a [`throw`](../commands-legacy/throw.md) in your code, etc. A returned error is therefore defined by three elements:
+Exceptions that interrupt code execution are returned by 4D but can have different origins such as the OS, a device, the 4D kernel, a [`throw`](../commands-legacy/throw.md) in your code, etc. An error is therefore defined by three elements:
 
-- a **component signature**, which is the origin of the error
-- a **message**, wich explains why the error occurred 
+- a **component signature**, which is the origin of the error (see [`Last errors`](../commands/last-errors.md) to have a list of signatures)
+- a **message**, which explains why the error occurred 
 - a **code**, which is an arbitrary number returned by the component
 
-These information are returned for every error (when available) by the [4D error dialog box](../Debugging/basics.md) and the [`Last errors`](../commands-legacy/last-errors.md) command. Keep in mind that, if you intercept and handle errors using a [error-handling method](#installing-an-error-handling-method), you need to process all information since a simple error code could not be correctly interpreted. 
-
-#### 4D component signatures
-
-|Component Signature|Component|
-|--|---|
-|4DCM|4D Compiler runtime|
-|4DRT|4D runtime|
-|bkrs|4D backup & restore manager|
-|brdg|SQL 4D bridge|
-|cecm|4D code Editor|
-|CZip|zip 4D apis|
-|dbmg|4D database manager|
-|FCGI|fast cgi 4D bridge|
-|FiFo|4D file objects|
-|HTCL|http client 4D apis|
-|HTTP|4D http server|
-|IMAP|IMAP 4D apis|
-|JFEM|Form Macro apis|
-|LD4D|LDAP 4D apis|
-|lscm|4D language syntax manager|
-|MIME|MIME 4D apis|
-|mobi|4D Mobile|
-|pdf1|4D pdf apis|
-|PHP_|php 4D bridge|
-|POP3|POP3 4D apis|
-|SMTP|SMTP 4D apis|
-|SQLS|4D SQL server|
-|srvr|4D network layer apis|
-|svg1|SVG 4D apis|
-|ugmg|4D users and groups manager|
-|UP4D|4D updater|
-|VSS |4D VSS support (Windows Volume Snapshot Service) |
-|webc|4D Web view|
-|xmlc|XML 4D apis|
-|wri1|4D Write Pro|
-
-
-#### System component signatures
-
-|Component Signature|Component|
-|--|---|
-|CARB|Carbon subsystem|
-|COCO|Cocoa subsystem|
-|MACH|macOS Mach subsystem|
-|POSX|posix/bsd subsystem (mac, linux, win)|
-|PW32|Pre-Win32 subsystem|
-|WI32|Win32 subsystem|
+The [4D error dialog box](../Debugging/basics.md) displays the code and the message to the user. 
 
+To have a full description of an error and especially its origin, you need to call the [`Last errors`](../commands/last-errors.md) command. When you intercept and handle errors using an [error-handling method](#installing-an-error-handling-method) in your final applications, use [`Last errors`](../commands/last-errors.md) and make sure you log all properties of the *error* object since error codes depend on the components.