Table des matières

• 1. Introduction
• 2. Installation du programme
  • 2.1. Installation complète (recommandé)
  • 2.2. Vérification
  • 2.3. Installation minimale
• 3. Utilisation
  • 3.1. Utiliser Mocodo online
  • 3.2. Utiliser Mocodo en ligne de commande
    • 3.2.1. Au plus simple
    • 3.2.2. Liste des arguments
      • 3.2.2.1. Options sur Mocodo lui-même
      • 3.2.2.2. Entrée-sortie
      • 3.2.2.3. Aspect de la sortie graphique
      • 3.2.2.4. Sortie relationnelle
      • 3.2.2.5. Modifications du texte d'entrée
      • 3.2.2.6. Réarrangement par séparation et évaluation
      • 3.2.2.7. Réarrangement par algorithme génétique
      • 3.2.2.8. Réarrangement par résolution d'un programme linéaire
      • 3.2.2.9. Options spécifiques aux Notebooks
    • 3.2.3. Paramétrage à long terme
  • 3.3. Utiliser Mocodo sous Jupyter Notebook
    • 3.3.1. Invocation
    • 3.3.2. Principes de fonctionnement
    • 3.3.3. Exemples d'invocation
    • 3.3.4. Modification in situ d'une cellule
    • 3.3.5. Paramétrage à long terme
• 4. Description d'un MCD
  • 4.1. Besoins élémentaires
    • 4.1.1. Entités, associations, attributs, identifiants, cardinalités
    • 4.1.2. Dépendances fonctionnelles
    • 4.1.3. Associations réflexives
    • 4.1.4. Placement sur plusieurs rangées
  • 4.2. Besoins plus avancés
    • 4.2.1. Identifiants multiples
    • 4.2.2. Entités faibles (identification relative)
    • 4.2.3. Flèches sur les pattes
    • 4.2.4. Styles
    • 4.2.5. Types de données
    • 4.2.6. Format des cardinalités
    • 4.2.7. Rectification automatique des cardinalités mal formées
    • 4.2.8. Symbole de dépendance fonctionnelle
    • 4.2.9. Créer plusieurs entités ou associations de même nom
  • 4.3. Besoins spécifiques à la pédagogie
    • 4.3.1. Créer une vue en extension
    • 4.3.2. Afficher l'explication des cardinalités
    • 4.3.3. Créer un MCD à compléter
      • 4.3.3.1. Supprimer le marquage d'un identifiant
      • 4.3.3.2. Masquer un couple de cardinalités
      • 4.3.3.3. Masquer un attribut
      • 4.3.3.4. Ne faire apparaître que le squelette du schéma conceptuel
    • 4.3.4. Obfuscation: remplacer tous les libellés par du faux-texte
• 5. Tracé d'un MCD
  • 5.1. Insertion manuelle d'espacements
  • 5.2. Ajustement automatique dans une grille minimale
  • 5.3. Basculement des cardinalités et inflexion des pattes rectilignes
  • 5.4. Retouches fines
    • 5.4.1. Par modification du script intermédiaire
    • 5.4.2. Par édition de la sortie au format SVG
  • 5.5. Réarrangement par symétrie
    • 5.5.1. Symétrie selon l'axe vertical
    • 5.5.2. Symétrie selon l'axe horizontal
    • 5.5.3. Symétries selon les diagonales (transposition)
      • 5.5.3.1. Astuce: édition rapide d'une ou plusieurs colonnes
  • 5.6. Réarrangement automatique
    • 5.6.1. Méthode exacte spécialisée
      • 5.6.1.1. À l'intérieur d'une grille prédéfinie
      • 5.6.1.2. Par croissance organique
    • 5.6.2. Méthode heuristique
    • 5.6.3. Méthode exacte générique
  • 5.7. Conversion dans d'autres formats graphiques
• 6. Passage au relationnel
  • 6.1. Construction de la représentation interne
    • 6.1.1. Cas réguliers
      • 6.1.1.1. Exemple du traitement des associations non DF
      • 6.1.1.2. Exemple du traitement des associations DF
      • 6.1.1.3. Exemple du traitement des entités faibles (identification relative)
      • 6.1.1.4. Rétablissement explicite de la sémantique des DF disparues
    • 6.1.2. Cas irréguliers
      • 6.1.2.1. Réduire une clef primaire
      • 6.1.2.2. Minimiser le nombre de champs vides
  • 6.2. Construction de représentations externes
    • 6.2.1. Gabarits inclus dans la distribution
      • 6.2.1.1. Formats linéaires
      • 6.2.1.2. Formats linéaires avec explications
      • 6.2.1.3. Diagramme relationnel
      • 6.2.1.4. Sorties SQL
      • 6.2.1.5. Dictionnaire des données (bonus)
    • 6.2.2. Modification ou création de nouveaux gabarits
      • 6.2.2.1. Algorithme
      • 6.2.2.2. Identificateurs disponibles pour la composition de chaînes
      • 6.2.2.3. Composition des attributs selon leur nature
      • 6.2.2.4. Gabarit vide
• 7. Crédits

1. Introduction

Mocodo est un logiciel d'aide à l'enseignement et à la conception des bases de données relationnelles.

• En entrée, il prend une description textuelle des entités et associations du modèle conceptuel de données (MCD).
• En sortie, il produit son diagramme entité-association en SVG et son schéma relationnel (MLD) en SQL, $\mathrm\LaTeX$, Markdown, etc.

