Code/app/fiches/README.md
2025-05-11 15:47:54 +02:00

2.1 KiB

Module Fiches

Ce module gère la consultation, l'affichage et la manipulation des fiches techniques dans l'application FabNum. Il permet aux utilisateurs de naviguer dans la documentation structurée des différents éléments de la chaîne de fabrication du numérique.

Structure du module

Le module fiches est organisé comme suit :

  • interface.py : Point d'entrée principal qui gère l'interface utilisateur des fiches
  • generer.py : Responsable de la génération et du rendu des fiches
  • utils/ : Contient des utilitaires spécifiques aux fiches
    • dynamic/ : Composants dynamiques pour le rendu des fiches
      • assemblage_fabrication/ : Traitement des opérations d'assemblage et de fabrication
      • indice/ : Calcul et affichage des différents indices (IHH, IVC, etc.)
      • minerai/ : Traitement spécifique aux fiches de minerais
      • utils/ : Utilitaires partagés pour le rendu dynamique
    • tickets/ : Gestion des tickets liés aux fiches

Fonctionnalités

Navigation et consultation

  • Affichage hiérarchique des catégories de fiches
  • Recherche de fiches par mots-clés
  • Visualisation des fiches au format Markdown avec rendu dynamique
  • Navigation entre fiches connexes

Traitement dynamique

  • Génération de tableaux de synthèse pour les indices de criticité
  • Rendu des graphiques et visualisations intégrées aux fiches
  • Traitement des blocs YAML pour les opérations spécifiques

Gestion des tickets

  • Création de tickets pour signaler des corrections ou des améliorations
  • Visualisation des tickets existants liés à une fiche
  • Interface structurée pour soumettre des contributions

Utilisation

  1. Accédez à l'onglet "Fiches" dans l'interface principale
  2. Explorez les catégories ou utilisez la recherche pour trouver une fiche
  3. Consultez le contenu de la fiche avec ses visualisations dynamiques
  4. Si nécessaire, utilisez l'option "Créer un ticket" pour proposer des modifications

Ce module est au cœur de la consultation documentaire de l'application, permettant de naviguer efficacement dans la base de connaissances sur la chaîne de fabrication du numérique.