Multilingual Wiki Documentation

You are currently using syntax.

In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc Recent changes

a_begin_for_this_wiki

◼ A begin for this wiki...
◼ For starting
◼ Issues: *"If you see something, say something"*
◼ Improve Documentation
◼ Mini TOC

activity-diagram-beta

◼ 活动图(新语法)
◼ 简单活动图
◼ 开始/结束
◼ 条件语句
◼ Conditional with stop on an action [kill, detach]
◼ 重复循环
◼ Break on a repeat loop [break]
◼ while循环
◼ 并行处理
◼ Split processing
◼ 注释
◼ 颜色
◼ Lines without arrows
◼ 箭头
◼ 连接器(Connector)
◼ Color on connector
◼ 组合(grouping)
◼ 泳道(Swimlanes)
◼ 分离(detach)
◼ 特殊领域语言(SDL)
◼ 一个完整的例子
◼ Condition Style
◼ Condition End Style

activity-diagram-legacy

ant-task

api

archimate-diagram

ascii-art

ascii-math

board-diagram

◼ Board diagram
◼ Basic component

bpmn

◼ Business Process Model and Notation (BPMN)
◼ Final examples
◼ Existing diagrams
◼ Syntax
◼ Example1
◼ Example2
◼ Example3
◼ Other theorical works

class-diagram

code-groovy

◼ Groovy API Client Code

code-javascript-asynchronous

◼ Javascript API Client Code

code-javascript-synchronous

◼ Javascript API Client Code

code-php

◼ PHP API Client Code
◼ Installing with Composer

color

command-line

commons

◼ 通用命令
◼ 注释
◼ 缩放
◼ 标题
◼ 图片标题
◼ 页眉和页脚
◼ 图例说明
◼ Appendix: Examples on all diagram
◼ Appendix: Examples on all diagram with style

component-diagram

◼ 组件图
◼ 组件
◼ 接口
◼ 基础的示例
◼ 使用注释
◼ 组合组件
◼ 改变箭头方向
◼ Use UML2 notation
◼ 使用UML1标记符
◼ Use rectangle notation (remove UML notation)
◼ 长描述
◼ 不同的颜色表示
◼ 在定型组件中使用精灵图
◼ 显示参数
◼ Specific SkinParameter
◼ Hide or Remove unlinked component

creole

◼ Creole
◼ Emphasized text
◼ Lists
◼ Escape character
◼ Horizontal lines
◼ Headings
◼ Legacy HTML
◼ Code
◼ Table
◼ Tree
◼ Special characters
◼ OpenIconic
◼ Appendix: Examples of "Creole List" on all diagrams
◼ Appendix: Examples of "Creole horizontal lines" on all diagrams
◼ Style equivalent (between Creole and HTML)

dedication

◼ Dedication
◼ Example
◼ Why?
◼ How?

deployment-diagram

◼ 部署图
◼ 声明元素
◼ Declaring element (using short form)
◼ 链接
◼ Bracketed arrow style
◼ Change arrow color and style (inline style)
◼ Change element color and style (inline style)
◼ Nestable elements
◼ 包装
◼ Alias
◼ 圆角
◼ Specific SkinParameter
◼ Appendix: All type of arrow line
◼ Appendix: All type of arrow head or '0' arrow
◼ Appendix: Test of inline style on all element
◼ Appendix: Test of style on all element

developers

◼ Language
◼ Syntax check

ditaa

doclet

docutils

◼ Docutils (Install)
◼ Usage

donors

◼ Special thanks to our sponsors and donors

dot

◼ Generalisation
◼ DOT

doxygen

◼ Doxygen

eclipse

◼ Information about the PlantUML Eclipse Plugin
◼ How to use it?
◼ How to install it?
◼ How to improve it?

emacs

eps

◼ EPS
◼ EPS Support

external-links

faq

faq-install

font

◼ Font
◼ Examples

formatting

ftp

◼ File Transfer Protocol
◼ Example of Transfer

gantt-diagram

