Skip to content

classic UML alike note linking style #384

@grivo

Description

@grivo

when using PlantUML, following note linking policy is applied

  • bubble-like notes are used for entities
  • link attached notes are just placed somewhere more or less close to the links they are attached to

there should be a pragma (css or skinparam like), which does following

  • uses dotted line for note attaching (regardless of thing note is linked to)
  • may be customized by
    ** colour
    ** style (dashed / solid, etc)
    ** thickness

moreover - this pragma should be used globally either for selected notes (where classic PlantUML attaching may mangle reader's understanding)

finally - when using dots - line dots should be bigger yet line should be recognized as dotted (regardless of purpose dotted line is used for)

despite current version allows use ad-hocs - yet there are too many options to have unpredictable visualization still

following example shows more or less clear example of classic UML-alike notes attaching

@startuml note
hide empty members

package plantuml {

    class X {
        a : int
    }
    note right
        =PlantUML
        entity
        comment
    end note
    note left of X::a
        =PlantUML
        attribute
        comment
    end note

    Y <.. X : <<use>>
    note on link
        =PlantUML
        link
        comment
    end note
}

package uml {
    class A {
        x : float
    }

    note as a_n
        =PlantUML
        canocical style
        comment with
        dashed line
    end note
    a_n .[hidden]. A
    a_n .r. A

    note as a_x_n
        =PlantUML
        canocical style
        comment with
        dotted line
    end note
    a_x_n .[hidden]. A::x
    a_x_n .[dotted]l. A::x

    C <|-- A

    note as c_a_n
        =PlantUML
        canocical style
        comment with
        dashed line
        for link
    end note
    c_a_n . (C, A)
    c_a_n .[hidden] A
}
@enduml
Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions