Skip to content

Commit

Permalink
docs: reorder docs
Browse files Browse the repository at this point in the history
  • Loading branch information
laurentC35 committed Feb 2, 2024
1 parent 95a0684 commit 8bcad28
Show file tree
Hide file tree
Showing 8 changed files with 152 additions and 70 deletions.
70 changes: 0 additions & 70 deletions docs/docs/features/transversal/metadata.mdx

This file was deleted.

45 changes: 45 additions & 0 deletions docs/docs/features/transversal/personnalisation/1_header.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Entête / Header

Cet élément apparaît en haut de page de façon permanente.

L'entête (logo, titre, liens additionnel) est la première partie de la page qui prend toute la largeur et qui sert de navigation simple pour l'usager.
On l'appelle aussi "Header".
Ce "Header" est entièrement paramétrable et ces paramètres viennent des possibilités offertes par le DSFR.

Le Header et le pied de page sont écrit en VTL x MD.

Mise à part cette specificité, ils doivent respecter les `props` de leur composants DSFR (Header et Footer)

## Exemple "ménage"

Exemple pour une enquête ménage

```json
{
"Header":{
"serviceTitle": "Enq_LibelleEnquete",
"operatorLogo":{
"alt": "Insee, mesurer pour comprendre",
"imgUrl": "/logoINSEE.png",
},
"quickAccessItems":[
{
"iconId": "fr-icon-questionnaire-line",
"linkProps": {
"href": "https://www.le-recensement-et-moi.fr/reponses/",
"target": "_blank"
},
"text": "Contacter l'assistance"
},
{
"iconId": "fr-icon-questionnaire-line",
"linkProps": {
"href": "https://www.le-recensement-et-moi.fr/reponses/",
"target": "_blank"
},
"text": "Contacter l'assistance"
}
]
}
}
```
3 changes: 3 additions & 0 deletions docs/docs/features/transversal/personnalisation/2_footer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Pied de page / Footer

Cet élément apparaît en bas de page de façon permanente.
30 changes: 30 additions & 0 deletions docs/docs/features/transversal/personnalisation/3_welcome.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { ImgViewer } from '@site/src/components/ImgViewer';

# Page d'accueil

Première page, avant de répondre au questionnaire.



On assume que le cas RP n'arrive jamais en visualisation.
Il arrive en mode "collecte" seulement lorsque l'identifiant du questionnaire vaut "`recensement`". Il s'agit d'un cas à part à conserver.

Dans tous les autres cas, cette page nécessite l'authentification de l'unité enquêtée.


Pour rappel, `personalization` est array qui liste les variables de personnalisation de l'orchestrateur pour une UE donnée.

Exemple de valeur

```tsx
const personalization = [
{name: "QuiRepond1", value : "Mme Dupond" },
{name: "QuiRepond2", value : "et son mari" }
]
```

La page d'accueil est la première page qui s'affiche si `currentPage`de l'objet data est `null`.
Au niveau du routage de l'application, l'orchestrateur s'affiche sur la page `/questionnaire/${xxx}/unite-enquetee/${yyy}/accueil`


<ImgViewer src="https://laurentc35.github.io/drawio/StromaeWelcomePage.drawio.png"/>
37 changes: 37 additions & 0 deletions docs/docs/features/transversal/personnalisation/4_postSubmit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Page de fin / remerciement

Dernière page, après avoir répondu au questionnaire.

## Exemple

```json
{
"Submit":{
"title": "L'Insee vous remercie de votre collaboration à cette enquête.",
"DescriptionAdditional": "Vous pouvez à present vous déconnecter.",

"AdditionalInformation":{
"Feedback": {
"title": "Aidez-nous à améliorer cette démarche ! Donnez-nous votre avis, cela ne prend que 2 minutes.",
"link": {
"label": "Je donne mon avis",
"title": "Donner votre avis sur l'enquête du recensement - ouvre une nouvelle fenêtre",
"target": "_blank",
"href": "https://voxusagers.numerique.gouv.fr/Demarches/848?&view-mode=formulaire-avis&nd_mode=en-ligne-enti%C3%A8rement&nd_source=button&key=d209f7b2be0fca3de1df21eaeff49a97",
"imageSrc": "https://voxusagers.numerique.gouv.fr/static/bouton-bleu.svg",
"alt": "Donner votre avis sur l'enquête du recensement"
}
},
"Results": {
"title": "Vous souhaitez consulter les résultats du recensement de la population?",
"link": {
"target": "_blank",
"title": "Accéder aux résultats du recensement - ouvre une nouvelle fentetre",
"label": "Voir les résultats",
"href": "https://www.insee.fr/fr/information/2008354"
}
}
}
}
}
```
29 changes: 29 additions & 0 deletions docs/docs/features/transversal/personnalisation/5_rp.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { JsonViewer } from '@site/src/components/JsonViewer';
import { ImgViewer } from '@site/src/components/ImgViewer';
import { Header as HeaderRP, Footer as FooterRP, Welcome as WelcomeRP } from './metadataRP';

# Cas actuel du RP
Voici les fichiers actuels du RP, qu'il faudra adapter avec les nouvelles modélisation choisi.

## L'entête / Header


<JsonViewer json={HeaderRP}></JsonViewer>


### Le pied de page


<JsonViewer json={FooterRP}></JsonViewer>

### Page d'accueil

Dans le cas du RP, la page d'accueil n'est pas personnalisable via la partie `personalization` du fichier `data`.
De plus, elle reste accessible même si l'unité enquêtée n'est pas authentifié.

<JsonViewer json={WelcomeRP}></JsonViewer>





Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Personnalisation",
"position": 3,
"link": {
"type": "generated-index",
"description": "Personnalisation de l'orchestrateur par enquête. Le fichier metadata décrit au format json, permet de rensigner tous les éléments paramétrable de l'orchestrateur, c'est à dire l'entête / Header, le pied de page / Footer, page d'accueil et page de fin/remerciement"
}
}

0 comments on commit 8bcad28

Please sign in to comment.