Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on how to use Lay_D, Lay_U etc #74

Closed
ppoluha opened this issue Oct 26, 2020 · 4 comments
Closed

Documentation on how to use Lay_D, Lay_U etc #74

ppoluha opened this issue Oct 26, 2020 · 4 comments
Milestone

Comments

@ppoluha
Copy link

ppoluha commented Oct 26, 2020

I often find it hard to get the layout I want and I see in your examples that you use "layout commands", such as Lay_D and Lay_U. Could you please add a few lines in the documentation on how to use these and how to think about how to order the elements (ie should I use Rel_R or Lay_R, for example).

@adrianvlupu
Copy link
Member

adrianvlupu commented Nov 28, 2020

Rel_R actually adds a relationship arrow between the elements and serves the same purpose of a normal Rel but tells plantUML that the arrow should be pointing right -RIGHT->>.

The Lay_R is mostly for rare circumstances when you want to arrange the Containers in a specific order but don't want to add an actual relationship between them ($from -[hidden]R- $to).

There is a mention of these now in the readme file.

@kirchsth
Copy link
Contributor

Rel_* is used if the elements has a relation, Lay_* is used if you want a specific layout of the elements:

In following sample a person uses different systems, and group of persons which have no relations

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
HIDE_STEREOTYPE()

Person(a, "A")
Person(b, "B")
Person(c, "C")
Person(d, "D")
Person(e, "E")

Lay_U(a, b)
Lay_R(a, c)
Lay_D(a, d)
Lay_L(a, e)

Person(x, "X")
System(s1, "S1")
System(s2, "S2")
System(s3, "S3")
System(s4, "S4")

Rel_U(x, s1, "uses")
Rel_R(x, s2, "uses")
Rel_D(x, s3, "uses")
Rel_L(x, s4, "uses")
@enduml

Relation versus Layout

@stale
Copy link

stale bot commented Feb 20, 2021

This issue has been automatically marked as stale because it has not had activity in the past 60 days. It will be closed in seven days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Issue has not been active for 60 days label Feb 20, 2021
@kirchsth
Copy link
Contributor

@adrianvlupu: I think it can be closed based on my merged sample

@stale stale bot removed the stale Issue has not been active for 60 days label Feb 21, 2021
@Potherca Potherca added this to the v2.1.0 milestone Apr 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

4 participants