Page MenuHomePhabricator

Document state machine XML files graphically (XML XSLT Graphviz dot Doxygen)
Closed, WontfixPublic

Assigned To
None
Authored By
maleike
Aug 21 2013, 10:38 AM
Referenced Files
F1032: statemachine.dot.svg
Aug 21 2013, 10:41 AM
F1031: build_graph.sh
Aug 21 2013, 10:40 AM
F1030: PlanarFigureInteraction.xml
Aug 21 2013, 10:39 AM
Subscribers

Description

Recently I had to review a state machine pattern and required a visual representation to understand it. It poved extremely simple to transform the "new" format of state machine XML files into a Graphviz dot representation which can be rendered into SVG.

I shortly discussed that with Sascha and we both think it would be worthwhile to integrate such transformations in to the documentation system. A possible way would be to use a minmal Qt executable for the transformation.

All the details need to be worked out, but this bug is meant to document what has already been done and to create a place where I can archive my script :-)

(see attachments!)

Event Timeline

maleike added a subscriber: maleike.

Example XML that worked with given transformation

Bash script to run transformation

And here the result of processing.

Could still need some graphical work/love, but it is already helping much in understanding a state machine.

There is no need for a custom Qt executable. Each Qt installation ships with a tool called xmlpatterns which can process XQuery queries. We could use it in a CMake custom command to generate the dot output

xmlpatterns focus /path/to/statemachine.xml stylesheet statemachinetodot.xsl

kislinsk merged a task: Restricted Maniphest Task.Aug 1 2016, 10:47 PM
kislinsk claimed this task.
kislinsk added a project: Auto-closed.
kislinsk added a subscriber: kislinsk.

Hi there! 🙂

This task was auto-closed according to our Task Lifecycle Management.
Please follow this link for more information and don't forget that you are encouraged to reasonable re-open tasks to revive them. 🚑

Best wishes,
The MITK devs

kislinsk removed kislinsk as the assignee of this task.May 26 2020, 12:05 PM
kislinsk removed a subscriber: kislinsk.