search

measuresforjustice / textricator

Textricator is a tool to extract text from documents and generate structured data.
https://textricator.mfj.io
GNU Affero General Public License v3.0
345 stars 38 forks source link

HowTo: Create a state diagram from your YML config file #26

Open eabase opened 3 years ago

eabase commented 3 years ago

So after my comment in issue #11, I have experimented a little with a very nice tool for creating diagrams. Although this is probably not a proper State Diagram, it's better than nothing.

  1. Download PlantUML from here, and extract.

  2. Copy your YML file to a new file, e.g. "xx.yml".

  3. Add the @startyaml and @endyaml to the start and beginning, respectively, of that file, using: 

    echo "@endyaml" >>xx.yml && sed -i '1 s/^/@startyaml\n/' xx.yml

  4. Run the graph generator with: 

java -jar plantuml.jar -verbose xx.yml

Enjoy! :sparkling_heart:

xxy1

stephenbmfj commented 3 years ago

I love PlantUML! In addition to this, I should have Textricator generate a diagram of the state transitions.