Where is the PlantUML language documented?

Question

Hi, I'm trying to learn PlantUML, and I'm looking for a reference document for the language.  I see many examples on the PlantUML.com homepage, in the Drawing UML with PlantUML PDF document, and in The Hitchhiker's Guide.  But I'm not finding a reference that would explain what the content of the examples mean line by line.  There is so much going on in the examples there's no way to figure out what part of the example causes what part of the corresponding image except by trial and error, and even if I get past the errors I'm still only guessing that I understand correctly.

E.g., if I look at the first example of a Class Diagram, I see two words on the first line, but what do they mean?  Is the first word the text that goes into the image? Is it describing the a shape?  Is it a keyword?  In different examples I see special characters, parentheses, brackets, dollar signs and more.  Where can I look up what each one means?

I don't see any explanation of how PlantUML decides whether it's creating a class diagram, or a sequence diagram or something else.  It seems to be processing things line by line, but what everything means I have no idea.

Is there a document that describes the PlantUML language syntax such that I could read any PlantUML file and know what it means in terms of the generated diagram?  Thanks!!

Answer 1

Hi,

I find out this program just yesterday so I can tell you only my experience.

Plantuml is huge, and he use a lot of other libraries/tool  that expands his language.

In two days I recreate an old sequence diagram reading the istructions in the sequence diagram page, starting by simple commands (participants and request/retuned messages ) and adding the commands I discovered in the page: the result is an excellent  quality diagram comparing othes I met in the past.

In few word, I think that the right way is choose the diagram you really need, and focus on it.

Per example, I will use it only for this diagram type because for other diagrams I'll use other (for me) simple tools.

Answer 2

I happended found PlantUML some months ago and feel it's extremely great for let me doing Diagram by Code.

The published reference guide is nice and worth to take time to learn in detail, so I started to record my learning experience which now in half way.

You can find my work - PlantUML in Action - that put on Udemy and check whether you can get some references for your diagraming and modeling:

https://www.udemy.com/course/plantuml-in-action/?referralCode=D34C45B9FC7D631C0196

Hope that can help.

Xiaoqi

Answer 3

I'm afraid you're right - Plantuml is a 'learn by example' application, there's no 'proper' manual with EBNF and every option described in detail.  I guess that's because there are just to many options that such an approach would be overwhelming.  Instead, you scan the PDF for something similar to what you want, and adapt it.