Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lme-axelor committed Dec 17, 2024
1 parent 522e4eb commit 3d14f48
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 12 deletions.
12 changes: 8 additions & 4 deletions docs/doc/en/Outil/Gestion_des_headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,26 +42,30 @@ export interface HeaderActions {
export interface HeaderOptions {
model?: string;
modelId?: number;
options?: any;
disablePrint?: boolean;
disableMailMessages?: boolean;
disableJsonFields?: boolean;
attachedFileScreenTitle?: string;
barcodeFieldname?: string;
headerTitle?: string;
actions?: ActionType[];
}
```

By default, the core package provides two actions for the header: follow-up messages on each object and attached files. These can be configured via the following props:
By default, the core package provides a few actions for the header: follow-up messages on each object, barcode display, custom fields or even report printing. These can be configured via the following props:

- _model_: full name of the ERP model.
- _modelId_: object identifier.
- _options_: object containing options for the generic actions.
- _disablePrint_: condition for displaying or not report printing on the object.
- _disableMailMessages_: condition for displaying or not displaying follow-up messages on the object.
- _disableJsonFields_: condition for displaying studio fields.
- _attachedFileScreenTitle_: screen name for attached files.
- _barcodeFieldname_: name of attribute containing barcode file on ERP (default `barCode`).
- _headerTitle_: screen name for dynamic titles.

Attached files are displayed only if the current object has them, with an indicator of their number. Follow-up messages are only displayed when `model` and `modelId` are set and not disabled by the `disableMailMessages` attribute.
:::caution
Since version 8.3, the attached files feature is managed as a generic action from the DMS package. It will be added to every screen with a registered model and modelId.
:::

Additional actions can then be added using the `actions` attribute. Each action then has the following structure:

Expand Down
12 changes: 8 additions & 4 deletions docs/doc/fr/Outil/Gestion_des_headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,26 +42,30 @@ export interface HeaderActions {
export interface HeaderOptions {
model?: string;
modelId?: number;
options?: any;
disablePrint?: boolean;
disableMailMessages?: boolean;
disableJsonFields?: boolean;
attachedFileScreenTitle?: string;
barcodeFieldname?: string;
headerTitle?: string;
actions?: ActionType[];
}
```

Le package core fournit par défaut deux actions pour le header qui sont les messages de suivi sur chaque objet ainsi que les fichiers joints. Elles sont paramétrables via les props suivantes :
Le package core fournit par défaut plusieurs actions pour le header: les messages de suivi sur chaque objet, l'affichage du code-barre, les champs studio or encore l'impression de rapport. Elles sont paramétrables via les props suivantes :

- _model_ : nom complet du modèle sur l’ERP.
- _modelId_ : identifiant de l’objet.
- _options_: objet contenant des options pour les actions génériques.
- _disablePrint_: ccondition pour l'affichage ou non de l'impression de rapport.
- _disableMailMessages_ : condition pour l'affichage ou non des messages de suivi sur l'objet.
- _disableJsonFields_ : condition pour l’affichage ou non des champs studio.
- _attachedFileScreenTitle_ : nom de l'écran pour les fichiers joints.
- _barcodeFieldname_ : nom de l’attribut contenant le fichier code-barre sur l’ERP (par défaut `barCode`).
- _headerTitle_ : nom de l'écran pour permettre les titres dynamiques.

Les fichiers joints s’affichent uniquement si l’objet actuel en possède avec un indicateur sur leur nombre. Les messages de suivi eux n’affichent lorsque `model` et `modelId` sont renseignés et qu’il ne sont pas désactivés par l’attribut `disableMailMessages`.
:::caution
Depuis la version 8.3, la fonctionnalité des fichiers joints est gérée comme une action générique du module DMS. Elle sera ajoutée à tous les écrans avec un model et un modelId enregistrés.
:::

Il est ensuite possible d’ajouter des actions supplémentaires avec l’attribut `actions`. Chaque action possède alors la structure suivante :

Expand Down
2 changes: 0 additions & 2 deletions packages/core/src/i18n/translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,8 @@
"Base_Print": "Print",
"Base_PrintTemplate": "Print template",
"Base_NoRecordsFound": "No records found",
"Base_SliceAction_FetchAttachedFiles": "fetch attached files",
"Base_SliceAction_FetchFilesDetails": "fetch file details",
"Base_SliceAction_FetchMetaModule": "fetch meta modules",
"Base_SliceAction_CountAttachedFiles": "count attachment files",
"Base_SliceAction_FetchMailMessages": "fetch mail messages",
"Base_SliceAction_PostMailMessageComment": "post mail message comment",
"Base_SliceAction_FetchModelSubscribers": "fetch model subscribers",
Expand Down
2 changes: 0 additions & 2 deletions packages/core/src/i18n/translations/fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,8 @@
"Base_Print": "Imprimer",
"Base_PrintTemplate": "Modèle d'impression",
"Base_NoRecordsFound": "Aucun enregistrement trouvé",
"Base_SliceAction_FetchAttachedFiles": "récupération des fichiers joints",
"Base_SliceAction_FetchFilesDetails": "récupération des détails du fichier",
"Base_SliceAction_FetchMetaModule": "récupération des modules",
"Base_SliceAction_CountAttachedFiles": "comptage des fichiers joints",
"Base_SliceAction_FetchMailMessages": "récupération des mail messages",
"Base_SliceAction_PostMailMessageComment": "ajout d'un mail message",
"Base_SliceAction_FetchModelSubscribers": "récupération des abonnés du modèle",
Expand Down

0 comments on commit 3d14f48

Please sign in to comment.