Commands

  1. skinparam COLOR STYLE
    1. skinparam monochrome true
    2. skinparam monochrome reverse
    3. skinparam handwritten true
    4. Both lines handwritten and monochrome can be used together.
    5. rectanglebackgroundcolor white
    6. notebordercolor green
    7. Arrowcolor
    8. nodesep 100 : To separate nodes
  2. skinparam SHADOW STYLE
    1. skinparam shadowing false
  3. – : Draw a line
    1. -[hidden]–> : Draw a hidden line
    2. -right–> : Left to right arrow from one object to another
    3. .. [Double dots] : Dashed line
    4. -[dashed]- : Dashed line
    5. cp1 -[#black]down-> im : Choose color while drawing an arrow
  4. Objects:
    1. () : Draw a circle
      1. () “TEXT” as ALIAS
    2. rectangle : Draw a rectangle
      1. rectangle “Intermediary” as im #Gold : Rectangle in color gold
    3. actor
      1. actor “Sad User” as user
    4. participant
      1. Rectangular block of participant
    5. boundary
    6. artifact
    7. control
    8. entity
    9. database
    10. collections .
  5. title : Title text2. ove diagram
  6. caption : Caption below the diagram “\n” used sometimes to create gap between the diagram and the caption.
  7. like tags used inside text to slant text.
  8. note
    1. note DIRECTION of ANY_OBJECT “TEXT”
  9. scale
    1. scale 800 width: to scale image size to 800 width
  10. direction
    1. left to right direction: To specify the flow of arrows for ease of use later.
  11. together
    1. together{ block1 block2 } : To show some blocks together as a group.
  12. Comments
    1. ’ [Quote] : For single line comment
    2. /’ [Slash + Quote] : For multi line comment
  13. Description to arrows
    1. Object1 -> Object2 : TEXT ==> For giving comments to arrows
  14. listopeniconic
    1. This command shows all icons that can be used in plantuml. e.g. cloud, code etc.
    2. <&code> <&pie-chart> are some examples of how to use them.
  15. colors
    1. List all available colors
  16. Text formatting
    1. * * : For bold
    2. // / / : For italics
    3. "" "" : For monospaced
    4. – – : For stroked
    5. _ _ _ _ : For underline
    6. ~ ~ ~ ~ : For waved
  17. Numbered list:
    1. # for item. # # for subitem and so on.
  18. Unnumbered list:
    1. * for item. * * for subitem and so on.
  19. ~ is used as escape for formatting characters.
  20. = TEXT : For heading 1
  21. == TEXT : For heading 2 and so on.
  22. Trees can be made, legacy HTML can be used to create objects and more to go.

Examples

References

https://github.com/mattjhayes/PlantUML-Examples/blob/master/README.md