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    View page history    Add new chapter    Reorder page    Raw


Undocumented PlantUML features

Page for list of Undocumented PlantUML features in order to document

Undocumented PlantUML features in order to document

The list comes from Issue#261 thanks to @VladimirAlexiev,

And the list of Issue#261 comes mostly from QA#7095, QA#7140 thanks to @Anthony-Gaudino, and was complemented, categorized, and converted to a task list by @VladimirAlexiev.

Then the list is here in order to put, after each item:
  • DONE
  • TODO
  • BUG
  • deprecated
  • SEE
  • or
    TBC
and to follow and share the state of new documentation to produce.

Preprocessor, Includes, Sectioning

preprocessing-v2 (old) & preprocessing (new)

  • QA#6577 Ability to include blocks ("subsections") of code
  • QA#7838 !pragma http.proxyHost
  • QA#6289 %filename% and %filenameNoExtension%
  • QA#6199 %PLANTUML_VERSION%
    deprecated
    SEE
    New Builtin functions %version()
  • QA#5968 %filedate%
  • QA#5769 %filename% and %dirpath% variables
    deprecated
    SEE
    New Builtin functions
  • QA#5171 Boolean not ! and parenthesis on !ifdef
    DONE
    superseded by %not()
    SEE
    QA#12320
  • QA#3868 Use tilde ~ to escape @startuml
  • QA#5483 @startuml filename for automatic extensions
  • QA#4467 @startuml with identifier for includes
  • QA#1466 @startuml{OPTIONS}
  • QA#4596 \startXXX instead of @startXXX
  • QA#5769 @startdef and @enddef
  • QA#1525, QA#5793 @pause @unpause
  • QA#1525 @pause @unpause @continue @append and /' ... '/ multiline comments
  • QA#4266 -config parameter
  • QA#2410 Multiple include paths
  • QA#7337 Tags to include individual pieces
  • QA#7337 remove / restore
  • wildcards in remove / hide / restore, eg remove *

Running and Output

Command-line

ASCII art output with -ttxt or -tutxt

  • QA#4147 skinparam maxAsciiMessageLength

