Инструменты пользователя

Инструменты сайта


// AsciiDoc и PlantUML

AsciiDoc - язык разметки и утилита для генерации, из этой самой разметки, документов самых разных форматов: Unix man pages, HTML, PDF, OpenOffice и т.п. (список поддерживаемых форматов можно расширить модулями). При этом текст разметки напоминает некоторые WiKi (типа той же DokuWiki) и остаётся читабельным даже без компиляции в какой либо выходной формат. Часто используется для приготовления документации к продуктам.

PlantUML - тоже язык разметки, и тоже текстовый, для генерации различных UML диаграмм.

Резонный вопрос: как бы их скрестить. Помогает модульность AsciiDoc, в частности фильтры. В скором времени находим уже готовое решение: http://code.google.com/p/asciidoc-plantuml/

Устанавливается просто:

  1. скачиваем файл plantuml.zip
  2. натравливаем на него команду:
    asciidoc --filter install plantuml.zip

Либо, для пользователей ArchLinux, ипользуем пакет из AUR: https://aur.archlinux.org/packages/asciidoc-plantuml

После чего, в тело документа можно вставлять такие блоки:

[plantuml]
------
User -> (Start)
User --> (Use the application) : Polish label-Zażółć gęślą jaźń

:Main Admin: ---> (Use the application) : This is\nyet another\nlabel
------

И оно заменится картинкой с диаграммой.

Под катом снимок экрана редактора asciidoc-gui с предпросмотром диаграммы.

Комментарии