plantuml/ plantuml-stdlib

Need help with plantuml-stdlib?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

plantuml

245 Stars

55 Forks

80 Commits

12 Opened issues

Description

Contains official Standard Library for PlantUML

Services available

Need anything else?

Contributors list

Readme

plantuml-stdlib

Name: plantuml-stdlib
Brand: plantuml-stdlib
SKU: //plantuml/plantuml-stdlib
Rating: 2.3625 (245 reviews)

Contains official Standard Library for PlantUML See http://plantuml.com/stdlib for more information.

This Standard Library is included in official release of PlantUML. Following the C convention for "C standard library" (see https://en.wikipedia.org/wiki/Cstandardlibrary )

AWS library

The AWS library consists of Amazon AWS icons, it provides icons of two different sizes.

Use it by including the file that contains the sprite, eg:

!include

. When imported, you can use the sprite as normally you would, using

You may also include the

common.puml

file, eg:

!include

, which contains helper macros defined. With the

common.puml

imported, you can use the

NAME_OF_SPRITE(parameters...)

macro.

Example of usage: ``` @startuml !include !include !include

AMAZONS3(s3internal) AMAZONS3(s3partner,"Vendor's S3") s3internal <- s3partner @enduml ```

This example renders the following image:

Example

Azure library

The Azure library consists of Microsoft Azure icons.

Use it by including the file that contains the sprite, eg:

!include

. When imported, you can use the sprite as normally you would, using

You may also include the

AzureCommon.puml

file, eg:

!include

, which contains helper macros defined. With the

azure/AzureCommon.puml

imported, you can use the

NAME_OF_SPRITE(parameters...)

macro.

Example of usage: ``` @startuml

!include azure/AzureCommon.puml !include azure/Analytics/AzureEventHub.puml !include azure/Analytics/AzureStreamAnalytics.puml !include azure/Databases/AzureCosmosDb.puml

left to right direction

agent "Device Simulator" as devices #fff

AzureEventHub(fareDataEventHub, "Fare Data", "PK: Medallion HackLicense VendorId; 3 TUs") AzureEventHub(tripDataEventHub, "Trip Data", "PK: Medallion HackLicense VendorId; 3 TUs") AzureStreamAnalytics(streamAnalytics, "Stream Processing", "6 SUs") AzureCosmosDb(outputCosmosDb, "Output Database", "1,000 RUs")

devices --> fareDataEventHub devices --> tripDataEventHub fareDataEventHub --> streamAnalytics tripDataEventHub --> streamAnalytics streamAnalytics --> outputCosmosDb

@enduml ```

This example renders the following image:

Example

Elastic library

The Elastic library consists of Elastic icons. It is similar in use to the AWS and Azure libraries (it used the same tool to create them).

Use it by including the file that contains the sprite, eg:

!include

. When imported, you can use the sprite as normally you would, using

You may also include the

common.puml

file, eg:

!include

, which contains helper macros defined. With the

common.puml

imported, you can use the

NAME_OF_SPRITE(parameters...)

macro.

Example of usage: ``` @startuml !include !include !include !include

ELASTICSEARCH(ElasticSearch, "Search and Analyze",database)
LOGSTASH(Logstash, "Parse and Transform",node)
KIBANA(Kibana, "Visualize",agent) 

Logstash -right-> ElasticSearch: Transformed Data
ElasticSearch -right-> Kibana: Data to View

@enduml ```

This example renders the following image: Example

Tupadr3 library

This library contains several libraries of icons (including Devicons and Font Awesome )

Use it by including the file that contains the sprite, eg:

!include

. When imported, you can use the sprite as normally you would, using

You may also include the

common.puml

file, eg:

!include

, which contains helper macros defined. With the

common.puml

imported, you can use the

NAME_OF_SPRITE(parameters...)

macro.

Example of usage: ``` @startuml !include !include !include

title Styling example

FASERVER(web1,web1) #Green FASERVER(web2,web2) #Yellow FASERVER(web3,web3) #Blue FASERVER(web4,web4) #YellowGreen

FADATABASE(db1,LIVE,database,white) #RoyalBlue FADATABASE(db2,SPARE,database) #Red

db1 <--> db2

web1 <--> db1 web2 <--> db1 web3 <--> db1 web4 <--> db1 @enduml ```

This example renders the following image: Example

Google Material Icons

This library consists of a free Material style icons from Google and other artists.

Use it by including the file that contains the sprite, eg:

!include

. When imported, you can use the sprite as normally you would, using

. Notice that this library requires an

ma_

preffix on sprites names, this is to avoid clash of names if multiple sprites have the same name on different libraries.

You may also include the

common.puml

file, eg:

!include

, which contains helper macros defined. With the

common.puml

imported, you can use the

MA_NAME_OF_SPRITE(parameters...)

macro, note again the use of the prefix

MA_

Example of usage: ``` @startuml !include ' To import the sprite file you DON'T need to place a prefix! !include

MAFOLDERMOVE(Red, 1, dir, rectangle, "A label") @enduml ```

This example renders the following image: Example

Notes

When mixing sprites macros with other elements you may get a syntax error if, for example, trying to add a rectangle along with classes. In those cases, add

and

after the macro to create the empty rectangle.

Example of usage: ``` @startuml !include ' To import the sprite file you DON'T need to place a prefix! !include

MAFOLDERMOVE(Red, 1, dir, rectangle, "A label") { }

class foo { bar } @enduml ```

This example renders the following image: Example

Sources

aws: made by https://github.com/milo-minderbinder/AWS-PlantUML
tupadr3: made by https://github.com/tupadr3/plantuml-icon-font-sprites
Material Icons: from https://github.com/Templarian/MaterialDesign
Elastic Icons: from https://github.com/Crashedmind/PlantUML-Elastic-icons

You can create Pull Request to update or add some library here if you find it relevant.