Merge pull request #453 from 4d/doc4d-main

update 20R10 beta

Author: arnaud4d

README.md

@@ -91,3 +91,96 @@ Exemple:
 - modified command (moved to commands):
   1. move to commands (use move_command.exe)
   2. same as above
+
+
+## Versioning
+
+### Préparation AVANT creation de version
+- mettre à jour les liens:
+  - sur la page Home
+  - sur la sidebar
+  - dans la page Notes (what's new pages+bugs)
+
+- attention, uniquement deux R sont visibles (enlever anciens liens)
+
+### Netkit
+
+- dans la sidebar: readme github qui correspond à la version : à modifier
+- dans la page home : https://developer.4d.com/4D-NetKit/ qui pointe la branche MAIN de 4D-Netkit (nothing to do)
+- dans le readme final : mettre à jour la version qui correspond à MAIN
+(dans la fork de la doc, on garde les features qui ne sont pas dans la beta courante)
+
+### Créer la version vXX-Rx beta
+
+0. Vérifier la version de Nodejs et aussi de docusaurus
+1. Se placer dans main prête pour être versionnée (liens OK, **pas de pull request en attente**)
+2. lancer le script
+
+`npm run docusaurus docs:version XX-Rx (ex: 19-R4)`
+
+### Mettre à jour docusaurus.config.js
+
+Dans les presets:
+
+1. Ajouter la version + BETA,
+2. Retirer le BETA de la version précédente
+
+ex :
+
+```
+versions: {
+'19-R5':{
+label: 'v19 R5 BETA',
+banner: 'none',
+},
+'19-R4':{
+label: 'v19 R4',
+banner: 'none',
+},
+```
+
+### Mettre à jour les i18n
+
+1. Se placer dans **main** et lancer le script qui extrait les chaines à traduire:
+`npm run docusaurus write-translations`
+
+2. Aller dans le dossier i18n\en\docusaurus-plugin-content-docs/en/version-XX-RX.json (version RX-1) et mettre à jour la chaîne de la version précédente qui contient BETA (apparaît dans le menu)
+
+3. Aller dans i18n\en\code.json, à la fin du fichier : liens de la page Home (vers extensions) à mettre à jour
+
+### Si problème de traduction avec cmfcmf:
+1. Faire
+`git restore --rebase --autostash` 
+pour se synchroniser avec le repo
+2. Dans docusaurus.config.js, désactiver `require.resolve('@cmfcmf/docusaurus-search-local')`,
++ supprimer @cmfcmf dans les plug ins de node
+
+3. Lancer write-translations
+4. remettre docusaurus.config.js
+5. faire `npm i`
+
+### Supprimer la version précédente (si nécessaire)
+1. Enlever la version dans le version.json
+2. A la main : supprimer la version dans versioned_docs et versioned_sidebars
+3. A la main, supprimer la version dans les sous-dossiers i18n (langues)
+
+### Commit dans main
+1. Sur github desktop, faire un commit des modifs dans main
+2. Faire un push
+
+### Lancer une synchro sur Crowdin
+Forcer une synchro globale de main sur Crowdin
+
+Tester : Faire npm run build
+
+### Builder
+Sur github, faire une PR de docs4d/docs/main sur 4d/docs/main
+
+### Algolia (4D only)
+Aller dans l'interface Algolia et lancer un reindex de la doc
+
+
+
+
+
+

add_headers.py

@@ -224,7 +224,7 @@ $person:=cs.Person.new("John";"Doe";40)
 
 The `.superclass` property <!-- REF #ClassClass.superclass.Summary -->returns the parent class of the class<!-- END REF -->. A superclass can be a `4D.Class` object, or a `cs.className` object. If the class does not have a parent class, the property returns **null**.
 
-A superclass of a user class is declared in a class by using the [`Class extends <superclass>`](Concepts/classes.md#class-extends-classname) keyword.
+To define a superclass for a user class, use the  [`extends`](Concepts/classes.md#class-extends-classname) keyword like: `Class extends <superclass>`.
 
 This property is **read-only**.
 

docs/API/ClassClass.md

@@ -68,6 +68,7 @@ Returned attribute objects contain the following properties:
 |relatedDataClass|Text|Name of the dataclass related to the attribute. Returned only when `.kind` = "relatedEntity" or "relatedEntities".|
 |type|Text|Conceptual value type of the attribute, useful for generic programming. Depends on the attribute `kind`. Possible values: <li>if `.kind` = "storage": "blob", "bool", "date", "image", "number", "object", or "string". "number" is returned for any numeric types including duration; "string" is returned for uuid, alpha and text attribute types; "blob" attributes are [blob objects](../Concepts/dt_blob.md#blob-types).</li><li>if `.kind` = "relatedEntity": related dataClass name</li><li>if `.kind` = "relatedEntities": related dataClass name + "Selection" suffix</li><li>if `.kind` = "calculated" or "alias": same as above, depending on the result</li>|
 |unique|Boolean|True if the attribute value must be unique. Not returned if `.kind` = "relatedEntity" or "relatedEntities".|
+|classID| Text | Available only if `.type = "object"` and a class has been specified in the structure editor. </br>Returns the name of the class used to instantiate the object. |
 
 :::tip
 

docs/API/DataClassClass.md

@@ -103,7 +103,7 @@ This function allows you to update entities separately. Note however that, for p
 
 This function can only be used with entities already saved in the database. It cannot be called on a newly created entity (for which [`.isNew()`](#isnew) returns **True**).
 
-#### Example
+#### Example 1
 
 ```4d
  var $emp; $empCloned : cs.EmployeeEntity
@@ -114,6 +114,17 @@ This function can only be used with entities already saved in the database. It c
 
 ```
 
+#### Example 2
+
+If you don't want the new entity to share object-type attribute references, you must copy them.
+
+```4d
+ var $emp; $empCloned : cs.EmployeeEntity
+ $emp:=ds.Employee.all().first()
+ $empCloned:=$emp.clone()
+ $empCloned.objectAtt:=OB Copy($emp.objectAtt)
+```
+
 <!-- END REF -->
 
 <!-- REF EntityClass.diff().Desc -->

docs/API/EntityClass.md

@@ -13,6 +13,12 @@ Thanks to the standard 4D object *refcounting*, a TCPConnection is automatically
 
 TCPConnection objects are released when no more references to them exist in memory. This typically occurs, for example, at the end of a method execution for local variables. If you want to "force" the closure of a connection at any moment, [**nullify** its references by setting them to **Null**](../Concepts/dt_object.md#resources).
 
+:::info 4DTCPUDPLog.txt file
+
+For debugging and monitoring, you can use the [4DTCPUDPLog.txt log file] that records events related to TCP connections. Events include data transmission, errors, and connection lifecycle information. 
+
+:::
+
 <details><summary>History</summary>
 
 |Release|Changes|

docs/API/TCPConnectionClass.md

@@ -0,0 +1,86 @@
+---
+id: UDPEventClass
+title: UDPEvent
+---
+
+The `UDPEvent` class provides information about events occurring during the lifecycle of a UDP socket. It is generated when a [UDPSocket](UDPSocketClass.md) is opened and is utilized in callbacks `onData`, `onError`, and `onTerminate`.
+
+
+<details><summary>History</summary>
+
+|Release|Changes|
+|---|---|
+|20 R10|Class added|
+
+</details>
+
+### UDPEvent Object
+
+A `UDPEvent` object is immutable and non-streamable.
+
+The following properties are available:
+
+||
+|---|
+|[<!-- INCLUDE #UDPEvent.data.Syntax -->](#data)<br/><!-- INCLUDE #UDPEvent.data.Summary -->|
+|[<!-- INCLUDE #UDPEvent.ip.Syntax -->](#ip)<br/><!-- INCLUDE #UDPEvent.ip.Summary -->|
+|[<!-- INCLUDE #UDPEvent.port.Syntax -->](#port)<br/><!-- INCLUDE #UDPEvent.port.Summary -->|
+|[<!-- INCLUDE #UDPEvent.type.Syntax -->](#type)<br/><!-- INCLUDE #UDPEvent.type.Summary -->|
+
+<!-- REF #UDPEvent.data.Desc -->
+## .data
+
+
+<!-- REF #UDPEvent.data.Syntax -->**data** : Blob<!-- END REF -->
+
+#### Description
+
+The `.data` property contains <!-- REF #UDPEvent.data.Summary -->the data associated with the event<!-- END REF -->. It is only valid for events of type "data".
+
+<!-- END REF -->
+
+<!-- REF #UDPEvent.ip.Desc -->
+## .ip
+
+<!-- REF #UDPEvent.ip.Syntax -->**ip** : Text<!-- END REF -->
+
+#### Description
+
+The `.ip` property contains <!-- REF #UDPEvent.ip.Summary -->the IP address of the remote machine<!-- END REF -->.
+
+
+<!-- END REF -->
+
+
+<!-- REF #UDPEvent.port.Desc -->
+## .port
+
+<!-- REF #UDPEvent.port.Syntax -->**port** : Number<!-- END REF -->
+
+#### Description
+
+The `.port` property contains <!-- REF #UDPEvent.port.Summary -->the port number of the remote machine<!-- END REF -->.
+
+
+<!-- END REF -->
+
+
+<!-- REF #UDPEvent.type.Desc -->
+## .type
+
+<!-- REF #UDPEvent.type.Syntax -->**type** : Text<!-- END REF -->
+
+#### Description
+
+The `.type` property contains <!-- REF #UDPEvent.type.Summary -->the type of the event<!-- END REF -->. Possible values are:
+- `"data"`: Indicates that data has been received.
+- `"error"`: Indicates that an error occurred during the UDPSocket.
+- `"terminate"`: Indicates that the UDPSocket is about to be released.
+
+<!-- END REF -->
+
+
+
+#### See also
+
+[UDPSocket](UDPSocketClass.md)