Navigation

  • index
  • modules |
  • next |
  • previous |
  • PlantUML Client in Python 1.2.1 documentation »

Contents

  • Examples Gallery
    • PlantUML
      • Sequence
      • Use Case
      • Class
      • Activity
      • Component
      • State
      • Object
    • Graphviz
      • Cluster
      • Data Structures
      • Finite Automaton
    • Ditaa

Previous topic

Plantweb

Next topic

Developer Guide

This Page

  • Show Source
  1. Docs
  2. Examples Gallery

Examples Gallery¶

This gallery shows many examples of figures that can be rendered using Plantweb. All these examples were taken from the website of each project.

You can check the source code of this page.

For the original source of this examples or for more information and examples please visit the website of each project as shown in each section.

This section can be seen as a display of capabilities of the individual projects, but it is mostly a medium to test Plantweb Sphinx directives.

  • PlantUML
    • Sequence
    • Use Case
    • Class
    • Activity
    • Component
    • State
    • Object
  • Graphviz
    • Cluster
    • Data Structures
    • Finite Automaton
  • Ditaa

PlantUML¶

PlantUML is a component that allows to quickly write many UML diagrams using a simple and intuitive language.

For more examples and information visit the official website:

  • http://plantuml.com/
  • Sequence
  • Use Case
  • Class
  • Activity
  • Component
  • State
  • Object

Sequence¶

A Sequence diagram is an interaction diagram that shows how objects operate with one another and in what order.

  • Wikipedia, “Sequence Diagram”.

For detailed explanation see:

  • http://plantuml.com/sequence.html
_images/45d09d0a9c53ff7945fe6e95db2d28a9b54a460ea9c3057d70f466b4d50b774f.svg

_images/823974a6a35e630dd401429044d14e8be219e862de0862d42d9dd79d16f36c9f.svg

_images/14c02194a5de5cf9b048c38a87bb5b2dd594be124f00684f0941924edf717ce8.svg

Use Case¶

A use case diagram at its simplest is a representation of a user’s interaction with the system that shows the relationship between the user and the different use cases in which the user is involved.

  • Wikipedia, “Use Case Diagram”.

For detailed explanation see:

  • http://plantuml.com/usecase.html
_images/beb61de830788b6b3fab48f7b0e18bddc2cb6b6e35dafce1da76c6eeb753cc7c.svg

_images/ddcd30f09f9f9b6d0ec8ed7f8292813c178e368f91bb2b5f989ca18133e2b50e.svg

Class¶

A class diagram is a type of static structure diagram that describes the structure of a system by showing the system’s classes, their attributes, operations (or methods), and the relationships among objects.

  • Wikipedia, “Use Class Diagram”.

For detailed explanation see:

  • http://plantuml.com/classes.html
_images/01da6b02a7394f3c967d79cd4ac58cceab062b46c02c8970439c8ebd57ef2826.svg

_images/bcb9d441310adc60d1581995db8a67d8d12a97588e595915930f96399defc9d8.svg

Activity¶

Activity diagrams are graphical representations of workflows of stepwise activities and actions with support for choice, iteration and concurrency. In the Unified Modeling Language, activity diagrams are intended to model both computational and organizational processes (i.e. workflows). Activity diagrams show the overall flow of control.

  • Wikipedia, “Use Activity Diagram”.

For detailed explanation see:

  • http://plantuml.com/activity2.html
_images/762a368cec17edd950024890cdfd9aebbc01b53ac6c5a0db0ee55f11876ab379.svg

_images/65b76e38a4f0a74c791031ad4ed471f3ad463b53f10bcad75a4d2b03aaef7900.svg

_images/b9c46b25f265b47e399b7bf0c5a04beec32743cc8b496c16f83824a57771ad3d.svg

Component¶

A component diagram depicts how components are wired together to form larger components and or software systems. They are used to illustrate the structure of arbitrarily complex systems.

  • Wikipedia, “Component Diagram”.

For detailed explanation see:

  • http://plantuml.com/component.html
