در زبانهٔ جدید باز می‌شود

Sharp Diagrams: نمودارهای Mermaid برای Confluence و Jira

نمودار را به‌صورت متن بنویسید و در صفحه‌های Confluence و تیکت‌های Jira تصویری واضح و قابل بزرگ‌نمایی بگیرید. دو اپلیکیشن، یکی برای هر محصول، که به‌زودی به Atlassian Marketplace می‌آیند.

خواندن مستندات (به انگلیسی)پشتیبانی (به انگلیسی)فلوچارت Mermaid که Sharp Diagrams در یک صفحهٔ Confluence رسم کرده است

Sharp Diagrams چیست؟

Sharp Diagrams نمودارهای Mermaid را از متن رسم می‌کند: در Confluence به‌صورت ماکرو در صفحه و در Jira در یک پنل داخل تیکت. Mermaid یک قالب متنی برای نوشتن فلوچارت، نمودار توالی، نمودار گانت و نمودارهای دیگر است.

دو اپلیکیشن با یک موتور نمودار مشترک وجود دارد. Sharp Diagrams – Mermaid for Confluence یک ماکروی نمودار با ویرایشگر و پیش‌نمایش زنده اضافه می‌کند. Sharp Diagrams – Mermaid for Jira بلوک‌های کد mermaid در توضیحات تیکت را در یک پنل رسم می‌کند. اپلیکیشن محصولی را که استفاده می‌کنید نصب کنید، یا هر دو را.

هیچ داده‌ای از Atlassian خارج نمی‌شود. این اپلیکیشن‌ها روی پلتفرم Forge شرکت Atlassian اجرا می‌شوند، اتصال خارجی ندارند و چیزی از خودشان ذخیره نمی‌کنند: کد نمودار در صفحهٔ Confluence یا تیکت Jira شما می‌ماند.

چطور در Confluence و Jira نمودار Mermaid اضافه کنم؟

همهٔ انواع نمودار و نحوهٔ نوشتن آن‌ها در مستندات خود Mermaid آمده است: mermaid.js.org (به انگلیسی).

Confluence

  1. یک صفحه را ویرایش کنید، /mermaid را تایپ کنید و Mermaid diagram را انتخاب کنید.
  2. کد Mermaid را در سمت چپ بنویسید یا از Start from یک قالب انتخاب کنید.
  3. پیش‌نمایش سمت راست هم‌زمان با تایپ به‌روز می‌شود. اگر کد خطا داشته باشد، پیام خطا و شمارهٔ خط زیر کد نمایش داده می‌شود.
  4. Save را انتخاب کنید و صفحه را منتشر کنید. برای تغییر نمودار در آینده، صفحه را ویرایش کنید، نمودار را انتخاب کنید و دکمهٔ ویرایش (مداد) را بزنید.

Jira

  1. در توضیحات تیکت یک بلوک کد اضافه کنید، زبان آن را mermaid بگذارید و کد نمودار را در بلوک بنویسید.
  2. تیکت را باز کنید و از دکمهٔ اپلیکیشن‌ها زیر عنوان تیکت، Mermaid diagrams را انتخاب کنید. از آن به بعد پنل در تیکت می‌ماند.
  3. هر بلوک کد mermaid در توضیحات به یک نمودار جداگانه در پنل تبدیل می‌شود. بعد از تغییر توضیحات، تیکت را دوباره بارگذاری کنید تا نمودار جدید را ببینید.

امکانات

پیش‌نمایش زنده هنگام تایپ

کد Mermaid را در سمت چپ بنویسید و نمودار را در سمت راست ببینید. در صورت خطا، پیام و شمارهٔ خط نمایش داده می‌شود و آخرین نمودار سالم همچنان دیده می‌شود.

قالب برای 11 نوع نمودار

فلوچارت، نمودار توالی، کلاس، حالت، موجودیت-رابطه و گانت، نقشهٔ ذهنی، خط زمانی، نمودار دایره‌ای، سفر کاربر و نمودار Git. ویرایشگر پیش از آنکه قالب جای کد خودتان را بگیرد، از شما می‌پرسد.

نمودار واضح در اندازهٔ مناسب

نمودارها به‌صورت SVG و هم‌عرض صفحه یا پنل رسم می‌شوند و هنگام بزرگ‌نمایی واضح می‌مانند. نمودار خیلی عریض فقط تا 75 % کوچک می‌شود تا متن آن خوانا بماند.

بزرگ‌نمایی، دانلود و کپی

از 50 % تا 300 % بزرگ‌نمایی کنید و نمودار را دوباره با عرض هماهنگ کنید. نمودار را با فرمت SVG، یا با فرمت PNG در اندازهٔ دوبرابر برای اسلاید و سند، دانلود کنید یا کد آن را کپی کنید.

نمودار از توضیحات تیکت Jira

هر بلوک کد mermaid در توضیحات یک نمودار جداگانه می‌شود، پس یک تیکت می‌تواند مثلاً یک فلوچارت و یک نمودار توالی داشته باشد. اپلیکیشن به بلوک‌های کد دیگر دست نمی‌زند.

حالت روشن و تیره

نمودارها از حالت رنگی Confluence و Jira پیروی می‌کنند. در حالت تیره با تم تیرهٔ Mermaid رسم می‌شوند.

خروجی PDF و Word

Confluence خروجی‌ها را روی سرورهای خودش می‌سازد که آنجا نمی‌توان نمودار را رسم کرد، بنابراین خروجی شامل کد نمودار است. برای قرار دادن تصویر در سند، آن را با فرمت PNG یا SVG دانلود کنید.

داده‌ها در Atlassian می‌مانند

