Que fait archimaid ?
Archimaid ajoute ArchiMate 3.2 à Mermaid en tant que type de diagramme archimate-beta. Écrivez des diagrammes en texte brut, vérifiez-les avec la CLI archimaid et générez des SVG.
Workflow
- Décidez des éléments et relations ArchiMate nécessaires à la vue. Modélisez la signification avec les types d'éléments et les relations, pas avec des notes.
- Écrivez le diagramme dans un fichier
.mmdou dans un blocmermaiddélimité par des triples backticks dans du Markdown. - Validez-le et corrigez chaque erreur, puis validez à nouveau :
Utiliseznpx --yes archimaid validate chemin/vers/diagramme.mmd-pour valider l'entrée standard. Les problèmes s'affichent au formatfichier:ligne:colonne: message. Les avertissements commencent parwarning:et n'empêchent pas l'exécution. - Vérifiez qu'ArchiMate 3.2 autorise chaque relation entre ses types source et cible (Annexe B). Le validateur ne vérifie pas encore cela.
- Générez un SVG lorsque l'hôte cible ne peut pas charger le plugin, comme GitHub Markdown (voir Rendu).
Syntaxe
Commencez par archimate-beta et placez une déclaration par ligne.
archimate-beta
direction LR
accTitle: Gestion des commandes
accDescr: La suite de gestion des commandes contient un composant de facturation.
element applicationComponent suite "Suite de gestion des commandes" {
element applicationComponent facturation "Facturation"
}
description facturation "Gère la facturation."
click facturation href "https://wiki.example.com/facturation" "Ouvrir le runbook de facturation"
suite *-- facturation
note review "Confirmer le comportement de relance" on suite
- Éléments :
element <type> <id> "Nom". Les 60 clés de type (businessProcess,applicationComponent,node, …) sont listées dans references/reference.md. Consultez ce fichier dès que vous n'êtes pas sûr d'une clé. - IDs : uniques, commencent par une lettre ou un tiret bas, et contiennent des lettres, chiffres, tirets bas et traits d'union.
- Chaînes de caractères : guillemets doubles au style JSON, jamais vides. Utilisez
\npour un saut de ligne. Les longs noms s'enroulent automatiquement. - Accessibilité : ajoutez toujours
accTitle:. AjoutezaccDescr:ouaccDescr { … }pour plusieurs lignes. - Frontmatter : un bloc YAML en tête entre des lignes
---est autorisé, par exempleconfig: { theme: dark }.
Relations
Forme raccourcie : <source> <connecteur> <cible>, avec optionnellement : "Étiquette". L'extrémité gauche est toujours la source du modèle.
| Connecteur | Relation |
|---|---|
*-- | composition |
o-- | agrégation |
@==> | affectation |
..|> | réalisation |
--> | desserte |
.. / <.. / ..> / <..> | accès : non spécifié / lecture / écriture / lectureÉcriture |
-.-> | influence |
--- / --/ | association : non dirigée / dirigée |
==> | déclenchement |
-.=> | flux |
--|> | spécialisation |
gérer <.. commandesignifie gérer lit commande : l'accesseur est à gauche.- Un ID au début d'une instruction n'est jamais interprété comme le glyphe
o--. Écrivezo o-- b, paso--b. - Ne répétez pas une ligne raccourcie identique.
- Forme longue :
relationship <type> <id> <source> -> <cible>, suivi optionnellement deaccess read|write|readWrite|unspecifiedoudirected, puislabel "Texte". Utilisez la forme longue lorsqu'une autre déclaration doit référencer l'ID de la relation.
Imbrication
- Déclarez les enfants à l'intérieur de
element … {et}, chacun sur sa propre ligne. Les blocs s'imbriquent et peuvent contenir des éléments, des descriptions, des relations, des notes,nestetclick, mais pas les paramètres du diagramme. - L'imbrication n'a pas besoin de relation. Lorsqu'exactement une relation parent-enfant supporte l'imbrication, le bloc la représente et sa ligne est masquée. La composition, l'agrégation, l'affectation, la réalisation et l'accès pointent du parent vers l'enfant. La spécialisation pointe de l'enfant vers le parent.
nest <enfant> in <parent> [via <idRelation>]est la forme en ligne. Utilisezvialorsque plusieurs relations pourraient supporter l'imbrication. Chaque enfant a un parent visuel unique, et l'imbrication ne doit pas former de cycle.
Notes et liens
note <id> "Texte"déclare une note autonome. Ajoutezon <idElement>pour l'attacher à un élément. Les notes peuvent être des extrémités de relation.click <id> href "<url>" ["Infobulle"] [_blank|_self|_parent|_top]lie un élément. Les URL doivent être http, https, mailto ou relatives. Sans infobulle, le survol affiche ladescription.
Disposition
- Par défaut, ou
layout architecture: couches de haut en bas (Stratégie, Métier, Application, Technique et Physique, Implémentation & Migration), avec la Motivation en haut près de ce à quoi elle se connecte. Préférez cette option pour les vues multi-couches. layout framework: les mêmes couches, avec des colonnes fixes Structure Passive, Comportement et Structure Active, et la Motivation à droite.layout graph, oudirection TB|BT|LR|RLseul : placement guidé par les relations. Préférez cette option pour les petites vues monocouche et les chaînes.
Hors champ
Les jonctions, les relations comme extrémités, les figures alternatives, les points de vue et l'échange de modèles ne sont pas supportés. N'inventez pas de syntaxe pour eux. Dites-le et utilisez la construction supportée la plus proche.
Rendu
Le rendu nécessite Playwright Chromium dans le projet :
npm install --save-dev archimaid mermaid playwright
npx playwright install chromium
npx archimaid render diagramme.mmd diagramme.svg --theme default --background theme
Pour les hôtes qui n'enregistrent pas le plugin (GitHub, GitLab), placez le fichier source .mmd à côté du SVG et intégrez le SVG : .
Pour une page web, enregistrez le plugin avec Mermaid 12.3 ou ultérieur :
import mermaid from 'mermaid';
import { archimate } from 'archimaid';
mermaid.initialize({ startOnLoad: false, securityLevel: 'strict' });
await mermaid.registerExternalDiagrams([archimate]);
Pour vérifier rapidement la syntaxe avec l'utilisateur, pointez-le vers le playground navigateur : https://try.archimaid.org
Exemples
references/examples.md contient trois diagrammes complets et valides :
- Gestion des commandes : affectation, réalisation, desserte et accès en lecture
- Relations multi-couches : disposition architecture avec traitement des réclamations imbriqué
- Composants imbriqués : composition, notes attachées et autonomes, flux inter-domaines