plantuml-skinparam-parser's Introduction

PlantUML `skinparam` parser

"Writing a really general parser is a major but different undertaking, by far the hardest points being sensitivity to context and resolution of ambiguity." ~ Graham Nelson

Quick and dirty script to parse all available skinparam from the PlantUML code base.

Introduction

PlantUML is a great tool for drawing UML diagrams. It supports many diagrams and has lots of features.

One such feature, skinparam allows changing the way diagrams look (or behave).

Sadly, PlantUML also has some shortcomings, mostly in terms of documentation.

The manual mentions skinparam and there is a command^[1] to show a list of available skinparam but neither are complete.

This project offers a quick-and-dirty way of listing all available skinparam.

The full list is available in the build directory.

The list is created by parsing the Java code. The code that does this is written in PHP^[2].

Usage

There is a full list of skinparam available in the build directory. There is also a list with skinparam default values.

At a later point, a file will be added that defines constants for the values rather than hard-coding them.

The simplest thing is to just use those files.

Parsing a list from the PlantUML code

To create a list, the following steps need to be taken:

Download the PlantUML source-code
Download this project
Run the parser: ./bin/parse-skinparam <plantuml-source-directory>.
...
Profit!

For instance:

cd /tmp
git clone https://github.com/plantuml/plantuml.git
git clone https://github.com/potherca-blog/plantuml-skinparam-parser.git

/tmp/plantuml-skinparam-parser/bin/parse-skinparam /tmp/plantuml/

Colophon

Author: Created by Potherca.
Homepage: web-page / git-repo
License: Licensed under the GPL-3.0 license (GNU General Public License v3.0)
Logo: Based on the "SEO" icon by Gregor Cresnar from the Noun Project.