Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Comandos comunes en PlantUML

Descubra los comandos fundamentales universalmente aplicables a todos los tipos de diagramas en PlantUML. Estos comandos le permiten inyectar versatilidad y detalles personalizados en sus diagramas. A continuación, desglosamos estos comandos comunes en tres categorías principales:

Elementos globales

Comentarios: Añada comentarios o notas explicativas en el guión de su diagrama para transmitir información adicional o para dejar recordatorios para futuras modificaciones.
Notas: Incorpore información suplementaria directamente en su diagrama para ayudar a la comprensión o para resaltar aspectos importantes.
Control de Tamaño: Ajuste las dimensiones de los distintos elementos según sus preferencias, garantizando un diagrama equilibrado y bien proporcionado.
Título y leyendas: Defina un título adecuado y añada subtítulos para aclarar el contexto o para anotar partes específicas de su diagrama.

Descripción de la sintaxis criolla

Aproveche el poder de la sintaxis criolla para dar más formato al contenido de cualquier elemento dentro de su diagrama. Este estilo de marcado wiki permite:

Formato de Texto: Personalice la apariencia de su texto con varios estilos y alineaciones.
Listas: Cree listas ordenadas o desordenadas para presentar la información de forma ordenada.
Enlaces: Integre hipervínculos para facilitar la navegación rápida a recursos relevantes.

Comando de Control de Estilo

Obtenga un control completo sobre el estilo de presentación de sus elementos de diagrama utilizando el comando style. Utilícelo para:

Definir Estilos: Establecer estilos uniformes para los elementos para mantener un tema visual cohesivo.
Personalizar Colores: Elija colores específicos para varios elementos para mejorar el atractivo visual y crear clasificaciones distintas.

Explore estos comandos para crear diagramas que sean tanto funcionales como estéticamente agradables, adaptando cada elemento a sus especificaciones exactas.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Comments

Simple comment

Everything that starts with simple quote ' at the beginning of a line is a comment.

@startuml
'Line comments use a single apostrophe
@enduml

Block comment

Block comment use C-style comments except that instead of * you use an apostrophe ', then you can also put comments on several lines using /' to start and '/ to end.

@startuml
/'
many lines comments
here
'/
@enduml

[Ref. QA-1353]

Then you can also put block comment on the same line, as:

[Ref. QA-3906 and QA-3910]

Full example

[Ref. GH-214]

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Zoom or Scale

You can use the scale command to zoom the generated image.

You can use either a number or a fraction to define the scale factor. You can also specify either width or height (in pixel). And you can also give both width and height: the image is scaled to fit inside the specified dimension.

scale 1.5
scale 2/3
scale 200 width
scale 200 height
scale 200*100
scale max 300*200
scale max 1024 width
scale max 800 height

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Title

The title keywords is used to put a title. You can add newline using \n in the title description.

Some skinparam settings are available to put borders on the title.

You can use creole formatting in the title.

You can also define title on several lines using title and end title keywords.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Caption

There is also a caption keyword to put a caption under the diagram.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Footer and header

You can use the commands header or footer to add a footer or a header on any generated diagram.

You can optionally specify if you want a center, left or right footer/header, by adding a keyword.

As with title, it is possible to define a header or a footer on several lines.

It is also possible to put some HTML into the header or footer.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Legend the diagram

The legend and end legend are keywords is used to put a legend.

You can optionally specify to have left, right, top, bottom or center alignment for the legend.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Appendix: Examples on all diagram

Activity

Archimate

Class

Component, Deployment, Use-Case

Gantt project planning

DONE

[(Header, footer) corrected on V1.2020.18]

Object

MindMap

Network (nwdiag)

Sequence

State

Timing

Work Breakdown Structure (WBS)

DONE

[Corrected on V1.2020.17]

Wireframe (SALT)

DONE

[Corrected on V1.2020.18]

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Appendix: Examples on all diagram with style

DONE

FYI:

all is only good for Sequence diagram
title, caption and legend are good for all diagrams except for salt diagram

FIXME

🚩

Now (test on 1.2020.18-19) header, footer are not good for all other diagrams except only for Sequence diagram.

To be fix; Thanks

FIXME

Here are tests of title, header, footer, caption or legend on all the diagram with the debug style:

<style>
title {
  HorizontalAlignment right
  FontSize 24
  FontColor blue
}

header {
  HorizontalAlignment center
  FontSize 26
  FontColor purple
}

footer {
  HorizontalAlignment left
  FontSize 28
  FontColor red
}

legend {
  FontSize 30
  BackGroundColor yellow
  Margin 30
  Padding 50
}

caption {
  FontSize 32
}
</style>