Beckhoff-USA-Community / SPT-Libraries

MIT License
81 stars 19 forks source link

How were the diagrams made? #1

Closed runtimevic closed 1 year ago

runtimevic commented 1 year ago

Hello, How have the UML graphic diagrams been made to put them in the pdf documents?

MarkLewis-Beckhoff commented 1 year ago

https://mermaid.live/

runtimevic commented 1 year ago

https://mermaid.live/

and how do you pass the classDiagram made in TwinCAT to mermaid?, or do you make it from scratch from mermaid?

nshiggins commented 1 year ago

It is a separate tool not Beckhoff related. The diagrams were made manually.

On Fri, Oct 28, 2022 at 08:36 Runtimevic @.***> wrote:

https://mermaid.live/

and how do you pass the classDiagram made in TwinCAT to mermaid?, or do you make it from scratch from mermaid?

— Reply to this email directly, view it on GitHub https://github.com/Beckhoff-USA-Community/SPT-Libraries/issues/1#issuecomment-1294947809, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEMHY7IIUFDELOOIBJ7MZ5TWFPCFFANCNFSM6AAAAAARQOCDTA . You are receiving this because you are subscribed to this thread.Message ID: @.***>

runtimevic commented 1 year ago

It is a separate tool not Beckhoff related. The diagrams were made manually. On Fri, Oct 28, 2022 at 08:36 Runtimevic @.> wrote: https://mermaid.live/ and how do you pass the classDiagram made in TwinCAT to mermaid?, or do you make it from scratch from mermaid? — Reply to this email directly, view it on GitHub <#1 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEMHY7IIUFDELOOIBJ7MZ5TWFPCFFANCNFSM6AAAAAARQOCDTA . You are receiving this because you are subscribed to this thread.Message ID: @.>

Hello,

https://github.com/TcMotion/Component_Motion_OOP_Axis/wiki/UML_Tc2_Axis_Tc_MC2

I'm doing it this way so as not to have a double job..., but it doesn't look very good because it doesn't look quite right..., Do you know if the file that is exported from TwinCAT, the ClassDiagram *.TcCD, can be done externally with it, for example, to put it in the repository documentation and have it displayed?...

nshiggins commented 1 year ago

Not as far as I know. Mermaid is its own markup language that just happens to have the ability to do generic class diagrams. I chose to use it for a number of reasons, but mostly because I wanted to illustrate the relationships and not necessarily expose all of the locals, etc. in each function block.

runtimevic commented 1 year ago

Not as far as I know. Mermaid is its own markup language that just happens to have the ability to do generic class diagrams. I chose to use it for a number of reasons, but mostly because I wanted to illustrate the relationships and not necessarily expose all of the locals, etc. in each function block.

thanks,