Archi Forum

Archi Plug-ins => jArchi => Topic started by: Nick on November 02, 2022, 09:08:10 AM

Title: Script documentation
Post by: Nick on November 02, 2022, 09:08:10 AM
Hello, I am currently working on some scripts with the jArchi plugin and I wonder if there is a way to show some documentation about specific scripts directly in Archi before running the scripts ?
If not, maybe this could be a decent addition to clarify the purposes of the scripts before running these, through the Hints section or when the cursor hovers the name of the script instead of having the path to the script.
Title: Re: Script documentation
Post by: Phil Beauvoir on November 02, 2022, 09:24:51 AM
Interesting idea but might have a cost if each script had to be loaded to get the documentation text. Unless there was some lightweight metadata stored somewhere.
Title: Re: Script documentation
Post by: Thomas Rohde on November 03, 2022, 05:44:35 AM
We have created an Eclipse dialogue as a single entry into the centrally available script library.

demolibrary.png

This script, and all the referenced scripts in the library, can be placed on a server somewhere, and only a single "load" statement needs to be distributed along with the Archi software.

This gist (https://gist.github.com/ThomasRohde/8510e13e05681e990d826bd1bea9a84f) is the main script library engine.
Title: Re: Script documentation
Post by: Jean-Baptiste Sarrodie on November 03, 2022, 10:17:59 AM
Hi,

Quote from: Thomas Rohde on November 03, 2022, 05:44:35 AMWe have created an Eclipse dialogue as a single entry into the centrally available script library.

That's exactly what I was looking for.

Thank you !

Regards,

JB
Title: Re: Script documentation
Post by: Nick on November 03, 2022, 12:13:44 PM
Quote from: Thomas Rohde on November 03, 2022, 05:44:35 AMWe have created an Eclipse dialogue as a single entry into the centrally available script library.

Thank you for sharing this ! This will definitely be very useful  ;)