Documentazione
Tutto quello che fa Vellnar Diagrams, un compito per sezione, nell’ordine in cui lo incontri.
Ultimo aggiornamento
Aggiungere un diagramma a una pagina
- Modifica una pagina di Confluence e scrivi
/mermaiddove vuoi il diagramma. - Seleziona Mermaid diagram. Si apre l’editor con l’elenco dei modelli.
Scegli un modello, oppure Start blank e scrivi il tuo codice. Poi scegli Save: il diagramma compare nella pagina.
Per cambiarlo in seguito, modifica la pagina, seleziona il diagramma e apri l’editor dalla barra della macro.
Partire da un modello
Il pulsante Templates apre 72 punti di partenza per documenti veri: runbook, decisioni di architettura, post-mortem, piani di rilascio e altro. Sono raggruppati per tipo di diagramma in cinque gruppi, da Core engineering ad Analysis, UX & strategy.
- Cerca per nome, tipo o documento, per esempio “runbook”.
- Scegli un tipo di diagramma per vedere solo i suoi modelli. Seleziona un modello per vederne l’anteprima e quante righe di codice ha.
- Scegli Use template. Se l’editor contiene già un diagramma, l’app chiede prima di sostituirlo.
Scrivere e modificare il codice
L’editor mostra il codice Mermaid a sinistra e l’anteprima a destra. L’anteprima segue ogni tasto.
- Il codice. Hide code in alto a sinistra dà tutta la finestra all’anteprima; il divisore tra i pannelli si trascina.
- Templates apre l’elenco dei modelli.
- Save mette il diagramma nella pagina. Cancel chiude l’editor senza salvare.
- Impostazioni del diagramma, esportazione e aiuto.
- Zoom, adatta, cambia direzione, ricerca e meeting mode.
Quando una riga ha un errore
- L’editor segna la riga con l’errore.
- Il messaggio indica la riga e cosa si aspettava Mermaid. Copy details for support copia l’errore e il tuo codice, pronti da incollare in una richiesta di supporto.
- L’anteprima tiene l’ultimo diagramma valido finché non correggi la riga.
Cercare nel codice e nel diagramma
- Scrivi in Search code and diagram, oppure premi ⌘F (Ctrl F su Windows e Linux).
- I risultati si illuminano insieme nel codice e nel diagramma. Invio passa al risultato successivo.
Premi R sull’anteprima per cambiare la direzione di un flowchart, di un diagramma di stati, di classi o ER, per esempio da sinistra-destra ad alto-basso.
L’app disegna più di 30 tipi di diagramma con Mermaid 12.3, tra cui flowchart, diagrammi di sequenza, classi, stati ed ER, Gantt, mappe mentali, timeline, C4, architetture, Sankey e mappe di Wardley. La documentazione di Mermaid descrive la sintassi di ogni tipo.
Impostazioni del diagramma
Apri Diagram settings nell’editor per cambiare l’aspetto del diagramma e la sua posizione nella pagina.
- Il pulsante Diagram settings.
- Le impostazioni, descritte qui sotto.
- Theme: Default, Neutral, Forest o Mermaid classic. I colori scritti nel codice restano come sono; Why do some colors stay the same? elenca quelle righe. Ogni tema segue la modalità chiara o scura di Confluence.
- Look: Classic per linee pulite, Hand-drawn per bozze e workshop.
- Alignment: Center o Left, per i diagrammi più stretti della pagina.
- Size: Fit width rimpicciolisce i diagrammi larghi alla pagina; Actual size li tiene leggibili e li fa scorrere di lato.
- PDF size: One page mette tutto il diagramma in una pagina; Actual size lo tiene leggibile al 100% e può occupare più pagine.
Cronologia delle versioni
Ogni salvataggio conserva il codice precedente.
- Seleziona lo stato accanto al titolo, per esempio Edited 2 hours ago, per aprire Version history.
- Seleziona una versione per vederne l’anteprima.
- Restore this version la mette nell’editor. Nulla viene salvato finché non scegli Save.
L’app conserva le ultime dieci versioni salvate, compresa quella attuale, fino a circa 200 KB di codice in totale.
Trovare i diagrammi con la ricerca di Confluence
Le parole del codice del diagramma sono indicizzate con la pagina. Cerca in Confluence un servizio, una tabella o un’etichetta e la pagina con il diagramma compare nei risultati. Una modifica diventa cercabile dopo il salvataggio successivo della pagina.
Vedere, presentare ed esportare
Nella pagina, due pulsanti compaiono accanto al diagramma quando ci passi sopra con il puntatore.
- Il pulsante in alto è Open fullscreen, anche ⌘↵ (Ctrl ↵ su Windows e Linux). Quello sotto è Export, lo stesso menu dell’editor.
- Zoom, adatta allo schermo, ricerca e meeting mode.
- Esportazione e aiuto.
La ✕ in alto a destra, oppure Esc, chiude lo schermo intero.
- A schermo intero, trascina o usa le frecce per spostarti, più e meno per lo zoom, 0 o Spazio per adattare, 1 per la dimensione reale e F per cercare nelle etichette.
- Meeting mode (M) trasforma il puntatore in un puntatore laser per le presentazioni.
- Export scarica il diagramma come SVG (vettoriale) o PNG (alta risoluzione), oppure lo copia come immagine, come codice SVG o come codice Mermaid. Lo stesso menu è nell’editor:
- Il pulsante Export.
- Scarica come SVG o PNG, oppure copia come immagine, come codice Mermaid o come codice SVG.
Esportazioni PDF e Word
Quando Confluence esporta la pagina in PDF, il diagramma è un’immagine vettoriale nitida, dimensionata dall’impostazione PDF size. Word non sa mostrare queste immagini, quindi un’esportazione Word contiene il codice del diagramma. Un diagramma molto grande può essere troppo grande per un’immagine nelle esportazioni; l’editor ti avvisa prima di salvare, e l’esportazione mostra il codice.
Scorciatoie da tastiera
Premi ? nell’editor o a schermo intero per vedere tutte le scorciatoie.
Le più usate:
| Azione | Scorciatoia |
|---|---|
| Salva | ⌘S / Ctrl S |
| Cerca nel codice e nel diagramma | ⌘F / Ctrl F |
| Mostra o nascondi il codice | ⌘B / Ctrl B |
| Apri a schermo intero dalla pagina | ⌘↵ / Ctrl ↵ |
| Zoom avanti, zoom indietro | + e − |
| Adatta allo schermo | 0 o Spazio |
| Zoom al 100% | 1 |
| Cerca nel diagramma | F |
| Cambia la direzione del diagramma | R |
| Meeting mode | M |
Limiti
- Un diagramma può avere fino a 100.000 caratteri di codice e 500 collegamenti. Vicino al limite l’editor mostra il conteggio; oltre, dividi il diagramma in diagrammi più piccoli.
Licenza
Atlassian vende l’app con 30 giorni di prova gratuita. Se la licenza scade, ogni diagramma resta visibile nella sua pagina e si può ancora aprire a schermo intero ed esportare; si ferma solo la modifica. L’editor offre allora Copy a message for your admin, un testo pronto che chiede a un amministratore di Confluence di rinnovare la licenza.
Permessi e dati
L’app non chiede nessun permesso e tiene ogni diagramma dentro la sua pagina. I dettagli sono nelle pagine sicurezza e privacy.