Extension:PlantUML/ru

Что это расширение позволяет делать ?
Это расширение позволяет использовать UML-диаграммы на страницах вики, используя простое текстовое описание.

Доступны следующие диаграммы:


 * Диаграмма последовательностей
 * Диаграмма прецедентов (use case diagram)
 * Диаграмма классов
 * Диаграмма деятельности
 * Диаграмма компонентов
 * Диаграмма состояний

Язык описан в этой документации (английский): Language Reference Guide.pdf

Использование
Просто вставьте описание модели на PlantUML между тегами.

Атрибуты

 * redraw
 * заставить диаграмму перерисовывать, удалив кэшированные изображения..

Пример 1
Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response

Пример 2
skinparam usecaseBackgroundColor DarkSeaGreen skinparam usecaseArrowColor Olive skinparam actorBorderColor black skinparam usecaseBorderColor DarkSlateGray skinparam usecaseActorFontName Courier

User << Human >>
 * Main Database: as MySql << Application >>

(Start) << One Shot >> (Use the application) as (Use) << Main >>

User -> (Start) User --> (Use) MySql --> (Use)

Пример 3
package "Classic Collections" #DDDDDD Object <|-- ArrayList

package net.sourceforge.plantuml Object <|-- Demo1 Demo1 *- Demo2

Установка
Расширение состоит из:
 * программы, которая генерирует изображения по их текстовому описанию, написанной на java (plantuml.jar)
 * скрипта на PHP для передачи данных и настроек из программы в Медиавики и обратно (PlantUML.php)

Загрузка

 * Код этого расширения доступен здесь.

Это расширение (hook) анализатора синтаксиса добавляет тег в разметку страницы для отображения UML-диаграмм. Сгенерированные изображения диаграмм встраиваются в вики-страницу.


 * Создайте каталог PlantUML в каталоге "Ваша_вики/extensions/"
 * Скопируйте в него файл PlantUML.php и plantuml.jar ( https://downloads.sourceforge.net/project/plantuml/plantuml.jar - отсюда)
 * Выберите тип использования. Вы можете обрабатывать изображения локально (на сервере, на котором был установлен MediaWiki) или в нашем облаке.
 * Локальная версия поддерживает SVG-изображения и встроенные ссылки за счет локальной обработки.
 * Облачная версия не нагружает сервер, но пока не поддерживает встроенный URL и генерирует только PNG-изображения. По умолчанию локальная обработка не включена. Если вы хотите использовать облака, установите переменную $usecloud=true в файле PlantUML.php.
 * Измените переменную $plantumlImagetype на желаемое значение. Имейте в виду, что SVG поддерживается только если вы используете jar-файл локально. Помните, что SVG производит превосходную графику, но только PNG-изображения отображаются всегда одинаково, независимо от программного обеспечения. Если вы используете облако, то оно всегда будет генерировать PNG изображение. Локальная обработка по умолчанию генерирует SVG.
 * Измените пути getUploadPath и getUploadDirectory в соответствии с вашими пожеланиями, если вы хотите изменить стандартные настройки MediaWiki.
 * Добавьте следующую строку в файл LocalSettings.php вашей MediaWiki для подключения расширения:
 * require_once('extensions/PlantUML/PlantUML.php');
 * При использовании облака убедитесь, что Ваш веб-сервер httpd может выдавать HTTP-запросы.

P.S. В Windows, вы должны разрешить чтение и выполнение для C:\Windows\system32\cmd.exe для PHP. PHP требует этих разрешений для передачи команды "fork" другим процессам.

См. также

 * Extension:UML делает то же самое с MetaUML.
 * Extension:GraphViz/ru
 * Extension:FreeMind/ru