🧩
New! Render PlantUML diagrams directly inside GitHub with our official browser extension — No server. No tokens. No tracking. Zero permissions but clipboard. — Try it out and let us know what you think!

Salt (Wireframe)

Salt - это подпроект PlantUML, который может помочь вам в разработке графического интерфейса или Схема сайта или Схема страницы или Чертеж экрана.

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

Разработчики, дизайнеры и специалисты по работе с пользователями используют их для визуализации элементов интерфейса, навигационных систем и облегчения совместной работы. Они различаются по степени достоверности- от эскизов с низкой детализацией до высокодетальных изображений, что очень важно для создания прототипов и итеративного проектирования. Этот совместный процесс объединяет различные знания и опыт, от бизнес-анализа до исследования пользователей, обеспечивая соответствие конечного проекта требованиям бизнеса и пользователей.

Простые виджеты

Окно должно начинаться и заканчиваться скобками. Вы можете определить:

Цель этого инструмента - обсуждать простые и типовые окна.

WARNING
 This translation need to be updated. 
WARNING

Text area

Here is an attempt to create a text area:

Note:

[Ref. QA-14765]

Then you can add scroll bar:

Open, close droplist

You can open a droplist, by adding values enclosed by ^, as:

[Ref. QA-4184]

Использование сетки

Таблица автоматически создаётся, когда вы используете открывающую скобку {.

Ещё вам нужно использовать | для деления на колонки.

Например:

Сразу после открывающей скобки вы можете использовать символ, чтобы определить, где закончится строка и начнётся колонка сетки:

Symbol Result
# Чтобы показать вертикальные и горизонтальные линии
! Чтобы показать вертикальные линии
- Чтобы показать горизонтальные линии
+ Чтобы показать внешние линии

WARNING
 This translation need to be updated. 
WARNING

Группа

Виджеты могут быть объединены в группу со своим наименованием.

Используйте символ ^, следующий сразу после открывающей скобки {.

Наименование группы задается в кавычках " сразу после символа группы ^.

Использование разделителя

Вы можете использовать несколько горизонтальных линий как разделитель.

Древовидный виджет

Чтобы создать дерево, вам нужно начать с {T и использовать + чтобы определять иерархию.

Таблица дерева иерархии

Возможно придание таблицам древовидной (иерархической) структуры.

Таблица может не иметь границ, как в примере выше, либо иметь только вертикальные (T!), только горизонтальные (T-), внешние границы (T+) или все границы (T#). Используйте указанные параметры сразу после открывающей скобки {.

[Ref. QA-1265]

Окружающие скобки

Вы можете задать подэлементы, открывая новую скобку.

Добавление вкладок

Вы можете добавить вкладки, используя нотацию {/. Заметьте, что вы можете использовать HTML код для выделения текста жирным.

Вкладки также могут быть вертикально ориентированы:

Использование меню

Вы можете добавить меню используя нотацию {*.

Также можно открыть меню:

*[Ref. [QA-4184](https://forum.plantuml.net/4184)]*
WARNING
 This translation need to be updated. 
WARNING

Продвинутая таблица

Вы можете использовать две специальные нотации для таблиц :

Полосы прокрутки

Используйте параметр S, следующий сразу после открывающей скобки {, для добавления вертикальных (SI), горизонтальных (S-) или всех (S) полос прокрутки.

Цвет элементов

Изменяйте цвет текста в виджетах по аналогии с другими диаграммами.

Для этого поставьте код <color:ваш_цвет> перед текстом виджета.

[Ref. QA-12177]

Creole on Salt

You can use Creole or HTML Creole on salt:

Спрайты

Используя << и >> вы можете определить псевдо-графическое изображение (спрайт) и задать его имя, с помощью которого переиспользовать его в дальнейшем.

Спрайт представляет собой текстовое поле рамером 10 строк на 12 колонок, состоящее их пустых пикселей, задаваемых точкой (.), и заполненных пикселей, задаваемых сиволом X.

[Ref. QA-5849]

OpenIconic

OpenIconic is an very nice open source icon set. Those icons have been integrated into the creole parser, so you can use them out-of-the-box.

You can use the following syntax: <&ICON_NAME>.

The complete list is available on OpenIconic Website, or you can use the following special diagram:

Add title, header, footer, caption or legend

(See also: Common commands)

Zoom, DPI

Whitout zoom (by default)

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.

(See also: Zoom on Common commands)

DPI

You can also use the skinparam dpicommand to zoom the generated image.

Include Salt "on activity diagram"

You can read the following explanation.

It can also be combined with define macro.

Include salt "on while condition of activity diagram"

You can include salt on while condition of activity diagram.

[Ref. QA-8547]

Include salt "on repeat while condition of activity diagram"

You can include salt on 'repeat while' condition of activity diagram.

[Ref. QA-14287]

Skinparam

You can use [only] some skinparam command to change the skin of the drawing.

Some example:

FIXME
🚩 FYI, some other skinparam does not work with salt, as:

Style

You can use [only] some style command to change the skin of the drawing.

Some example:

FIXME
🚩 FYI, some other style does not work with salt, as:

[Ref. QA-13460]