Otwiera się w nowej karcie

Sharp Diagrams: diagramy Mermaid w Confluence i Jirze

Pisz diagramy jako tekst i otrzymuj ostre rysunki, które można powiększać, na stronach Confluence i w zgłoszeniach w Jirze. Dwie aplikacje, po jednej dla każdego produktu, wkrótce w Atlassian Marketplace.

Przeczytaj dokumentację (po angielsku)Wsparcie (po angielsku)Schemat blokowy Mermaid narysowany przez Sharp Diagrams na stronie Confluence

Czym jest Sharp Diagrams?

Sharp Diagrams rysuje diagramy Mermaid z tekstu: w Confluence jako makro na stronie, a w Jirze w panelu zgłoszenia. Mermaid to format tekstowy do zapisywania schematów blokowych, diagramów sekwencji, wykresów Gantta i innych diagramów.

Są dwie aplikacje z tym samym silnikiem diagramów. Sharp Diagrams – Mermaid for Confluence dodaje makro diagramu z edytorem i podglądem na żywo. Sharp Diagrams – Mermaid for Jira rysuje w panelu bloki kodu mermaid z opisu zgłoszenia. Zainstaluj aplikację do produktu, którego używasz, albo obie.

Żadne dane nie opuszczają Atlassian. Aplikacje działają na platformie Forge firmy Atlassian, nie mają połączeń zewnętrznych i nie przechowują niczego własnego: kod diagramu zostaje na Twojej stronie Confluence lub w zgłoszeniu w Jirze.

Jak dodać diagram Mermaid w Confluence i w Jirze?

Wszystkie typy diagramów i ich składnię opisuje dokumentacja Mermaid: mermaid.js.org (po angielsku).

Confluence

  1. Edytuj stronę, wpisz /mermaid i wybierz Mermaid diagram.
  2. Napisz kod Mermaid po lewej stronie albo wybierz szablon w Start from.
  3. Podgląd po prawej odświeża się w trakcie pisania. Jeśli w kodzie jest błąd, komunikat i numer wiersza pojawiają się pod kodem.
  4. Wybierz Save i opublikuj stronę. Aby później zmienić diagram, edytuj stronę, zaznacz diagram i kliknij przycisk edycji (ołówek).

Jira

  1. W opisie zgłoszenia dodaj blok kodu, ustaw jego język na mermaid i wpisz w nim kod diagramu.
  2. Otwórz zgłoszenie i wybierz Mermaid diagrams z przycisku aplikacji pod tytułem zgłoszenia. Od tej pory panel pozostaje w zgłoszeniu.
  3. Każdy blok kodu mermaid w opisie staje się w panelu osobnym diagramem. Po zmianie opisu wczytaj zgłoszenie ponownie, aby zobaczyć nowy diagram.

Funkcje

Podgląd na żywo podczas pisania

Pisz kod Mermaid po lewej i oglądaj diagram po prawej. Przy błędzie widać komunikat i numer wiersza, a ostatni poprawny diagram pozostaje widoczny.

Szablony 11 typów diagramów

Schemat blokowy, diagram sekwencji, klas, stanów, ER i Gantta, mapa myśli, oś czasu, wykres kołowy, ścieżka użytkownika i graf Git. Edytor pyta, zanim szablon zastąpi Twój własny kod.

Ostre diagramy w odpowiednim rozmiarze

Diagramy są rysowane jako SVG na szerokość strony lub panelu i pozostają ostre po powiększeniu. Bardzo szeroki diagram jest zmniejszany najwyżej do 75 %, aby tekst pozostał czytelny.

Powiększanie, pobieranie i kopiowanie

Powiększaj od 50 % do 300 % i ponownie dopasuj diagram do szerokości. Pobierz go jako SVG lub jako PNG w podwójnym rozmiarze do prezentacji i dokumentów albo skopiuj jego kod.

Diagramy z opisu zgłoszenia w Jirze

Każdy blok kodu mermaid w opisie staje się osobnym diagramem, więc jedno zgłoszenie może zawierać na przykład schemat blokowy i diagram sekwencji. Inne bloki kodu pozostają bez zmian.

Tryb jasny i ciemny

Diagramy dostosowują się do trybu kolorów Confluence i Jiry. W trybie ciemnym są rysowane w ciemnym motywie Mermaid.

Eksport do PDF i Worda

Confluence tworzy eksporty na swoich serwerach, gdzie diagramu nie da się narysować, dlatego eksport zawiera kod diagramu. Aby umieścić rysunek w dokumencie, pobierz go jako PNG lub SVG.

Dane zostają w Atlassian