بدون اتصال خارجی و بدون فضای ذخیره‌سازی اختصاصی. در Jira پنل توضیحات را با دسترسی‌های همان کسی که تیکت را می‌بیند می‌خواند، پس فقط چیزی را نشان می‌دهد که آن فرد از قبل می‌تواند ببیند.

قیمت‌گذاری

تا 10 کاربر

رایگان.

100 کاربر

250 دلار آمریکا در سال.

قیمت برای هر اپلیکیشن جداگانه است. صورت‌حساب‌ها را Atlassian مدیریت می‌کند. قیمت سطوح دیگر تعداد کاربران پس از انتشار اپلیکیشن‌ها در Atlassian Marketplace نمایش داده می‌شود. مشتریان طرح رایگان همان پشتیبانی‌ای را می‌گیرند که مشتریان پولی می‌گیرند.

تصاویر صفحه

ویرایشگر نمودار در Confluence: کد Mermaid در سمت چپ و پیش‌نمایش زنده در سمت راستفلوچارت در یک صفحهٔ Confluence همراه با نوار ابزار بزرگ‌نمایی، دانلود و کپی کدقالب گانت انتخاب‌شده در ویرایشگر نموداربلوک کد mermaid در توضیحات تیکت Jira و نموداری که از آن در پنل Mermaid diagrams رسم شده استنوار ابزار پنل Jira و نمودار با بزرگ‌نمایی 125 %دو نمودار از توضیحات یک تیکت Jira: نمودار توالی و نمودار حالت

پرسش‌های متداول

هزینهٔ Sharp Diagrams چقدر است؟
تا 10 کاربر رایگان است. برای 100 کاربر قیمت 250 دلار آمریکا در سال است. قیمت برای هر اپلیکیشن جداگانه است و صورت‌حساب‌ها را Atlassian مدیریت می‌کند.

آیا به هر دو اپلیکیشن نیاز دارم؟
نه. اپلیکیشن Confluence نمودارها را در صفحه‌های Confluence رسم می‌کند و اپلیکیشن Jira آن‌ها را از توضیحات تیکت‌های Jira. اپلیکیشن محصولی را که استفاده می‌کنید نصب کنید، یا هر دو را.

Sharp Diagrams از چه نوع نمودارهایی پشتیبانی می‌کند؟
از انواع نمودارهای Mermaid، مثلاً فلوچارت، نمودار توالی، کلاس، حالت، موجودیت-رابطه و گانت، نقشهٔ ذهنی، خط زمانی، نمودار دایره‌ای، سفر کاربر و نمودار Git. ویرایشگر Confluence برای این 11 نوع قالب دارد.

چطور به یک تیکت Jira نمودار اضافه کنم؟
به توضیحات تیکت یک بلوک کد با زبان mermaid اضافه کنید و پنل Mermaid diagrams را در تیکت باز کنید. هر بلوک کد mermaid یک نمودار جداگانه می‌شود. بعد از تغییر توضیحات، تیکت را دوباره بارگذاری کنید تا نمودار جدید را ببینید.

آیا نمودارها در خروجی PDF و Word می‌آیند؟
خروجی شامل کد نمودار به‌صورت بلوک کد است، همراه با یادداشتی که می‌گوید تصویر در صفحه است. Confluence خروجی‌ها را روی سرورهای خودش می‌سازد که آنجا نمی‌توان نمودار را رسم کرد. برای قرار دادن تصویر در سند، آن را با فرمت PNG یا SVG دانلود کنید.

آیا داده‌ای از Atlassian خارج می‌شود؟
نه. این اپلیکیشن‌ها روی پلتفرم Forge شرکت Atlassian اجرا می‌شوند و اتصال خارجی ندارند. چیزی از خودشان ذخیره نمی‌کنند: کد نمودار در صفحهٔ Confluence یا تیکت Jira شما می‌ماند.

آیا لینک‌ها و HTML داخل نمودارها اجرا می‌شوند؟
نه. نمودارها در مرورگر بیننده با سطح امنیتی سخت‌گیرانهٔ Mermaid (strict) رسم می‌شوند، بنابراین لینک‌ها، کنترل‌کننده‌های کلیک و HTML داخل نمودارها اجرا نمی‌شوند.

اگر مجوز فعال نباشد چه می‌شود؟
نمودار رسم نمی‌شود و به‌جای آن کدش نمایش داده می‌شود، بنابراین هیچ محتوایی از بین نمی‌رود.

پشتیبانی و شرایط

پشتیبانی: support@hdsoft.fi، دوشنبه تا جمعه ساعت 9:00 تا 17:00 به وقت فنلاند، به زبان انگلیسی و فنلاندی. زمان پاسخ‌گویی و گزارش‌های امنیتی در صفحهٔ پشتیبانی (به انگلیسی) آمده‌اند.

مستندات: نحوهٔ راه‌اندازی و استفاده از Sharp Diagrams (به انگلیسی).

حریم خصوصی: سیاست حفظ حریم خصوصی (به انگلیسی).

شرایط و اپلیکیشن‌های دیگر: اپلیکیشن‌ها برای Jira و Confluence.

به‌زودی در Atlassian Marketplace

Sharp Diagrams به‌زودی از طریق Atlassian Marketplace برای Confluence Cloud و Jira Cloud عرضه می‌شود. مستندات از همین حالا نشان می‌دهد چطور کار می‌کند.

خواندن مستندات (به انگلیسی)

Atlassian، Jira و Confluence علامت‌های تجاری Atlassian هستند. این اپلیکیشن‌ها را HD SofT ساخته است و پشتیبانی می‌کند.