Skip to content
Snippets Groups Projects
Commit 82a83a9e authored by David Dorchies's avatar David Dorchies
Browse files

docs: change from gitlab.irstea.fr to forgemia.inra.fr

parent cc7e8fc5
No related branches found
No related tags found
No related merge requests found
Pipeline #143253 failed
This diff is collapsed.
# Documentation ngHyd pour les développeurs
Voir aussi :
Voir aussi :
* [ngHyd installation instructions](README.md)
* [JaLHyd developers documentation](https://gitlab.irstea.fr/cassiopee/jalhyd/blob/master/DEVELOPERS.md)
* [JaLHyd developers documentation](https://forgemia.inra.fr/cassiopee/jalhyd/blob/master/DEVELOPERS.md)
## Description
ngHyd est une interface Web pour [JaLHyd](https://gitlab.irstea.fr/cassiopee/jalhyd) écrite en Angular/typescript.
ngHyd est une interface Web pour [JaLHyd](https://forgemia.inra.fr/cassiopee/jalhyd) écrite en Angular/typescript.
Elle est déclinée à l'aide d'Electron et de l'ensemble de technologies PWA (Progressive Web Application dont les service workers) sous forme d'application hors-ligne pour Linux, Mac, Windows et Android.
......@@ -41,7 +41,7 @@ La documentation est générée avec Mkdocs, pandoc et LaTeX.
* version Web : une connexion Internet et un navigateur à jour (Firefox, Chrome/Chromium, Safari, Edge…)
* version hors-ligne : Linux, MacOS, Windows 7 ou plus récent, Android 7 ou plus récent
## Grands principes
### interface
......@@ -141,7 +141,7 @@ Dans cet exemple nous considérerons le module fictif "Addition" proposé dans l
### JaLHyd
Voir la [documentation JaLHyd pour les développeurs](https://gitlab.irstea.fr/cassiopee/jalhyd/blob/master/DEVELOPERS.md) (en anglais)
Voir la [documentation JaLHyd pour les développeurs](https://forgemia.inra.fr/cassiopee/jalhyd/blob/master/DEVELOPERS.md) (en anglais)
### configuration du module
......@@ -150,7 +150,7 @@ Créer les fichiers de configuration du module de calcul :
Dans `src/app/calculators`, créer un dossier nommé comme la clé du type de calculateur (`CalculatorType`), en minuscules. Par exemple pour `CalculatorType.Addition`, on aura : `src/app/calculators/addition`.
Dans ce nouveau dossier, créer le fichier `config.json`, comme suit :
```json
[
{
......@@ -168,7 +168,7 @@ Dans ce nouveau dossier, créer le fichier `config.json`, comme suit :
}
]
```
Dans cet exemple, on définit un seul groupe de champs nommé arbitrairement "fs_addition", dans lequel on ajoute tous les paramètres de l'équation, désignés par leur symbole, qui doit correspondre au symbole fourni comme deuxième argument de `ParamDefinition()` dans JaLHyd.
Le deuxième et dernier bloc contient les options pour ce module: ici uniquement le lien vers la page de documentation pour ce module (`help`).
......@@ -209,7 +209,7 @@ Différents éléments de la configuration peuvent contenir une clé `help` donn
"HG": "devalaison/grille.html#hauteur-de-grille"
}
```
#### traduction
Dans le dossier de configuration `src/app/calculators/addition`, créer les fichiers d'internationalisation, par exemple `fr.json` pour le français. Il doivent reprendre tous les identifiants utilisés dans le fichier de configuration (paramètres, groupes de champs, listes déroulantes…) et fournir leur traduction, comme suit :
......@@ -400,7 +400,7 @@ Ainsi, pour rendre la visibilité d'un champ dépendante du choix dans la liste,
* écouter le changement de propriété (méthode `update()`, action `propertyChange`),
* selon la nouvelle valeur, ajuster la propriété `visible` des paramètres concernés.
Il n'y a rien à faire de particulier dans ngHyd.
### si le module agrège une section
......
......@@ -10,7 +10,7 @@ Requirements for developping Cassiopee can be achieved by manually install the r
#### Required dependencies
* [jalhyd](https://gitlab.irstea.fr/cassiopee/jalhyd)
* [jalhyd](https://forgemia.inra.fr/cassiopee/jalhyd)
* npm
* python3
* pandoc ^2 (optional, for PDF documentation only)
......@@ -33,7 +33,7 @@ sudo apt install pandoc texlive latexmk texlive-latex-extra texlive-bibtex-extra
Download and use the following docker image: https://hub.docker.com/repository/docker/geaucassiopee/ci-cd-cross-platform-webapp
More details on how to use it on vscode are available at https://gitlab.irstea.fr/cassiopee/cassiopee2-integration
More details on how to use it on vscode are available at https://forgemia.inra.fr/cassiopee/cassiopee2-integration
### Install dependencies
......@@ -222,7 +222,7 @@ Use [semantic versioning](https://semver.org/).
**It's discouraged to execute release steps manually, skip this section and see Release Script below**
Before releasing a new stable version, a new version of JaLHyd should be tagged, see "Release Policy" in [JaLHyd's README.md](https://gitlab.irstea.fr/cassiopee/jalhyd/blob/master/README.md)
Before releasing a new stable version, a new version of JaLHyd should be tagged, see "Release Policy" in [JaLHyd's README.md](https://forgemia.inra.fr/cassiopee/jalhyd/blob/master/README.md)
Then, one should complete the following files:
- `CHANGELOG.md`
......
......@@ -4,7 +4,7 @@ docs_dir: docs/en
site_dir: src/assets/docs/en/
copyright: CC BY-NC-ND 4.0, UMR G-EAU 2019 - <a href="https://cassiopee.g-eau.fr">https://cassiopee.g-eau.fr</a>
repo_name: ''
repo_url: 'https://gitlab.irstea.fr/cassiopee'
repo_url: 'https://forgemia.inra.fr/cassiopee'
theme:
name: 'material'
language: 'en'
......
......@@ -4,7 +4,7 @@ docs_dir: docs/fr
site_dir: src/assets/docs/fr/
copyright: CC BY-NC-ND 4.0, UMR G-EAU 2019 - <a href="https://cassiopee.g-eau.fr">https://cassiopee.g-eau.fr</a>
repo_name: ''
repo_url: 'https://gitlab.irstea.fr/cassiopee'
repo_url: 'https://forgemia.inra.fr/cassiopee'
theme:
name: 'material'
language: 'fr'
......
# fix compilation error due to chartjs-plugin-zoom 2.0.0
# cf. https://gitlab.irstea.fr/cassiopee/nghyd/-/issues/238#note_76247
# cf. https://forgemia.inra.fr/cassiopee/nghyd/-/issues/238#note_76247
sed -i "s/const enum UpdateModeEnum {$/enum UpdateModeEnum {/g" node_modules/chartjs-plugin-zoom/types/index.d.ts
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment