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) анализатора синтаксиса (Parser) добавляет тег в разметку страницы для отображения UML-диаграм. Сгенерированные изображения диаграм встраиваются в вики страницу


 * Созайте каталог PlantUML в каталоге "Ваша_вики/extensions/"
 * Скопируйте в него файл PlantUML.php и plantuml.jar ( https://downloads.sourceforge.net/project/plantuml/plantuml.jar - отсюда)
 * Выберите тип использования. Вы можете обрабатывать изображения локально (на сервере, на котором был установлен MediaWiki) или в нашем облаке.
 * Локальная версия поддерживает SVG-изображения и встроенные ссылки, за счет локальной обработки.
 * Облако версии не нагружает сервер сервера, но пока не поддерживает встроенный URL и генерирует только PNG-изображения. По умолчанию локальной обработки не включена. Если вы хотите использовать облака, пожалуйста в файле PlantUML.php и установите переменную $usecloud=true.
 * Изменить переменную $plantImagetype с вашими предпочтениями. Имейте в виду, что SVG поддерживается только если вы используете jar-файл локально. Помните, что SVG производит превосходную графику, но это только PNG-изображений и изображений карты "rock solid". Если вы используете облако, он всегда будет генерировать 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