about plugin in IJ2

[Adrian Daerr-2]

Dear list,

For an ImageJ1 plugin to document itself, you could put something like
the following in your plugins.config file inside the plugin jar:

Plugins>Drop Analysis, "Pendant drop", Pendant_drop("run")
Plugins>Drop Analysis, "About Pendant drop", Pendant_drop("about")
Help>About Plugins, "Pendant drop...", Pendant_drop("about")

And then your plugin could react appropriately if called with the
"about" argument, and show an informative window.

What is the recommended way of doing that in IJ2 ?

I am about to create two plugins in the same jar, one for the "about"
function, and use their respective menuPath attributes of the @Plugin
annotation to create the two menu entries. If there is a better way
(e.g. a canonical way of making (html-,pdf-,...)resources included in
the jar visible somehow from within imagej) please let me know.

TIA,
Adrian

--
ImageJ mailing list: http://imagej.nih.gov/ij/list.html

[ctrueden]

Hi Adrian,

> What is the recommended way of doing that in IJ2 ?

Great question. Sorry to say it is not yet implemented. Here is the
relevant issue:
    https://github.com/scijava/scijava-common/issues/49

Of course, you can still implement an 'AboutFoo' command to complement your
command. But that is rather ad hoc. We want to have something snazzier, as
described in the issue. Feel free to comment there with any ideas and
suggestions!

> I am about to create two plugins in the same jar, one for the "about"
> function, and use their respective menuPath attributes of the @Plugin
> annotation to create the two menu entries.

For the short term, that is the way to go.

Regards,
Curtis

On Wed, Aug 12, 2015 at 12:44 PM, Adrian Daerr <
[hidden email]> wrote:

> Dear list,
>
> For an ImageJ1 plugin to document itself, you could put something like the
> following in your plugins.config file inside the plugin jar:
>
> Plugins>Drop Analysis, "Pendant drop", Pendant_drop("run")
> Plugins>Drop Analysis, "About Pendant drop", Pendant_drop("about")
> Help>About Plugins, "Pendant drop...", Pendant_drop("about")
>
> And then your plugin could react appropriately if called with the "about"
> argument, and show an informative window.
>
> What is the recommended way of doing that in IJ2 ?
>
> I am about to create two plugins in the same jar, one for the "about"
> function, and use their respective menuPath attributes of the @Plugin
> annotation to create the two menu entries. If there is a better way (e.g. a
> canonical way of making (html-,pdf-,...)resources included in the jar
> visible somehow from within imagej) please let me know.
>
> TIA,
> Adrian
>
> --
> ImageJ mailing list: http://imagej.nih.gov/ij/list.html
>

--
ImageJ mailing list: http://imagej.nih.gov/ij/list.html

[Adrian Daerr-2]

Hi Curtis,
Thanks a lot for taking the time to answer. I went the 'AboutFoo' way
for the time being, and will add some comments on the git issue
tracker.
Adrian

On Fri, 21 Aug 2015 22:38:05 -0500
  Curtis Rueden <[hidden email]> wrote:

> Hi Adrian,
>
>> What is the recommended way of doing that in IJ2 ?
>
> Great question. Sorry to say it is not yet implemented. Here is the
> relevant issue:
>    https://github.com/scijava/scijava-common/issues/49
>
> Of course, you can still implement an 'AboutFoo' command to
>complement your
> command. But that is rather ad hoc. We want to have something
>snazzier, as
> described in the issue. Feel free to comment there with any ideas
>and
> suggestions!
>
>> I am about to create two plugins in the same jar, one for the
>>"about"
>> function, and use their respective menuPath attributes of the
>>@Plugin
>> annotation to create the two menu entries.
>
>For the short term, that is the way to go.
>
> Regards,
> Curtis
>
> On Wed, Aug 12, 2015 at 12:44 PM, Adrian Daerr <
> [hidden email]> wrote:
>
>> Dear list,
>>
>> For an ImageJ1 plugin to document itself, you could put something
>>like the
>> following in your plugins.config file inside the plugin jar:
>>
>> Plugins>Drop Analysis, "Pendant drop", Pendant_drop("run")
>> Plugins>Drop Analysis, "About Pendant drop", Pendant_drop("about")
>> Help>About Plugins, "Pendant drop...", Pendant_drop("about")
>>
>> And then your plugin could react appropriately if called with the
>>"about"
>> argument, and show an informative window.
>>
>> What is the recommended way of doing that in IJ2 ?
>>
>> I am about to create two plugins in the same jar, one for the
>>"about"
>> function, and use their respective menuPath attributes of the
>>@Plugin
>> annotation to create the two menu entries. If there is a better way
>>(e.g. a
>> canonical way of making (html-,pdf-,...)resources included in the
>>jar
>> visible somehow from within imagej) please let me know.
>>
>> TIA,
>> Adrian
>>
>> --
>> ImageJ mailing list: http://imagej.nih.gov/ij/list.html
>>
>
> --
> ImageJ mailing list: http://imagej.nih.gov/ij/list.html

--
http://www.msc.univ-paris-diderot.fr/~daerr/

--
ImageJ mailing list: http://imagej.nih.gov/ij/list.html