Bez połączeń zewnętrznych i bez własnego magazynu danych. W Jirze panel odczytuje opis z uprawnieniami osoby, która ogląda zgłoszenie, więc pokazuje tylko to, co ta osoba i tak może zobaczyć.

Cennik

Do 10 użytkowników

Bezpłatnie.

100 użytkowników

250 USD rocznie.

Cena dotyczy każdej aplikacji osobno. Rozliczenia prowadzi Atlassian. Ceny dla innej liczby użytkowników będą widoczne w Atlassian Marketplace po opublikowaniu aplikacji. Klienci korzystający z bezpłatnego planu otrzymują takie samo wsparcie jak klienci płacący.

Zrzuty ekranu

Edytor diagramów w Confluence: kod Mermaid po lewej i podgląd na żywo po prawejSchemat blokowy na stronie Confluence z paskiem narzędzi do powiększania, pobierania i kopiowania koduSzablon Gantta wybrany w edytorze diagramówBlok kodu mermaid w opisie zgłoszenia w Jirze i narysowany z niego diagram w panelu Mermaid diagramsPasek narzędzi panelu w Jirze i diagram powiększony do 125 %Dwa diagramy z opisu jednego zgłoszenia w Jirze: diagram sekwencji i diagram stanów

Najczęściej zadawane pytania

Ile kosztuje Sharp Diagrams?
Do 10 użytkowników aplikacja jest bezpłatna. Dla 100 użytkowników cena wynosi 250 USD rocznie. Cena dotyczy każdej aplikacji osobno, a rozliczenia prowadzi Atlassian.

Czy potrzebuję obu aplikacji?
Nie. Aplikacja do Confluence rysuje diagramy na stronach Confluence, a aplikacja do Jiry – z opisów zgłoszeń w Jirze. Zainstaluj aplikację do produktu, którego używasz, albo obie.

Jakie typy diagramów obsługuje Sharp Diagrams?
Typy diagramów Mermaid, na przykład schematy blokowe, diagramy sekwencji, klas, stanów, ER i Gantta, mapy myśli, osie czasu, wykresy kołowe, ścieżki użytkownika i grafy Git. Edytor w Confluence ma szablony dla tych 11 typów.

Jak dodać diagram do zgłoszenia w Jirze?
Dodaj do opisu zgłoszenia blok kodu z językiem mermaid i otwórz w zgłoszeniu panel Mermaid diagrams. Każdy blok kodu mermaid staje się osobnym diagramem. Po zmianie opisu wczytaj zgłoszenie ponownie, aby zobaczyć nowy diagram.

Czy diagramy trafiają do eksportu PDF i Word?
Eksport zawiera kod diagramu jako blok kodu z informacją, że rysunek jest na stronie. Confluence tworzy eksporty na swoich serwerach, gdzie diagramu nie da się narysować. Aby umieścić rysunek w dokumencie, pobierz go jako PNG lub SVG.

Czy jakieś dane opuszczają Atlassian?
Nie. Aplikacje działają na platformie Forge firmy Atlassian i nie mają połączeń zewnętrznych. Nie przechowują niczego własnego: kod diagramu zostaje na stronie Confluence lub w zgłoszeniu w Jirze.

Czy linki i HTML w diagramach są wykonywane?
Nie. Diagramy są rysowane w przeglądarce osoby, która je ogląda, ze ścisłym poziomem bezpieczeństwa Mermaid (strict), więc linki, obsługa kliknięć i HTML w diagramach nie są wykonywane.

Co się dzieje, gdy licencja nie jest aktywna?
Diagram nie jest rysowany. Zamiast niego wyświetla się jego kod, więc żadna treść nie ginie.

Wsparcie i warunki

Wsparcie: support@hdsoft.fi, od poniedziałku do piątku w godz. 9:00–17:00 czasu fińskiego, po angielsku i po fińsku. Czas odpowiedzi i zgłaszanie problemów bezpieczeństwa opisano na stronie wsparcia (po angielsku).

Dokumentacja: jak skonfigurować Sharp Diagrams i z niego korzystać (po angielsku).

Prywatność: polityka prywatności (po angielsku).

Warunki i inne aplikacje: Aplikacje do Jiry i Confluence.

Wkrótce w Atlassian Marketplace

Sharp Diagrams pojawi się w Confluence Cloud i Jira Cloud przez Atlassian Marketplace. Dokumentacja już teraz pokazuje, jak działa.

Przeczytaj dokumentację (po angielsku)

Atlassian, Jira i Confluence są znakami towarowymi firmy Atlassian. Aplikacje tworzy i wspiera HD SofT.