_images/7ea1cd4854ef9608dd8574b4cb8fc682daa4a2f2df74740b996d2350d97950f9.svg

_images/825aaf1928f66463cb3b3ad9a8f275542f4bbca4eae88b4d92888b4289c8a315.svg

State¶

A state diagram, also called a state machine diagram or statechart diagram, is an illustration of the states an object can attain as well as the transitions between those states.

  • TechTarget, “State Diagram”.

For detailed explanation see:

  • http://plantuml.com/state.html
_images/b49649eff946988588e248ea670d76041467c04ff55805ffe5129a24a81ca66d.svg

_images/cfcf9057e8dd0be93894a9e097dafde57ab4c5845a213a332ce161e5bf1333f1.svg

Object¶

An object diagram is a graph of instances, including objects and data values. A static object diagram is an instance of a class diagram; it shows a snapshot of the detailed state of a system at a point in time. The use of object diagrams is fairly limited, namely to show examples of data structure.

  • Object Management Group (2001), “UML specification 1.4”.
_images/31fd7a3345849aa2c6e57b3ba0a5acb581ff04354f8c7f18be8ee541df311692.svg

Graphviz¶

Graphviz is open source graph visualization software. Graph visualization is a way of representing structural information as diagrams of abstract graphs and networks.

It has important applications in networking, bioinformatics, software engineering, database and web design, machine learning, and in visual interfaces for other technical domains.

For more examples and information visit the official website:

  • http://www.graphviz.org/Gallery.php
  • Cluster
  • Data Structures
  • Finite Automaton

Cluster¶

This small example illustrates dot’s feature to draw nodes and edges in clusters or separate rectangular layout regions. Clusters are encoded as subgraphs whose names have the prefix ‘cluster’. The color attribute of a cluster is interpreted as its outline color or its background color if its style is ‘filled’. Mdiamond and Msquare are modified symbols for data flow diagrams.

  • http://www.graphviz.org/content/cluster
_images/9cbcdf1797889a83ef93522d32ae141cd9a42f3cdc383bf9719d393885ded5dd.svg

Data Structures¶

The graph file was generated automatically from a session with the LDBX graphical interface to the standard DBX debugger.

Nodes are drawn with the 'record' shape. Labels of this shape are interpreted specially as nested horizontal and vertical box lists formatted as tables. In a record label, curly braces { } enclose lists, vertical bar | separates list items, and creates a port identifier for attaching edges. Edges are also labeled with 'id' attributes. Though not demonstrated in this particular file, these attributes allow referencing multiple (parallel) edges between the same node pair.

  • http://www.graphviz.org/content/datastruct
_images/8b94b1ea6592a420fc2bbe770af03bbe90feb25ef64fc0a28848975ee7332d20.svg

Finite Automaton¶

This is a drawing of a finite automaton. The rankdir and orientation request a left-to-right drawing in landscape mode. Note the use of text labels on edges.

  • http://www.graphviz.org/content/fsm
_images/ed73d498dee08a00975294f79d388ef3cd36c40161e4603cfc088699115e0c25.svg

Ditaa¶

For more examples visit the official website:

  • http://ditaa.sourceforge.net/

Ditaa rendering is particularly usefull when using ASCII drawing tools like:

  • http://asciiflow.com/
_images/02fc7eba11ddf74ace9c0972e9064b60273ff50747ad9a113e614fa47b1d4ee9.png
_images/1752fb3e0154ea6d0cb00b76466a0358cf3a0ee8109a51342f226afbee71aee0.png
_images/99998e2911d43311c1217343557d804b9f2b99bfeaa9d141c0ea60c94aa51011.png
_images/1e12529e2444270778f47eb69e821b9f07316adce3393a3b8e09280ebdbf62c3.png
_images/dc5b49a651ee788d70a4c12bb2b3ca8397a33951a1ae81e2c4283e23a79a5b28.png
Plantweb
Developer Guide

Navigation

  • index
  • modules |
  • next |
  • previous |
  • PlantUML Client in Python 1.2.1 documentation »
© Copyright 2016-2017, Carlos Jenkins. Created using Sphinx.