Ci-dessous, un exemple d'appel du programme (première ligne) sur un texte d'entrée (lignes suivantes), puis, en sortie, le MCD et le MLD correspondants:

L'appel ci-dessus a également construit le dictionnaire des données:

• Num. classe
• Num. salle
• Vol. horaire
• Code catégorie
• Nom catégorie
• Num. élève
• Nom élève
• Note
• Num. prof
• Nom prof
• Date
• Libellé matière

Ainsi que le diagramme relationnel, qui peut être visualisé par un nouvel appel:

La devise de Mocodo, « nickel, ni souris », en résume les principaux points forts:

• description textuelle des données. L'utilisateur n'a pas à renseigner, placer et déplacer des éléments comme avec une lessive ordinaire. Il ne fournit rien de plus que les informations définissant son MCD. L'outil s'occupe tout seul du plongement;
• propreté du rendu. La sortie se fait en vectoriel, prête à être affichée, imprimée, agrandie, exportée dans une multitude de formats sans perte de qualité;
• rapidité des retouches. L'utilisateur rectifie les alignements en insérant des éléments invisibles, en dupliquant des coordonnées ou en ajustant des facteurs mutiplicatifs: là encore, il travaille sur une description textuelle, et non directement sur le dessin.

Mocodo est libre, gratuit et multiplateforme. Si vous l'aimez, répandez la bonne nouvelle en incluant l'un de ses logos dans votre support: cela multipliera ses chances d'attirer des contributeurs qui le feront évoluer.

2. Installation du programme

2.1. Installation complète (recommandé)

• Installez la distribution Anaconda, qui contient Python (2 ou 3), IPython et bien plus encore.

• Tapez ensuite sous un terminal la ligne de commande:

    pip install mocodo_magic

Cette commande installera Mocodo, ainsi que l'extension IPython qui permettra de l'utiliser dans un document comme celui-ci (il s'agit d'un Jupyter notebook).

2.2. Vérification

Toujours sous un terminal, tapez:

mocodo

Si votre système se plaint que cette commande n'existe pas, localisez le fichier mocodo et ajoutez le chemin du répertoire contenant à votre PATH:

• sous Linux ou Mac OS X;
• sous Windows.

Pour mettre la « commande magique » mocodo à disposition d'un notebook donné, évaluez dans celui-ci la cellule suivante:

%reload_ext mocodo_magic

Techniquement, %load_ext mocodo_magic suffit, mais cette forme vous épargnera un message d'erreur si vous réévaluez ultérieurement la cellule. Pour tester, évaluez une cellule avec:

Pour charger automatiquement mocodo_magic à chaque ouverture d'un notebook (ce qui dispense d'évaluer %load_ext mocodo_magic) :

• exécuter sous un terminal :

        ipython profile create

• éditer le fichier créé (p. ex.: ~/.ipython/profile_default/ipython_config.py) pour remplacer les lignes suivantes :

        ## A list of dotted module names of IPython extensions to load.
        #c.InteractiveShellApp.extensions = []
  
  

  par celles-ci :

        ## A list of dotted module names of IPython extensions to load.
        c.InteractiveShellApp.extensions = [
            "mocodo_magic",
        ]

2.3. Installation minimale

• Si vous êtes sous Mac OS X ou Linux, vous avez déjà Python. Dans le cas contraire, vous devrez probablement l'installer.

• Une fois Python installé, tapez sous un terminal:

  pip install mocodo

Vous ne bénéficierez pas de Jupyter Notebook, mais vous pourrez utiliser Mocodo en ligne de commande.

3. Utilisation

Vous pouvez utiliser Mocodo:

