Skip to main content

Liens vers votre ENT

La documentation cite en permanence des adresses de l'ENT : /admin/access, /admin/configuration/ent, /diary, /stats… Ces chemins sont relatifs à l'ENT que vous utilisez, et ne sont donc pas directement cliquables.

Le sélecteur d'ENT du bandeau supérieur (icône de globe, à côté du sélecteur de thème) résout ce problème : choisissez votre ENT, et tous les chemins reconnus de la documentation deviennent des liens absolus vers votre ENT.

Choisir son environnement​

  • Par défaut, les liens pointent vers l'ENT de démonstration www.ent-scolaire.fr.
  • La liste déroulante reprend les ENT régionaux et départementaux hébergés (Éclat-BFC, Monlycée.net, Mon Bureau Numérique…). Un champ de filtre permet de retrouver le sien rapidement.
  • L'entrée « Autre ENT (adresse personnalisée) » accepte n'importe quelle adresse : une instance auto-hébergée, un environnement de recette, ou http://localhost:8090 en développement.

Le choix est mémorisé dans le navigateur et s'applique à toutes les pages de la documentation. Tant qu'aucune adresse n'est saisie en mode personnalisé, les chemins restent affichés tels quels, sans lien.

Ce qui devient cliquable​

Seules les adresses correspondant à une page connue de l'ENT sont transformées en lien :

  • les pages du dashboard, servies sous /dashboard — un chemin écrit /admin/access dans la documentation ouvre bien https://<votre-ent>/dashboard/admin/access ;
  • les points d'entrée des applications, servis à la racine — /blog, /diary, /stats…

Une route d'API (/diary/search), un WebSocket (/chat/ws) ou un chemin à trou (/admin/user/:id) restent volontairement du code brut : mieux vaut pas de lien qu'un lien mort.

Pour les rédacteurs​

Le registre des pages reconnues est le fichier docs/src/data/entRoutes.ts (pages du dashboard et points d'entrée des applications) ; la liste des ENT proposés est docs/src/data/entPlatforms.ts, reprise de l'écran d'administration Configuration › ENT › Liste des ENT.

Il n'y a rien à faire pour un chemin déjà listé : écrit en code inline (`/admin/access`), il est rendu cliquable automatiquement.

Pour lier un chemin absent du registre, deux composants s'importent en tête de fichier, comme les autres composants de la documentation :

import EntLink, { EntUrl } from '@site/src/components/EntLink';

Ouvrez <EntLink path="/admin/access" /> puis…

Connectez-vous sur <EntUrl /> avec votre compte administrateur.
  • <EntLink path="…" /> affiche le chemin et le lie à l'ENT sélectionné. Ajoutez force pour lier un chemin hors registre.
  • <EntUrl path="…" /> affiche l'URL absolue complète, à copier telle quelle.

Pour lier du texte de prose plutôt qu'un chemin — le nom d'une application cité dans une phrase, par exemple — ajoutez plain : le libellé passé en enfant est alors rendu tel quel, sans le style « code inline » :

depuis l'application <EntLink path="/admin/home" plain>**Dashboard**</EntLink>.

Fils d'Ariane​

Les pages d'administration commencent presque toujours par le chemin de menu de l'écran décrit. <EntBreadcrumb> rend chaque niveau cliquable, sans avoir à répéter les URL :

import EntBreadcrumb from '@site/src/components/EntBreadcrumb';

<EntBreadcrumb path="/admin/user/:id">Dashboard → Administration → Utilisateurs → fiche d'un compte</EntBreadcrumb> — bouton **« Envoyer l'invitation »**.

donne, sur l'ENT sélectionné :

Dashboard → Administration → Utilisateurs → fiche d'un compte (/admin/user/:id) — bouton « Envoyer l'invitation ».

Chaque niveau est retrouvé par son libellé dans docs/src/data/entMenu.ts, recopié du catalogue d'écrans du dashboard (frontend/apps/dashboard/src/utils/feature-catalog.ts, qui alimente déjà sa recherche globale). À régénérer avec python3 scripts/gen-ent-menu.py quand le sider d'administration bouge.

Points à connaître :

  • path décrit le dernier niveau : il est rappelé entre parenthèses et sert de cible à ce niveau. Ici /admin/user/:id porte un paramètre, donc « fiche d'un compte » reste en texte — il n'existe pas d'URL de fiche « en général ».
  • Un libellé absent du catalogue reste en texte. Deux libellés y sont ambigus — Applications et Assistant IA, portés chacun par deux écrans : donnez alors le chemin explicitement, via items={[{ label: 'Applications', path: '/admin/applications' }]}.
  • Les rubriques purement organisationnelles du sider (« Apparence & contenus », « Configuration », « Plateforme & supervision ») n'ont pas de page propre : elles ne sont volontairement pas liées.
  • En MDX, garder items={[…]} sur une seule ligne : un tableau écrit sur plusieurs lignes met le parseur en défaut dès que la balise porte des enfants.
Serveur de développement

La transformation automatique du code inline passe par un composant de thème (src/theme/MDXComponents/Code). Les alias de thème sont calculés au démarrage : après un git pull qui ajoute ou modifie un fichier de src/theme/, redémarrer yarn start, sinon les chemins restent affichés sans lien.