Om een Mermaid-statusdiagram in Obsidian op een Mac te vereenvoudigen, houd je elke geldige overgang expliciet, verkort je de labels en test je de leesrichting. Vergelijk de bron, bestemming en overgangstekst voordat je het resultaat accepteert.
Deze handleiding gebruikt vier synthetische statussen, A tot en met D. Het doel is één diagram leesbaarder te maken en tegelijk de directe overgangen, retourpaden en begin- en eindmarkeringen te behouden. De overgangstabel biedt een concrete manier om dat behoud te controleren, onafhankelijk van hoe de renderer de pijlen positioneert.
Wat moet ongewijzigd blijven wanneer je het diagram vereenvoudigt?
Begin met het scheiden van wijzigingen in de presentatie van wijzigingen in het model. Kortere weergavelabels en een andere leesrichting kunnen de leesbaarheid verbeteren. Een pijl verwijderen verandert de verzameling directe overgangen, ook als een andere route nog steeds dezelfde bestemming bereikt.
Stel bijvoorbeeld dat er zowel een directe overgang bestaat van A naar C als een route via B. Als je de directe overgang verwijdert, moet de lezer afleiden dat er tussendoor een bezoek aan B plaatsvindt. De bereikbaarheid blijft behouden, maar een geldige overgang in één stap gaat verloren. Voor deze taak is het niet voldoende om uiteindelijk dezelfde bestemming te bereiken.
Gebruik de volgende overgangsinventaris als de oorspronkelijke specificatie. De labels zijn synthetische gebeurtenisnamen; ze hebben binnen dit voorbeeld betekenis en moeten aan hun oorspronkelijke pijlen gekoppeld blijven.
| Bron | Bestemming | Overgangstekst |
|---|---|---|
| Start | A |
Geen |
A |
B |
step |
A |
C |
alternate |
B |
C |
next |
B |
A |
reset |
C |
B |
back |
C |
A |
reset |
C |
D |
finish |
D |
End | Geen |
Er zijn negen overgangen, inclusief begin en einde. Twee pijlen hebben het label reset, maar vertrekken vanuit verschillende statussen. Behoud ze allebei. Ook de pijlen tussen B en C hebben verschillende richtingen en verschillende labels; het zijn afzonderlijke overgangen.
Noteer bij een groter diagram elke overgang vóór het bewerken als een combinatie van bron, bestemming en tekst. Als je oorspronkelijke tekst voorwaarden of acties bevat, behoud die dan ook. Alleen het totale aantal pijlen vergelijken kan niet vaststellen of een pijl een andere bestemming of een ander label heeft gekregen.
Controleer welke renderer jouw geïnstalleerde versie van Obsidian gebruikt
Open op je Mac Instellingen via het tandwiel in de zijbalk en selecteer vervolgens Algemeen. Noteer bovenaan de huidige applicatieversie en de versie van het installatieprogramma. Gebruik de applicatieversie om de relevante releaseopmerkingen op te zoeken. Deze locaties worden beschreven in de helpinformatie over de instellingen van Obsidian.
De renderer maakt verschil. De Desktop-release 1.15.0 voor vroege toegang van Obsidian, gedateerd op 22 oktober 2026, schakelt de diagramrendering over naar Pele en vermeldt compatibiliteit met de syntaxis van Mermaid 12.1.0. In de releaseopmerkingen staat ook dat deze versie de Mermaid-bibliotheek niet langer bevat. Die uitspraak geldt voor de genoemde release; ze geeft niet aan welke renderer in elke geïnstalleerde versie van Obsidian wordt gebruikt. Zie de releaseopmerkingen voor Obsidian 1.15.0 Desktop.
Controleer de compatibiliteit van de syntaxis en de visuele weergave afzonderlijk. Een diagram dat in een andere editor wordt geaccepteerd, is een nuttig vergelijkingspunt, maar controleer het eindresultaat in de applicatie die je hebt geïnstalleerd. Ga er niet van uit dat een upstream-lay-outinstelling of een nieuwer documentatievoorbeeld zich op dezelfde manier gedraagt in jouw lokale renderer.
Het onderstaande voorbeeld vermijdt bewust rendererconfiguratie, thema-instellingen en opmaak. Als je al een werkend diagram hebt, begin dan met de bestaande diagramdeclaratie en wijzig telkens één presentatieaspect. Een upgrade is niet nodig om alleen de overgangsinventaris en labellengtes aan te passen, zoals hier beschreven.
Maak een compacte versie met expliciete overgangen
Het volledige voorbeeld hieronder bevat alle negen rijen van de inventaris. De zichtbare namen van de statussen zijn bewust kort gehouden. Status A is het beginpunt, B en C hebben retourpaden en alleen D heeft een overgang naar de eindmarkering.
Mermaid documenteert statusaliassen, gelabelde overgangen, begin- en eindmarkeringen en de richtingsinstructie in de referentie voor statusdiagrammen. De gedocumenteerde manier om dit in Obsidian in te voegen is een codeblok met de taalidentificatie mermaid, zoals uitgelegd in Geavanceerde opmaaksyntaxis.
```mermaid
stateDiagram-v2
direction LR
state "Stage A" as A
state "Stage B" as B
state "Stage C" as C
state "Stage D" as D
[*] --> A
A --> B : step
A --> C : alternate
B --> A : reset
B --> C : next
C --> A : reset
C --> B : back
C --> D : finish
D --> [*]
```
Plak het volledige Markdown-voorbeeld, inclusief de openings- en sluitingsregels met drie backticks, in een notitie. Het buitenste codeblok met vier backticks dient hier alleen om het voorbeeld in dit artikel weer te geven; het hoort niet bij de inhoud van de notitie.
Gebruik Bronweergave om de exacte tekst te bekijken. Schakel over naar Leesweergave om het gerenderde resultaat te bekijken; op macOS wissel je met Cmd+E tussen lees- en bewerkingsweergave. Obsidian beschrijft deze bediening in Weergaven en bewerkingsmodus.
De overgangsregels zijn gegroepeerd op bronstatus, zodat je de uitgaande opties per status samen kunt bekijken. Deze indeling maakt de brontekst makkelijker te onderhouden; ze garandeert niet waar de renderer elke status zal plaatsen.
Probeer het voorbeeld op de breedte die je normaal voor notities gebruikt. Verwijder daarna alleen de regel direction LR en vergelijk het resultaat. Behoud de presentatie die vertakkingen en retourpaden het duidelijkst laat zien. Een diagram van links naar rechts kan meer horizontale ruimte vereisen, dus beoordeel het in het notitiepaneel zelf.
Verkort labels alleen zover als hun betekenis dat toelaat. In dit synthetische voorbeeld behoeft Stage B geen verdere uitleg. Behoud in je eigen diagram alle bewoordingen waarmee twee statussen van elkaar te onderscheiden zijn. Als een langere uitleg nodig is, zet die dan in een aangrenzende alinea en zorg voor een duidelijke koppeling met de statusidentificatie.
Welke snelkoppelingen kunnen het model veranderen?
Herhaalde pijlen kunnen je verleiden om een gedeelde tussenliggende knoop toe te voegen. Vraag je eerst af wat die knoop voorstelt en of de oorspronkelijke directe overgangen blijven bestaan.
Een gedeelde resetknoop verandert de directe paden
In de inventaris gaan B en C allebei rechtstreeks naar A bij reset. Vervang je die pijlen door paden via een nieuwe status met de naam R, dan voeg je een tussenliggende status toe en verwijder je de oorspronkelijke directe verbindingen. De lezer kan nog steeds een route naar A volgen, maar het diagram beschrijft nu andere stappen.
Voor het exacte resultaat in dit artikel behoud je de twee resetpijlen. De herhaling legt twee geldige startvoorwaarden voor dezelfde gebeurtenis vast. Hun visuele ruimte verkleinen is alleen nuttig als hun betekenis behouden blijft.
Een keuze of splitsing moet een reden hebben in het model
Mermaid documenteert <<choice>> voor vertakkingen tussen paden en <<fork>> en <<join>> voor splitsings- en samenvoegingsstructuren. Dit zijn afzonderlijke diagramconstructies in de referentie voor statusdiagrammen.
Voeg er niet zomaar een toe om een paar rommelige pijlen bij een gedeeld knooppunt samen te brengen. In dit voorbeeld moeten de directe overgangen tussen statussen behouden blijven. Een tussenliggende constructie toevoegen vereist een aparte uitleg van hoe de paden overeenkomen met het oorspronkelijke model. Met expliciete pijlen is die overeenkomst meteen duidelijk.
Samengestelde statussen hebben een gedocumenteerde grens
Mermaid ondersteunt samengestelde statussen, maar de documentatie staat uitdrukkelijk geen overgangen toe tussen interne statussen die tot verschillende samengestelde statussen behoren. Zie Samengestelde statussen.
Als je deze situatie krijgt door je knooppunten te groeperen, houd de verbonden statussen dan voor deze taak plat. Een pijl verplaatsen naar de buitenste samengestelde status verandert het eindpunt; het is niet automatisch een gelijkwaardige vervanging. Gebruik een hiërarchie als die de werkelijke structuur van het model weergeeft en je het in- en uitstapgedrag kunt uitleggen.
Voor het voorbeeld met vier statussen voegt nesten weinig toe. De nuttige vereenvoudiging bestaat uit kortere labels en een duidelijkere presentatie, terwijl de overgangsstructuur intact blijft.
Controleer zowel de overgangen als het gerenderde resultaat
Voer twee controles uit voordat je het oorspronkelijke diagram vervangt. De eerste controleert het model; de tweede kijkt of de gekozen presentatie prettig werkt.
- Vergelijk elke rij in de inventaris met een overgangsregel. Controleer beide eindpunten en het volledige label.
- Vergelijk elke overgangsregel terug met de inventaris. Zo ontdek je zowel ontbrekende als extra pijlen.
- Controleer begin en einde afzonderlijk. Hier leidt het begin alleen naar
A, en alleenDleidt naar het einde. - Bekijk het gerenderde diagram en controleer of de labels leesbaar zijn en de pijlpuntjes te onderscheiden zijn.
- Volg de retourpaden vanuit
BenC, omdat die makkelijk over het hoofd worden gezien wanneer je alleen de voortgang vooruit controleert.
Voer voor dit voorbeeld drie leescontroles uit: van het begin naar A, dan naar C, vervolgens naar D en dan naar het einde; van het begin naar A, vervolgens naar B en dan via reset terug naar A; en van het begin naar A, vervolgens naar C en dan terug naar B. Deze controles behandelen de alternatieve route, reset en terugwaartse verbinding. Ze vormen een aanvulling op de vergelijking met de rijen, maar vervangen die niet.
Een deterministische tekstvergelijking bevestigde dat de negen overgangsregels in het voorbeeld overeenkomen met de inventaris, inclusief hun labels. Het voorbeeld is tijdens de voorbereiding niet in een geïnstalleerde Obsidian-applicatie gerenderd, dus de uiteindelijke tussenruimte en de routing van pijlen moeten nog in jouw lokale versie worden gecontroleerd.
Als de notitie code letterlijk weergeeft, controleer dan eerst of je de notitie in Leesweergave bekijkt en of het openingscodeblok mermaid vermeldt. Krijg je na een bewerking een parseerfout, herstel dan het volledige voorbeeld en pas telkens één wijziging toe. Als alleen de lay-out onhandig is, behoud dan de overgangen en vergelijk de labellengte, richting en beschikbare paneelbreedte.
Behoud de versie waarvan de labels en paden het makkelijkst te lezen zijn, nadat de vergelijking met de inventaris is geslaagd. Een geslaagde vereenvoudiging zorgt ervoor dat de lezer dezelfde geldige overgangen met minder moeite kan volgen, terwijl de bron eenvoudig te bekijken en te onderhouden blijft.
Bronnen
- Statusdiagrammen — Mermaid
- Instellingen — Obsidian
- Obsidian 1.15.0 Desktop (Vroege toegang) — Obsidian
- Geavanceerde opmaaksyntaxis — Obsidian
- Weergaven en bewerkingsmodus — Obsidian