• dans un navigateur récent, sans rien installer, avec Mocodo online;
• sur votre machine, comme n'importe quel programme Python;
• dans un document Jupyter Notebook (à l'instar de cette documentation).

3.1. Utiliser Mocodo online

Faites pointer votre navigateur sur http://mocodo.net: vous pouvez commencer à taper votre MCD. Appuyez à tout moment sur le bouton de génération pour visualiser le diagramme conceptuel et en déduire les relations. Une fois que le résultat vous convient, appuyez sur le bouton de téléchargement pour récupérer une archive ZIP contenant tous les fichiers d'entrée et de sortie désirés.

Mocodo online est conçu pour une utilisation occasionnelle et/ou interactive, et son interface vise avant tout à la simplicité. Vous n'avez donc accès qu'aux options essentielles du programme. Si vous en voulez davantage, tant en termes de paramétrage, que de calcul ou de fonctionnalités, vous pouvez installer Mocodo sur votre machine.

3.2. Utiliser Mocodo en ligne de commande

3.2.1. Au plus simple

Tout a été fait pour faciliter au maximum la prise en main. Ainsi, pour peu que vous sachiez lancer une console (cmd sous Windows, Terminal sous Mac OS X), il vous suffit d'y entrer:

mocodo

Invoqué sous cette forme, le script récupère le texte d'entrée du MCD dans le répertoire courant sous le nom de sandbox.mcd. Si ce fichier n'existe pas, il y sera automatiquement créé avec un MCD d'exemple. Par la suite, vous n'aurez qu'à le garder ouvert sous un éditeur de texte, afin de le modifier selon vos besoins avant de lancer la commande.

3.2.2. Liste des arguments

La commande mocodo admet de nombreux arguments optionnels. Voici la traduction en français de la liste affichée par l'argument --help. Destinée à servir de référence, elle peut être sautée sans inconvénient à la première lecture. Nous avons ajouté des liens vers des exemples d'utilisation dans ce document; notez cependant que les %% ou % qui préfixent la « commande magique » mocodo doivent être omis de la ligne de commande.

3.2.2.1. Options sur Mocodo lui-même

• --help.
  Affiche un message d'aide, puis termine.
• --version.
  Affiche le numéro de version, puis termine.
• --language CODE.
  Outrepasse la localisation automatique des messages avec le code de langage donné (p. ex., fr, en, ...) (défaut: langue du système).
• --restore.
  Recrée une version originelle des fichiers sandbox.mcd et params.json dans le répertoire d'entrée, puis termine (défaut: False).

3.2.2.2. Entrée-sortie

• --params_path PATH.
  Le chemin du fichier de paramètres. S'il est omis, utilise params.json dans le répertoire d'entrée. Si ce fichier n'existe pas, utilise les paramètres par défaut (défaut: params.json).
• --input PATH.
  Le chemin du fichier d'entrée. Les fichiers de sortie seront par défaut générés dans le même répertoire (défaut: sandbox.mcd).
• --output_dir PATH.
  Le répertoire où générer les fichiers de sortie (défaut: le répertoire où se trouve le fichier d'entrée).
• --encodings [STR [STR ...]].
  Un ou plusieurs encodages à essayer successivement pour lire le fichier d'entrée (défaut: utf8, puis encodage historique de la plateforme).
• --extract.
  Crée un fichier JSON séparé pour les paramètres géométriques (défaut: False).
• --image_format {svg,nodebox}.
  Outrepasse la sélection automatique du format d'image produit par le script généré (défaut: dépendant de votre système et de votre installation).
• --print_params.
  Affiche le contenu du fichier de paramètres, puis termine (défaut: False).

3.2.2.3. Aspect de la sortie graphique

• --df STR.
  Acronyme à encercler dans une dépendance fonctionnelle (défaut: DF).
• --card_format STR.
  Chaîne de format pour les cardinalités minimale et maximale (défaut: {min_card},{max_card}).
• --strengthen_card STR.
  Chaîne pour les cardinalités relatives (défaut: _1,1_).
• --flex FLOAT.
  Infléchit les pattes rectilignes dont les cardinalités sont susceptibles de collision (défaut: 0.75).
• --tkinter.
  Utilise Tkinter pour calculer les dimensions des libellés (défaut: False).
• --colors PATH.
  Palette de couleurs à utiliser lors de la génération du dessin. Nom (sans extension) d'un fichier du répertoire colors, ou chemin vers un fichier personnel (défaut: bw).
• --shapes PATH.
  Spécification des polices, des dimensions, etc. Nom (sans extension) d'un fichier du répertoire shapes, ou chemin vers un fichier personnel (défaut: dépendant de votre système).
• --scale SCALE.
  Facteur d'échelle multiplicatif (défaut: 1.0).
• --hide_annotations.
  Ignore le survol des éléments annotés (défaut: False).

3.2.2.4. Sortie relationnelle

• --relations [NAME [NAME ...]].
  Un ou plusieurs gabarits pour les schémas relationnels générés. Cf. répertoire relation_templates (défaut: html text).
• --disambiguation {numbers_only,annotations}.
  Méthode de désambiguïsation des attributs migrants homonymes (défaut: annotations).
• --title STR.
  Nom de la base (utilisé pour la sortie SQL) (défaut: Sans titre).
• --guess_title.
  Utiliser le nom de l'entité la plus référencée comme titre (défaut: False).

3.2.2.5. Modifications du texte d'entrée

• --arrange [{bb,ga,lp}].
  Met en page le diagramme, soit par séparation et évaluation, soit avec un algorithme génétique, soit avec un solveur de programmes linéaires, puis termine (défaut: None).
• --timeout SECONDS.
  Limite la durée du calcul de la mise en page (défaut: None).
• --verbose.
  Affiche des détails oiseux lors du réarrangement (défaut: False).
• --flip {h,v,d}.
  Affiche une version retournée horizontalement / verticalement / diagonalement du texte d'entrée, puis termine (défaut: None).
• --fit [INT].
  Reformate le texte d'entrée dans la ième plus petite grille possible, puis termine (défaut: None).
• --obfuscate [PATH].
  Affiche une version du texte d'entrée vidée de sa sémantique, puis termine. Cf. répertoire lorem (défaut: None).
• --obfuscation_max_length INT.
  Longueur maximale des mots de substitution (défaut: None).
• --obfuscation_min_distance INT.
  Distance de Damerau Levenshtein minimale entre deux mots de substitution (défaut: 3).
• --seed FLOAT.
  Valeur du germe du générateur aléatoire (défaut: None).

3.2.2.6. Réarrangement par séparation et évaluation

Sous-options accessibles avec l'option --arrange=bb.

• --call_limit INT.
  Nombre maximal d'appels pour une boîte de départ donnée (défaut: 10000).
• --min_objective INT.
  Meilleur objectif esthétique pour la mise en page (défaut: 0).
• --max_objective INT.
  Pire objectif esthétique pour la mise en page (défaut: 15).
• --organic.
  Réarrangement non limité à la grille originelle (défaut: False).

3.2.2.7. Réarrangement par algorithme génétique

Sous-options accessibles avec l'option --arrange=ga.

• --population_size INT.
  Nombre d'individus à faire évoluer (défaut: 1000).
• --crossover_rate RATE.
  Taux de croisement, entre 0 et 1 (défaut: 0.9).
• --mutation_rate RATE.
  Taux de mutation, entre 0 et 1 (défaut: 0.06).
• --sample_size INT.
  Taille de l'échantillon pour les tournois (défaut: 7).
• --max_generations INT.
  Nombre maximal de générations (défaut: 300).
• --plateau INT.
  Nombre maximal de générations consécutives sans amélioration (défaut: 30).

3.2.2.8. Réarrangement par résolution d'un programme linéaire

Sous-options accessibles avec l'option --arrange=lp.

• --engine [{cplex,gurobi}].
  Solveur de programmes linéaires (défaut: None).

3.2.2.9. Options spécifiques aux Notebooks

Ignorées lors de l'appel en ligne de commande.

• --mld.
  Affiche le schéma relationnel en HTML dans la sortie de la cellule (défaut: False).
• --no_mcd.
  N'affiche pas le diagramme conceptuel dans la sortie de la cellule (défaut: False).
• --replace.
  Remplace le contenu de la cellule par le résultat de son évaluation (défaut: False).

3.2.3. Paramétrage à long terme

Pour éviter d'avoir à invoquer Mocodo répétitivement avec une longue kyrielle d'options, vous pouvez mettre celles-ci une fois pour toutes dans un fichier params.json situé dans le répertoire courant. La commande:

mocodo --restore

... le fait pour vous avec un fichier de paramètres vide, i.e. , un fichier-texte réduit aux deux caractères {} (attention, elle rétablit aussi le fichier sandbox.mcd à son contenu par défaut). Vous êtes encouragés à modifier ce fichier de paramètres selon vos goûts et vos besoins. De la sorte, le style de vos MCD pourra être maintenu à moindre frais à travers tous vos documents. En cas de besoin, vous pourrez toujours ponctuellement passer outre ces réglages en en précisant d'autres en ligne de commande. Plus précisément, chaque paramètre est déterminé:

1. par sa valuation en ligne de commande;
2. à défaut, par sa valuation dans le fichier de paramètres indiqué par --params_path;
3. à défaut d'une telle indication, par sa valuation dans le fichier params.json du répertoire courant;
4. à défaut, par une valeur défaut éventuellement dépendante de votre système.

Si vous lancez Mocodo avec l'option --print_params, la valeur courante de l'ensemble des paramètres sera affichée. Vous pouvez envoyer la sortie dans un fichier params.json et la modifier à votre gré pour une prise en compte lors du lancement suivant.

3.3. Utiliser Mocodo sous Jupyter Notebook

3.3.1. Invocation

Elle nécessite l'installation de l'extension notebook mocodo, laquelle doit en outre être rechargée à chaque ouverture (cf. première cellule de ce document). On a ainsi déclaré une « commande magique » mocodo qui sera invoquée en la préfixant:

• de %% pour prendre toutes les lignes suivantes de la cellule comme texte d'entrée du MCD;
• de % si l'on récupère l'entrée ailleurs (avec --input), ou qu'on n'en a pas besoin (p. ex., --help ou --print_params).

À part ça, la syntaxe est généralement la même qu'en ligne de commande, ce qui devrait faciliter le passage de l'un à l'autre.

3.3.2. Principes de fonctionnement

Il peut être utile de comprendre ce qui se passe en coulisses lorsque l'on invoque la commande magique sur une cellule:

• dans le répertoire courant est créé au besoin un sous-répertoire mocodo_notebook;
• le texte d'entrée y est sauvegardé sous le nom de sandbox.mcd;
• la commande est lancée sur ce fichier avec tous les paramètres donnés par l'utilisateur. Cela signifie que tous les fichiers générés le seront au même endroit sous les noms de sandbox.svg, sandbox.html, etc.;
• si la commande a produit un dessin, celui-ci est affiché en sortie (sauf avec l'option --no_mcd); avec l'option --mld, le schéma relationnel est également affiché au-dessous (au format HTML);
• si elle n'a pas produit de dessin, mais une nouvelle version du texte d'entrée (options --arrange, --flip, --obfuscate, ...), Mocodo est automatiquement relancé sur celle-ci, permettant de visualiser le diagramme et/ou le schéma relationnel correspondants.

Tous les fichiers peuvent être lus dans le répertoire mocodo_notebook (commande magique %load, mise en commentaire dans ce notebook pour éviter de recharger le fichier à chaque exécution).

3.3.3. Exemples d'invocation

Les trois exemples de l'introduction illustrent plusieurs de ces techniques usuelles:

%%mocodo --mld --colors ocean --shapes copperplate --relations diagram markdown_data_dict

... invoque le programme en demandant l'affichage du diagramme conceptuel (implicitement), du schéma relationnel (avec --mld), des changements de style (avec --colors et --shapes) et la production d'un diagramme relationnel (--relations diagram) et d'un dictionnaire de données (markdown_data_dict). Le contenu de celui-ci est rechargé et visualisé à l'aide de la commande suivante:

%load mocodo_notebook/sandbox_data_dict.md

Tandis que le diagramme relationnel (MLD) est tracé en relançant Mocodo dessus:

%mocodo --input mocodo_notebook/sandbox.mld --colors desert

3.3.4. Modification in situ d'une cellule

Nouveauté de la version 2.0.20 (contribution de Thomas Giro). Avec les options --arrange, --flip et --obfuscate le résultat de l'évaluation de la cellule est un nouveau MCD, normalement affiché au-dessous. Ajoutez l'option --replace pour substituer ce MCD au contenu de la cellule. Réévaluez alors celle-ci pour tracer le MCD résultant, ou annulez la dernière opération pour revenir au contenu originel.

Par exemple, l'évaluation de la cellule suivante:

... remplacerait celle-ci par celle-là:

3.3.5. Paramétrage à long terme

Si vous voulez éviter de préciser à chaque fois les mêmes arguments (par exemple un changement de couleurs), vous pouvez placer un fichier params.json dans le répertoire mocodo_notebook. Mocodo peut même vous aider à le faire en exécutant la cellule suivante:

Son évaluation remplace son propre contenu par des lignes de code similaires à:

Modifiez la variable params à votre gré en respectant la syntaxe JSON (attention en particulier au dernier couple clef-valeur, qui n'est pas terminé par une virgule). Exécutez la cellule pour créer un fichier de nom et emplacement adéquats (notez que la valeur de --print_params a été passée à false pour vous éviter de le faire à la main).

4. Description d'un MCD

4.1. Besoins élémentaires

4.1.1. Entités, associations, attributs, identifiants, cardinalités

La syntaxe ne devrait pas poser problème:

• une entité est définie par son nom, deux-points, sa liste d'attributs séparés par des virgules;
• une association est définie par son nom, virgule, les cardinalités et l'entité de sa première patte, virgule, les cardinalités et l'entité de sa deuxième patte, etc., deux-points, sa liste d'attributs séparés par des virgules.

À noter :

• le premier attribut d'une entité est considéré par défaut comme son identifiant, et donc souligné;
• pour les associations sans attributs, le deux-points est facultatif;
• la première ligne:

    %%mocodo
  

  ... ne fait pas partie de la description. Dans ce document, elle permet de faire appel à une « commande magique », qui lance Mocodo sur les lignes qui la suivent. Sauf sous Jupyter Notebook, vous pouvez l'omettre dans votre texte d'entrée.
  De façon générale, la ou les premières lignes d'un MCD qui commencent par le symbole de pourcentage (%) sont ignorées. Cela permet de placer en en-tête un commentaire qui pourra être préservé lors des éventuels réarrangements ultérieurs.
• Les accents présents dans votre fichier d'entrée sont correctement gérés pourvu que vous ayez enregistré celui-ci dans l'encodage attendu par Mocodo en entrée: c'est par défaut Unicode UTF-8. Une tolérance existe: si Mocodo échoue à décoder votre fichier avec utf8, il se rabattra sur le codec d'Europe de l'Ouest associé historiquement à votre plateforme: iso-8859-15 pour Windows et Linux, mac-roman pour Mac OS X. Si les accents n'apparaissent pas correctement, vous aurez encore trois solutions:
  1. soit (fortement conseillé), ré-enregistrer votre fichier en UTF-8 au lieu d'un encodage historique;
  2. soit (ponctuellement), passer l'encodage de votre fichier en argument avec --encodings;
  3. soit (à long terme), modifier dans params.json la liste des encodages pris en charge.

4.1.2. Dépendances fonctionnelles

Si on a plusieurs dépendances fonctionnelles à représenter, on devra suffixer le DF par un numéro (cf. cet exemple).

4.1.3. Associations réflexives

4.1.4. Placement sur plusieurs rangées

L'ordre et la séparation des lignes de la description permet de spécifier à coût zéro un plongement grossier, mais qui s'avère en général suffisant:

• les boîtes (entités et associations) définies sur des lignes consécutives sont tracées sur une même rangée;
• un saut de ligne indique une nouvelle rangée.

Les boîtes sont placées aux intersections d'une grille invisible assurant que leurs centres soient alignés aussi bien horizontalement que verticalement. C'est ce qui en général est le plus satisfaisant esthétiquement, mais d'autres retouches peuvent être opérées manuellement dans le fichier de sortie.

Le plongement fait l'objet d'une « compression » horizontale et verticale. Par exemple, ci-dessus, il y a un espace horizontal négatif entre le bord droit de l'entité de gauche et le bord gauche de l'entité de droite.

4.2. Besoins plus avancés

4.2.1. Identifiants multiples

Préfixer d'un caractère de soulignement (_) le(s) second, troisième, etc. attributs pour les ajouter à l'identifiant.

4.2.2. Entités faibles (identification relative)

Préfixer d'un caractère de soulignement (_) une cardinalité (1,1) pour indiquer que l'entité distinguée est faible. Dans le diagramme, les identifiants (ou discriminants) d'une telle entité seront soulignés en pointillés, tandis que le (1,1) sera souligné d'un trait plein.

Nouveauté de la version 2.1. Traditionnellement, l'identification relative est dénotée par des parenthèses autour des cardinalités. Cette notation (ou toute autre) peut maintenant être obtenue avec l'option --strenghten_card:

Une association ne peut renforcer plus d'une entité faible. Ainsi, une erreur se produit si l'on remplace le 1N par _11:

4.2.3. Flèches sur les pattes

Suffixer d'un chevron (< ou >) les cardinalités de la patte concernée. La direction indiquée se lit en partant de l'association et en allant vers l'entité.

La position de la flèche sur la patte peut être réglée individuellement dans la table d'association ratio du script Python généré (par défaut, sandbox_svg.py ou sandbox_nodebox.py) ou sous l'onglet Retouches de la version en ligne. La valeur correspondante peut varier de 0.0 (flèche cachée sous la boîte d'origine) à 1.0 (par défaut, pointe de la flèche au contact du bord de la boîte de destination, compte non tenu de l'arrondi s'il s'agit d'une association).

4.2.4. Styles

Plusieurs styles prédéfinis sont distribués avec l'application. Un style se définit comme la combinaison d'une palette de couleurs (répertoire colors) avec un dictionnaire de polices et de dimensions (répertoire shapes). Une changement d'échelle d'un facteur multiplicatif positif peut être précisé avec l'argument --scale.

Vous pouvez bien sûr créer vos propres styles en vous inspirant des fichiers fournis. Si vous êtes particulièrement content d'un style, soumettez-le pour inclusion dans une prochaine distribution.

4.2.5. Types de données

Chaque attribut peut être assorti d'annotations entre crochets. Ignorées au niveau du tracé du MCD, elles sont interprétées comme des types de données lors de la génération d'un code-source SQL.

4.2.6. Format des cardinalités

Par défaut, les cardinalités sont séparées par une virgule.

Nouveauté de la version 2.1. On peut maintenant opter pour un format quelconque:

4.2.7. Rectification automatique des cardinalités mal formées

Certaines fautes de frappe fréquentes (inversion des cardinalités minimale et maximale, lettre « O » au lieu du chiffre « 0 ») sont silencieusement rectifiées:

Les cardinalités (N,N), qui selon une certaine école dénotent une cardinalité minimale supérieure à 1, sont laissées telles quelles.

4.2.8. Symbole de dépendance fonctionnelle

Il est possible d'activer l'encerclement d'un autre sigle que DF. C'est ce sigle qui devra alors apparaître en entrée, par exemple:

Comme le cercle est alors un peu plus grand, on peut vouloir régler (a priori une fois pour toutes) le ratio défini dans le dictionnaire de shapes:

"df_text_height_ratio"             : 1.00,

4.2.9. Créer plusieurs entités ou associations de même nom

Normalement on doit choisir des noms différents pour toutes les boîtes (entités et associations) du MCD, à l'exception des associations de dépendance fonctionnelle figurées par un sigle. On a vu que dans ce cas, il suffisait d'ajouter à leur nom un suffixe numérique: celui-ci n'apparaîtra pas en sortie. Cette possibilité vaut pour n'importe quelle boîte.

Elle servira typiquement à « distribuer » une entité DATE réduite à son identifiant date, mais associée à de nombreuses entités qui n'ont rien à voir entre elles. Sachant qu'une telle entité est amenée à disparaître lors du passage au relationnel, il n'y a aucun inconvénient à en créer plusieurs, et cela peut avoir l'avantage de faciliter (ou même de rendre possible) l'obtention d'une bonne mise en page.

Par exemple, la mise en page du MCD suivant est indûment complexifiée par le haut degré de l'entité DATE.

Ajouter une autre entité DATE (sous le nom de DATE2) permettra à Mocodo de calculer une mise en page à la fois plus agréable à l'œil et plus compacte ($4\times3$ au lieu de $5\times4$). La sémantique est inchangée.

4.3. Besoins spécifiques à la pédagogie

Si vous n'êtes pas enseignant de bases de données, vous pouvez passer directement à la section suivante.

4.3.1. Créer une vue en extension

La technique de duplication que l'on vient de voir peut servir à produire une vue en extension d'un MCD. Voici par exemple le MCD que j'utilise en cours pour introduire la notion d'entité faible (à gauche, vue en compréhension, à droite vue en extension):

4.3.2. Afficher l'explication des cardinalités

Les débutants ont souvent des doutes sur la sémantique de telle ou telle cardinalité. Cette information peut désormais être incluse dans le texte-source, en annotant les pattes correspondantes, pour apparaître à la demande lors du rendu (utile pour créer des exercices à faire en TD ou en autonomie).

Survolez les cardinalités du MCD ci-dessous pour faire apparaître leur description.

Les annotations s'insèrent entre cardinalités et nom de l'entité. Elles sont délimitées par des crochets droits.

Avec l'option --disambiguation=annotations (par défaut), elles sont également exploitables lors du passage au relationnel pour préciser la sémantique d'une clef étrangère.

L'affichage est désactivé avec l'option --hide_annotations.

Limitations.

• Ne fonctionne pas sous Inkscape.
• Ne semble pas fonctionner dans une page HTML statique (comme la version HTML de ce document sous GitHub).
• Semble nécessiter une réévaluation de la cellule pour fonctionner dans un notebook fermé, puis rouvert.
• Sans effet sur le diagramme conceptuel généré avec l'option --image_format=nodebox.

4.3.3. Créer un MCD à compléter

Les MCD à trous sont des exercices classiques d'introduction aux bases de données.

4.3.3.1. Supprimer le marquage d'un identifiant

Pour éviter le marquage automatique du premier attribut d'une entité comme identifiant, il suffit de le préfixer par un _ (ce caractère est donc un commutateur, qui souligne un attribut non souligné par défaut, et désouligne un attribut souligné par défaut).

4.3.3.2. Masquer un couple de cardinalités

Vous pouvez masquer n'importe quelles cardinalités en les remplaçant pas XX (ci-dessous à gauche) :

4.3.3.3. Masquer un attribut

Vous pouvez mettre deux virgules consécutives pour réserver la place d'un attribut manquant.

Les espaces insécables sont préservés, ce qui permet de réserver plus d'espace horizontal, cf. ci-dessous premier attribut vide de INCLURE.

4.3.3.4. Ne faire apparaître que le squelette du schéma conceptuel

Enfin, vous pouvez transformer en exercice à trous n'importe quel MCD en rendant complètement transparentes les couleurs des attributs, associations et cardinalités. Le style blank a été prédéfini à cet effet:

Attention, n'utilisez pas cette méthode si vous souhaitez diffuser l'exercice sous forme électronique: l'information textuelle est toujours présente, susceptible d'être sélectionnée et collée ailleurs pour être lue. Vous pouvez bien sûr empêcher cette possibilité en convertissant la figure dans un format bitmap (comme PNG ou GIF); mais le plus simple est de combiner les deux méthodes précédentes:

4.3.4. Obfuscation: remplacer tous les libellés par du faux-texte

L'obfuscation d'un MCD consiste à vider celui-ci de sa sémantique de surface, en substituant à tous les libellés des chaînes aléatoires. Le résultat sera par exemple utilisé pour montrer que les principales règles de passage du schéma conceptuel au schéma relationnel peuvent être appliquées « bêtement », c'est-à-dire sans comprendre le fonctionnement de l'organisme modélisé.

Ainsi, dans l'exemple ci-dessous, les libellés du MCD CLIENT-COMMANDE-PRODUIT sont remplacés par des mots tirés au hasard:

Nouveauté de la version 2.0.20. Pour remplacer le texte de la cellule par le résultat de son évaluation, ajoutez l'option --replace.

En argument, vous pouvez ajouter le chemin d'un fichier texte UTF-8 quelconque où puiser les mots de substitution. Par exemple, le texte même de cette documentation:

Mocodo essaie d'abord de trouver ce fichier à l'endroit indiqué. En cas d'échec, il le cherche (avec extension .txt facultative) parmi les textes distribués avec le logiciel, à savoir:

• "lorem_ipsum.txt": le faux-texte le plus courant.
• "disparition.txt": le lexique du célèbre roman lipogrammatique de Georges Perec.
• "four_letter_words.txt": une sélection (SFW) de mots anglais de quatre lettres.

En cas de nouvel échec, il se rabat sur "lorem_ipsum.txt".

L'option obfuscation_max_length permet de limiter la longueur des libellés de substitution (par défaut, c'est la longueur du plus long mot du faux-texte).

Notez enfin que l'algorithme s'assure que la distance de Damerau-Levenshtein entre deux libellés de substitution quelconques est d'au moins 3 (valeur par défaut du paramètre obfuscation_min_distance). En clair, cela signifie que, si vous donnez en examen un exercice de conversion en relationnel basé sur un tel MCD, les erreurs de transcription d'un étudiant stressé, inattentif, illettré, dyslexique, roublard, ou tout cela à la fois, ne vous empêcheront pas de retrouver son intention première. Par exemple, au cours du processus d'obfuscation suivant:

L'algorithme a écarté les mots dish (confusion possible avec wash), folk (confusion possible avec milk), peer (confusion possible avec ever), hall (confusion possible avec haul), baby (confusion possible avec lady).

5. Tracé d'un MCD

5.1. Insertion manuelle d'espacements

Le tracé réalisé par Mocodo pour des MCD de plusieurs rangées laisse parfois à désirer :

On voit que, par défaut, Mocodo centre les rangées qui contiennent moins de boîtes que les autres. Cela donne un bon résultat pour la première rangée, mais pas pour la troisième.

L'utilisateur peut cependant spécifier les espacements qu'il désire en complétant les rangées les moins fournies, par des boîtes invisibles dont le seul rôle est de « pousser » les autres à l'emplacement voulu. Ainsi, il va préciser que l'association Curae doit commencer sur la troisième colonne en insérant des lignes réduites au caractère deux-points, et en profiter pour insérer un espace entre Lorem et Tellus :

Il est possible de « compresser » les suites de deux-points en supprimant les retours-chariots, autrement dit, de remplacer $n$ lignes réduites à deux-points par une ligne réduite à une séquence de $n$ deux-points. Ce raccourci est illustré dans le prochain exemple.

5.2. Ajustement automatique dans une grille minimale

Nouveauté de la version 2.2. On cherche en général à faire tenir le MCD dans la plus petite grille possible, tout en maintenant un rapport « équilibré » entre hauteur et largeur. Par exemple, un MCD de 13 boîtes (entités ou associations) peut tenir dans les grilles:

• $13\times1$;
• $7\times2$, ce qui laisse 1 case vide;
• $5\times3$, ce qui laisse 2 cases vides;
• $4\times4$, ce qui laisse 3 cases vides;
• etc.

Les deux premières grilles étant non équilibrées, on retiendra la plus petite des suivantes, de dimensions $5\times3$.

La table ci-dessous énumère les dimensions des grilles minimales d'équilibre supérieur à 0,5 pour tous les MCD comportant moins de 100 boîtes:

On peut y vérifier par exemple que le MCD de taille 13 se trouve effectivement aux coordonnées (5, 3).

Avec l'option --fit, Mocodo est maintenant capable de reformater automatiquement un MCD pour le faire entrer dans la grille minimale correspondante:

L'algorithme se contente de supprimer ou d'insérer des sauts de ligne dans le texte-source, sans modifier l'ordre des clauses. On devra donc encore en général opérer sur le résultat un réarrangement automatique (voir plus loin).

Si ce réarrangement échoue ou laisse à désirer, il est possible de spécifier chacune des ièmes grilles suivantes avec l'option --fit=i:

Remarques.

• Quand le paramètre de --fit définit une grille trop grande, le réarrangement automatique retombe fréquemment sur une sous-grille de celle-ci.
• Dans Mocodo online, cliquer sur le bouton de réarrangement automatique enchaîne directement les opérations --fit et --arrange.

5.3. Basculement des cardinalités et inflexion des pattes rectilignes

Nouveauté de la version 2.1. Mocodo est capable de détecter certaines configurations de pattes dont les cardinalités présentent un risque élevé de collision. Il procède alors à deux types d'ajustements:

1. Issue 25. Les cardinalités d'une patte verticale ou horizontale sont envoyées de l'autre côté de la patte. Par exemple, dans le MCD ci-dessus, la présence de la patte oblique CONGUE-IPSUM envoie les cardinalités de CONGUE-METUS et CONGUE-DF à l'opposé de leur position par défaut (à droite d'une patte verticale ou en bas d'une patte horizontale).
2. Issue 27. Les pattes obliques sont infléchies de façon à ménager plus d'espace pour afficher deux couples de cardinalités. Ici, l'inflexion de la patte BLANDIT-VIVAMUS permet à ses cardinalités de coexister sans problème avec celles de l'association réflexive.

Ces ajustements automatiques résolvent les problèmes les plus courants. Toutefois, étant antérieurs au tracé proprement dit, ils peuvent seulement minimiser les risques de collision, et non les prévenir totalement. Ils peuvent même en produire d'autres. Ainsi, autour des entités particulièrement pattues, des collisions qui ne se seraient pas produites par défaut seront parfois observées. L'utilisateur a alors deux possibilités:

• modifier à la main les coordonnées des cardinalités en conflit, comme expliqué dans la section suivante;
• diminuer la valeur du paramètre --flex (par défaut, 0.75) pour réduire la courbure de l'inflexion automatique, en allant jusqu'à 0 pour la désactiver totalement (exemple).

5.4. Retouches fines

5.4.1. Par modification du script intermédiaire

Mocodo, au lieu de générer directement un dessin statique, génère d'abord un script Python, qui lui-même générera le dessin attendu. Cela se fait de façon transparente, sans intervention de l'utilisateur. L'avantage de cette couche supplémentaire est que le script intermédiaire exprime la plupart des positions, non en absolu, mais en relation à d'autres positions, peu nombreuses et qui constituent de fait les véritables paramètres du dessin. Sa capacité à évaluer des formules le rend beaucoup plus souple et puissant que si les valeurs résultantes étaient stockées en dur.

Le script intermédiaire s'appelle par défaut:

• sandbox_nodebox.py sur Mac OS X avec NodeBox 1.x installé ;
• sandbox_svg.py dans toutes les autres configurations.

Montrons comment retoucher le MCD suivant:

Si on ouvre le script intermédiaire avec un éditeur de texte, on verra que ses premières instructions exposent les principaux paramètres de position:

(width,height) = (384,233)
cx = {
    u"Velit"  :  192,
    u"Blandit":   47,
    u"Nonummy":  337,
    u"Vivamus":  192,
}
cy = {
    u"Velit"  :   35,
    u"Blandit":  112,
    u"Nonummy":  112,
    u"Vivamus":  189,
}
shift = {
    u"Velit,Blandit"  :    0,
    u"Velit,Nonummy"  :    0,
    u"Vivamus,Nonummy":    0,
    u"Vivamus,Blandit":    0,
}

• Un couple de dimensions width et height définit la taille du MCD;
• deux dictionnaires cx et cy, les abscisses et ordonnées des centres des boîtes;
• un dictionnaire shift, les positions relatives des cardinalités par rapport à leur position par défaut.

Voici les modifications que nous décidons d'apporter au fichier (ignorez la première ligne):

Sous Nodebox, il suffit alors de choisir Run dans le menu Python.

Si vous travaillez avec des fichiers SVG, il faut exécuter le script ..._svg.py. Il regénère alors le fichier SVG qui contient le dessin. Il ne reste plus qu'à l'ouvrir, par exemple avec un navigateur.

Les lignes suivantes (qu'il est inutile de comprendre) permettent de faire la même chose à l'intérieur de cette documentation.

Selon le même principe, on peut faire glisser les flèches le long des arcs (dictionnaire ratio) ou modifier les couleurs (dictionnaire colors).

Cette technique inhabituelle nous semble une application naturelle du dynamisme du langage Python. Mais c'est à vous de décider si vous êtes plus efficace en ajustant des valeurs numériques, ou en faisant glisser des objets dans votre cliquodrome favori, comme décrit dans la section suivante.

5.4.2. Par édition de la sortie au format SVG

Un fichier SVG peut être visualisé dans tout navigateur moderne.

Pour aller au-delà de la simple visualisation, il faudra faire appel à un logiciel de dessin vectoriel dédié, comme Inkscape (libre) ou Adobe Illustrator, Freehand, CorelDRAW, etc. Les éléments du fichier SVG produit pourront alors être repositionnés à la souris. Certains sont associés, pour permettre leur déplacement en bloc. Dans la version actuelle, les liens ne suivent pas ces déplacements, ce qui peut obliger à des manipulations supplémentaires.

5.5. Réarrangement par symétrie

Mocodo permet de calculer facilement le symétrique d'un MCD, par exemple celui donné ci-dessous:

Nouveauté de la version 2.0.20. Pour remplacer le texte de la cellule par le résultat de son évaluation, ajoutez l'option --replace.

5.5.1. Symétrie selon l'axe vertical