LaTeX output with -tlatex through Tikz

  • QA#1798 latex-tikz-support anything more to document?
  • Latex "see result online" (eg https://www.writelatex.com/read/pgkkspzgzgpb) doesn't work because need to migrate to overleaf
  • QA#6495 skinparam tikzFont
  • QA#3558 Latex link [[latex://]]

SVG output with -tsvg
DONE

  • QA#5453 skinparam pathHoverColor
    DONE
  • QA#7334 skinparam svgDimensionStyle
    DONE

Layout

Text and Links

Creole, Link, ASCII Math, JLatexMath

  • QA#3104 Use \ for multiline stuff
  • QA#3055 Align text with \l and \r
  • QA#3601 Creole on class titles with as
  • Issues#104 skinparam wrapWidth and skinparam wrapMessageWidth
  • QA#3820 skinparam tabSize
  • QA#5254 <plain>...</plain> to remove default text style (eg skinparam classFontStyle)
  • QA#5574 tooltip over link
    DONE
    Page link

Images, Icons, Sprites, Shapes, Embellishments

Color

Arrows

  • QA#3636 Arrows from/to class members
    DONE
  • QA#3621 Component diagram consumer/provider arrows
  • make sure all arrow params are documented: dotted|dashed|plain|bold|hidden|norank|single|thickness|left|right|up|down, color
  • QA#3816 skinparam ArrowColor, stereotyped arrows, new syntax for inline arrow style (Setting multiple arrow skinparams in one line);
    deprecated
    (componentArrowColor is deprecated)
  • QA#4949 Inline setting for edge style and thickness
    DONE
    on Class and Deployment
  • QA#4260 bold and plain arrow styles
  • QA#4181 bold, dashed, dotted
  • Make sure all arrow types are documented on one page: See arrows and arrows-2 at github.com/anoff/blog/tree/master/static/assets/plantuml/diagrams
  • QA#1736 Multiple lollipop edge styles
    DONE
  • QA#5261 Crows foot edge
  • QA#2259 Class diagram --( and -0)- arrows
    DONE
  • QA#310 Sequence diagram ?-> and ->? arrows
    DONE

Mixed and Embedded Diagrams

  • QA#2335 allow_mixing vs mix_usecase mix_actor...
  • QA#375 Embed SVG in SVG diagram
  • QA#2427 Embed SALT UI diagrams in notes and other texts ("Flowchat")
    DONE
    See Salt

Alternative Layoters

  • QA#4436, QA#5336, smetana02 !pragma graphviz_dot jdot: replace graphviz with Java code
  • vizjs -graphvizdot vizjs: replace graphviz with JavaScript code
  • noditaa: replace ditaa with java code

Class Diagrams

  • QA#5835 Notes on class fields
    DONE
  • QA#3054 details on how the "attributes" vs "methods" boxes are formed, and what happens when you add your own divider line
  • QA#2913 Hide private / protected / package class members
  • QA#3448 Tree structure inside class
    DONE
    See creole tree
  • QA#3424 Class attribute stereotype
  • QA#2259 Class diagram circle
  • QA#2239 extends and implements can reference multiple nodes
  • QA#3193 skinparam groupInheritance to merge inheritance arrows going to the same parent
  • QA#1638 package style card
    DONE
    TBC

Component Diagrams

  • QA#11052 remove @unlinked components;
    DONE
    TBC
    for other diagramm
  • QA#11052 component tags and hide/remove/restore $tag

Sequence Diagrams

teoz, sequence-diagram#anchors_and_duration, tag/teoz: new Teoz (vs old Puma) for sequence diagrams

  • QA#4247 hide unlinked participants
    DONE
  • QA#7119 %autonumber%
  • QA#8511 autonumber inc
  • QA#2794 skinparam lifelineStrategy
    DONE
  • QA#2503 Secondary group label in sequence diagram
    DONE
  • QA#7264 skinparam belowForResponse
    DONE
  • QA#1047 skinparam style strictuml: emits triangle rather than sharp arrow heads
    DONE
  • QA#3482, QA#206 skinparam sequenceMessageAlign

Activity Diagrams

  • QA#5201 skinparam swimlaneWidth
    BUG
    See QA#12463
  • QA#2681 Swimlane alias
  • QA#4470 Label of arrows of repeat loops (repeat while)
  • QA#6105 Activity diagram break
    DONE
  • QA#301 Activity Beta if (...) is/equals (...) then
    DONE
  • QA#265 Activity Beta kill
    DONE
  • QA#3931 !pragma useVerticalIf on: draw if/elseif/else structure vertically
    DONE
  • QA#1626 Activity diagram GOTO
  • QA#2792 skinparam activityArrowFontSize
  • QA#3166 skinparam activityArrowFontColor
  • QA#5346 Activity diagram joinspec
  • QA#2868 Activity diagram multiple halting states
  • QA#3505 Activity diagram end
    DONE
  • QA#5826 Backward on loops
  • QA#4906 Gradient color on activity diagram partition
  • QA#2398 Note on partition
  • QA#2793 Inline coloring of partition
  • QA#1290 skinparam conditionStyle: inside (hexagon: default), foo1 (big diamond), diamond (tiny diamond)
    DONE
  • QA#6010 skinparam arrowMessageAlign center
  • QA#4411 skinparam colorArrowSeparationSpace: multiple parallel arrows in activity digrams
  • QA#3770 Background color of alt/group

State Diagrams
DONE

  • QA#1159 State diagram <<choice>>, <<fork>>, <<join>>, <<end>>
    DONE
  • QA#3672 State Diagram <<choice>>
    DONE
  • QA#10077 Colored connectors in state diagrams
    DONE
  • QA#1159 Choice Pseudostate in State Diagrams
    DONE
  • QA#1099 State diagram hide empty description
    DONE
  • QA#4309 State diagram <<expansionInput>> and <<expansionOutput>>, <<inputPin>> and <<outputPin>>, <<entrypoint>> and <<exitpoint>>
    DONE
  • QA#1812 State inline color
    DONE

SDL and ER/IE Diagrams
DONE

SALT (UI) Diagrams
DONE

search?q=salt, tag/salt

Timing Diagrams

  • QA#5776 Timing diagram coloring
    DONE

Gantt Charts
DONE

  • QA#5782 Arrow on Gantt Diagram
    DONE
  • QA#5510 Gantt diagram dates
    DONE

BPMN Diagrams
DONE

  • QA#5647 BPMN (@startbpm and @endbpm)
    DONE
    Page BPMN updated

MindMap Diagrams

WBS Diagrams

Work Breakdown Structures, Organizational Breakdown Structures (organigrams)

Graphviz Diagrams (DOT)

  • QA#4210 When using Dot, PlantUML supports strict graph and digraph
  • QA#1206 Dot graph

Not yet categorized


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.