Skip to content

Latest commit

 

History

History
252 lines (211 loc) · 6.16 KB

Diagram.org

File metadata and controls

252 lines (211 loc) · 6.16 KB
Raw

Ditaa

When a drop of water joins the ocean it becomes the ocean.

+---------+
| cBLU    |
|         |
|    +----+
|    |cBLU|
|    |    |
+----+----+

image/ditaa-drop_in_the_ocean.png

+----------+1       1…3+------+
| Sailboat +◆----------+ Mast |
+-----+----+           +------+
      ◆1
      |
      |             1…2+------+
      +----------------+ Hull |
                       +------+
      This is not a sailboat

image/ditaa-not_a_sailboat.png

@@latex: \pagebreak@@

Graphviz

digraph graphviz {
  subgraph cluster {
    ayh [label="Happy with things?", shape=ellipse];
    no [label="No.", shape=Mdiamond];
    yes [label="Yes.", shape=Mdiamond];
    ayh -> no;
    ayh -> yes;
    no -> ayh [label="Change them."];
    yes -> ayh [label="Keep doing them."];
  }
  labelloc="t";
  label="Life is simple:\nAttribution: @tgtext";
}

image/graphviz-life_is_simple.png

@@latex: \pagebreak@@

PlantUML

Sequence Diagram

  • Feature rich.
  • Information rich.
Alice --> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice --> Bob: Another authentication Request
Alice <-- Bob: another authentication Response

image/plantuml-sequence_diagram.png

@@latex: \pagebreak@@

Use Case Diagram

  • Actor variable aliasing feature.
left to right direction
skinparam packageStyle rect
actor customer
actor clerk
rectangle checkout {
customer -- (checkout)
(checkout) .> (payment) : include (help) .> (checkout) : extends (checkout) -- clerk
}

image/plantuml-use_case_diagram.png

@@latex: \pagebreak@@

Class Diagram

  • Valuable for all sorts of ideas in addition to classes.
  • hide, show, and include are mentioned.
    • Could be a great reuse mechanism combined with noweb and tangling.
  • Spotted characters might be useful to indicating other things.
    • Example is data which is clearly a first-class citizen.
    • Six package visualization types.
    • Packaging vs. namespaceing.
    • Good support for splitting large images among output pages.
title This is not a sailboat
scale 200 width
Sailboat "1" *-- "1..3" Mast
Sailboat "1" *-- "1..3" Hull

image/plantuml-class_diagram.png

@@latex: \pagebreak@@

Activity Diagram

  • May indicate top to bottom flow using top.
  • May label arrows.
  • May force arrow direction.
  • if/else structure for branching.
  • Partition construct.
  • New syntax with more examples.
start
partition Initialization {
:read config file;
:init internal variable;
}
partition Running {
:wait for user interaction;
:print information;
}

stop

image/plantuml-activity_diagram.png

@@latex: \pagebreak@@

Component Diagram

  • The names to define all of the diagram entity types.
  • Identify “Modern UML”.
  • Good for summaries.
[First component]
[Another component]
() "First Interface"
() "Another interface" as Interf2
DataAccess - [First Component]
[First Component] ..> HTTP : use

image/plantuml-component_diagram.png

@@latex: \pagebreak@@

State Diagram

[*] --> State1
State1 --> [*]
State1 : this is a string State1 : this is another string

image/plantuml-state_diagram.png

@@latex: \pagebreak@@

Object Diagram

object Object01
object Object02
Object01 <|-- Object02

image/plantuml-object_diagram.png

@@latex: \pagebreak@@

Options

  • Commands.
    • Header and footer values.
    • Zoom level.
    • Creole markup for most text elements.
    • Lists and sub-lists.
    • Horizontal lines. Will appear in most containers.
    • Headings.
    • Plain old HTML.
    • Tables, LaTeX style.
    • Use OpenIconic icons anywhere.
  • Fonts and colors.
    • You can change just about everything.
    • You may nest definitions.
    • monochrome true option.
      • If you are printing
      • Or don’t want color.
  • Internationalization.
    • Full Unicode character support.