Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Общие команды в PlantUML

Откройте для себя основные команды, универсальные для всех типов диаграмм в PlantUML. Эти команды позволяют придать диаграммам многогранность и индивидуальность. Ниже мы разделим эти общие команды на три основные категории:

Глобальные элементы

Комментарии: Добавляют примечания или пояснения в сценарий диаграммы для передачи дополнительной информации или напоминания о необходимости дальнейших изменений.
Примечания: Включение дополнительной информации непосредственно в диаграмму для облегчения понимания или выделения важных аспектов.
Управление размерами: Настройте размеры различных элементов в соответствии с вашими предпочтениями, чтобы диаграмма получилась сбалансированной и пропорциональной.
Заголовок и подписи: Определите подходящий заголовок и добавьте подписи, чтобы прояснить контекст или аннотировать определенные части диаграммы.

Описание синтаксиса Creole

Используйте возможности синтаксиса Creole для дальнейшего форматирования содержимого любого элемента диаграммы. Этот стиль вики-разметки позволяет:

Форматирование текста: Настраивать внешний вид текста с помощью различных стилей и выравниваний.
Списки: Создавать упорядоченные и неупорядоченные списки для удобного представления информации.
Ссылки: Встраивать гиперссылки для быстрого перехода к нужным ресурсам.

Команда управления стилями

С помощью команды style можно полностью контролировать стиль представления элементов диаграммы. С ее помощью можно:

Определить стили: Задать единые стили для элементов, чтобы сохранить целостность визуальной темы.
Настроить цвета: Выбор определенных цветов для различных элементов для повышения визуальной привлекательности и создания четкой классификации.

Используйте эти команды для создания функциональных и эстетически привлекательных диаграмм, настраивая каждый элемент в соответствии с вашими требованиями.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Комментарии

Простой комментарий

Все записи начинающиеся с "одинарной кавычки" - это комментарии.

@startuml
'Для однострочного комментария используется одиночный апостроф
@enduml

Block comment

Block comment use C-style comments except that instead of * you use an apostrophe ', then you can also put comments on several lines using /' to start and '/ to end.

@startuml
/'
many lines comments
here
'/
@enduml

[Ref. QA-1353]

Then you can also put block comment on the same line, as:

[Ref. QA-3906 and QA-3910]

[Ref. GH-214]

WARNING

This translation need to be updated.

WARNING

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Zoom or Scale

You can use the scale command to zoom the generated image.

You can use either a number or a fraction to define the scale factor. You can also specify either width or height (in pixel). And you can also give both width and height: the image is scaled to fit inside the specified dimension.

scale 1.5
scale 2/3
scale 200 width
scale 200 height
scale 200*100
scale max 300*200
scale max 1024 width
scale max 800 height

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Title

The title keywords is used to put a title. You can add newline using \n in the title description.

Some skinparam settings are available to put borders on the title.

You can use creole formatting in the title.

You can also define title on several lines using title and end title keywords.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Caption

There is also a caption keyword to put a caption under the diagram.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Footer and header

You can use the commands header or footer to add a footer or a header on any generated diagram.

You can optionally specify if you want a center, left or right footer/header, by adding a keyword.

As with title, it is possible to define a header or a footer on several lines.

It is also possible to put some HTML into the header or footer.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Legend the diagram

The legend and end legend are keywords is used to put a legend.

You can optionally specify to have left, right, top, bottom or center alignment for the legend.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Appendix: Examples on all diagram

Activity

Archimate

Class

Component, Deployment, Use-Case

Gantt project planning

DONE

[(Header, footer) corrected on V1.2020.18]

Object

MindMap

Network (nwdiag)

Sequence

State

Timing

Work Breakdown Structure (WBS)

DONE

[Corrected on V1.2020.17]

Wireframe (SALT)

DONE

[Corrected on V1.2020.18]

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Appendix: Examples on all diagram with style

DONE

FYI:

all is only good for Sequence diagram
title, caption and legend are good for all diagrams except for salt diagram

FIXME

🚩

Now (test on 1.2020.18-19) header, footer are not good for all other diagrams except only for Sequence diagram.

To be fix; Thanks

FIXME

Here are tests of title, header, footer, caption or legend on all the diagram with the debug style:

<style>
title {
  HorizontalAlignment right
  FontSize 24
  FontColor blue
}

header {
  HorizontalAlignment center
  FontSize 26
  FontColor purple
}

footer {
  HorizontalAlignment left
  FontSize 28
  FontColor red
}

legend {
  FontSize 30
  BackGroundColor yellow
  Margin 30
  Padding 50
}

caption {
  FontSize 32
}
</style>