◼ Gantt Diagram
◼ Declaring tasks
◼ One-line declaration (with the and conjunction)
◼ Adding constraints
◼ Short names
◼ Customize colors
◼ Completion status
◼ Milestone
◼ Hyperlinks
◼ Calendar
◼ Coloring days
◼ Changing scale
◼ Close day
◼ Definition of a week depending of closed days
◼ Simplified task succession
◼ Separator
◼ Working with resources
◼ Complex example
◼ Comments
◼ Using style
◼ Add notes
◼ Pause tasks
◼ Change link colors
◼ Tasks or Milestones on the same line
◼ Highlight today
◼ Task between two milestones
◼ Grammar and verbal form
◼ Add title, header, footer, caption or legend on gantt diagram
◼ Removing Foot Boxes (example for all scale)

gfm-support

graphviz-dot

gui

◼ PlantUML GUI

handwritten

◼ Handwritten diagram style

ie-diagram

index

◼ PlantUML 简介

index-full

◼ PlantUML 简介

issues

javadoc

◼ New Doclet
◼ Legacy Javadoc

jquery

json

latex

link

menu

◼ Translation of the menus

mindmap-diagram

notes

nwdiag

◼ Network diagram (nwdiag)
◼ Simple diagram
◼ Define multiple addresses
◼ Grouping nodes
◼ Extended Syntax (for network or group)
◼ Using Sprites
◼ Using OpenIconic
◼ Same nodes on more than two networks
◼ Peer networks
◼ Peer networks and group
◼ Add title, caption, header, footer or legend on network diagram
◼ Change width of the networks
◼ Other internal networks

object-diagram

openiconic

◼ OpenIconic

oregon-trail

◼ The Oregon Trail
◼ Let's play

patreon-support

◼ Why crowdfunding?
◼ Patreon

pdf

◼ PDF Support
◼ Make it work

picoweb

◼ PlantUML PicoWeb Server
◼ Running the server

plantuml-text-encoding

◼ PlantUML Text Encoding

plantumlshell

◼ Beta implementation
◼ Variable definition
◼ Conditions
◼ Void function
◼ Return function
◼ Default argument value
◼ First Round Of Brainstorming
◼ Objectives
◼ Return function
◼ Void function
◼ Visibility scope of variables
◼ Data types and arithmethic expressions
◼ Allowed function and variable names
◼ Builtin functions

pmwiki

poll-about-package-and-namespace

poll-about-wiki-syntax

◼ Vote for your syntax!

preprocessing

◼ 预处理
◼ 迁移说明
◼ 定义变量
◼ Boolean expression
◼ 条件
◼ While loop [!while, !endwhile]
◼ 空函数
◼ 返回函数
◼ 参数默认值
◼ 非引号函数
◼ Keywords arguments
◼ Including files or URL [!include, !include\_many, !include\_once]
◼ Including Subpart [!startsub, !endsub, !includesub]
◼ Builtin functions [%]
◼ Logging [!log]
◼ Memory dump [!memory_dump]
◼ Assertion [!assert]
◼ Building custom library [!import, !include]
◼ Search path
◼ Argument concatenation [##]
◼ Dynamic invocation [``%invoke_procedure()``, ``%call_user_func()``]
◼ Evaluation of addition depending of data types [+]
◼ Preprocessing JSON

preprocessing-json

preprocessing-v2

problem-diagram

◼ Problem diagram
◼ Example R1
◼ Example R1-1
◼ Example R1-2
◼ Example LiveBox
◼ Example of Composition of two designed domains
◼ Example of Problem

professional

◼ Professional usage

pte

◼ PlantUML Text Encoding

salt

◼ Salt（线框图）
◼ 基本部件
◼ 使用表格
◼ 分组框
◼ 使用分隔符
◼ 树形外挂
◼ Tree table [T]
◼ Enclosing brackets [{, }]
◼ 添加选项卡
◼ 使用菜单
◼ 高级表格
◼ Scroll Bars [S, SI, S-]
◼ Colors
◼ Pseudo sprite [<<, >>]
◼ OpenIconic
◼ Include Salt "on activity diagram"
◼ Include salt "on while condition of activity diagram"

security

sequence-diagram

server

skinparam

◼ Skinparam 命令
◼ 使用
◼ 内嵌
◼ 黑白 (Black and White)
◼ Shadowing
◼ 颜色翻转 (Reverse colors)
◼ 颜色 (Colors)
◼ 字体颜色、名称、大小 (Font color, name and size)
◼ 文本对齐 (Text Alignment)
◼ Examples
◼ 所有skinparam的参数列表 (List of all skinparam parameters)

smetana02

◼ The context (of Smetana project)
◼ Beta version

sources

◼ How and where diagrams can be written
◼ File naming

sprite

start

starting

state-diagram

◼ 状态图
◼ 简单状态
◼ Change state rendering
◼ 合成状态
◼ 长名字
◼ History [[H], [H*]]
◼ Fork [fork, join]
◼ 并发状态
◼ Conditional [choice]
◼ Stereotypes full example [choice, fork, join, end]
◼ Point [entryPoint, exitPoint]
◼ Pin [inputPin, outputPin]
◼ Expansion [expansionInput, expansionOutput]
◼ 箭头方向
◼ Change line color and style
◼ 注释
◼ Note on link
◼ 更多注释
◼ Inline color
◼ 显示参数
◼ Changing style
◼ Change state color and style (inline style)

statistics-report

stdlib

◼ Standard Library
◼ List of Standard Library
◼ ArchiMate [archimate]
◼ AWS library [aws]
◼ Amazon Labs AWS Library [awslib]
◼ Azure library [azure]
◼ C4 Library [C4]
◼ Cloud Insight [cloudinsight]
◼ Cloudogu [cloudogu]
◼ Elastic library [elastic]
◼ Google Material Icons [material]
◼ Kubernetes [kubernetes]
◼ Logos [logos]
◼ Office [office]
◼ Open Security Architecture (OSA) [osa]
◼ Tupadr3 library [tupadr3]

steve

◼ Steve Jobs, 1955 - 2011

style-evolution

style-evolution-history

sudoku

◼ Have a break: resolve a Sudoku...

svek

◼ Current architecture : Svek

svg

syntax-asciidoc

syntax-dokuwiki

syntax-markdown

teoz

text-encoding

timing-diagram

undocumented

unicode

use-case-diagram

◼ 用例图
◼ 用例
◼ 角色
◼ 改变角色的样式
◼ 用例描述
◼ 使用包
◼ 基础示例
◼ 继承
◼ 使用注释
◼ 构造类型
◼ 改变箭头方向
◼ 分割图示
◼ 从左向右方向
◼ 显示参数
◼ 一个完整的例子
◼ Business Use Case
◼ Change arrow color and style (inline style)
◼ Change element color and style (inline style)

using-a-citation-manager

versioning-scheme

vizjs

wbs-diagram

what-is-a-software-modeling-tool

◼ Modeling Tool

wire-diagram

◼ Wire or Block Diagram
◼ Basic component
◼ Local reference
◼ Arrows
◼ Print texts
◼ Full example
◼ Suggestions and ideas about the new 1.2020.24 syntax
◼ Wanted features or examples of expecting syntax
◼ Attempt to reproduce the full example
◼ Remark after first use...

word

◼ Word Add-in

xearth

◼ Earth Day
◼ XEarth
◼ Add more stars
◼ Relative view from Sun
◼ Change grid configuration
◼ Fixed position, without shading
◼ View from Moon and changing luminosity
◼ View set by orbit and changing luminosity
◼ Zooming
◼ Adding cities

xmi

◼ XML Metadata Interchange (XMI)

yaml

◼ Display YAML Data
◼ Complex example
◼ Specific key (with symbols or unicode)
◼ Highlight parts
◼ Using (global) style

a_begin_for_this_wiki

activity-diagram-beta

activity-diagram-legacy

archimate-diagram

code-javascript-asynchronous

code-javascript-synchronous

component-diagram

deployment-diagram

mindmap-diagram

patreon-support

plantuml-text-encoding

poll-about-package-and-namespace

poll-about-wiki-syntax

preprocessing-json

preprocessing-v2

problem-diagram

sequence-diagram

statistics-report

style-evolution

style-evolution-history

syntax-asciidoc

syntax-dokuwiki

syntax-markdown

use-case-diagram

using-a-citation-manager

versioning-scheme

what-is-a-software-modeling-tool

Please report any bugs to plantuml@gmail.com or here.

This website is still in beta testing.