[GRASS-dev] module header definitions add: text/multiline and latex support?

Glynn Clements glynn at gclements.plus.com
Thu Jan 15 00:13:58 PST 2015


Vaclav Petras wrote:

> > Requiring raster OR vector is possible already.
> >
> > #%rules
> > #% requires: raster, vector
> > #%end
> 
> Can this have a description? I'm not sure where we would show it but it
> might be useful. However, I'm against introducing some general inter-option
> info, I'm not sure how it would work in code, GUI, command line and manual
> page. You can always include this information into description of
> individual options. Details can go to a manual page which is accessible
> from GUI, using man or in web browser.
> 
> I don't see how you would like the GUI to look like. So if you have some
> ideas or examples, please share. I can see what Moritz is saying, GUI
> should be the same as command line because they are two interfaces to the
> same thing.

Some possibilities which spring to mind:

* Grey-out (or otherwise mark as "unavailable") options which cannot
be used in conjunction with options already given. Indicate via a
tooltip which option causes this option to be unavailable.

* Highlight options which are not yet given but required by the
existing options. Indicate via a tooltip which option causes this
option to be required.

* Display a warning message (in a status area, not a modal warning
dialog) if any of the inter-dependency rules are violated, rather
than just waiting until you run the module and having that fail with an
error.

* Alternatively, grey-out the "Run" button (or add a warning icon next
to it) if any of the inter-dependency rules are violated. Indicate the
nature of the problem via a tooltip.

* In the specific case where you have both "requires" and "exclusive"
rules with the same list of options, radio buttons could be added for
them (this would probably require all of the options to be in the
same guisection).

-- 
Glynn Clements <glynn at gclements.plus.com>


More information about the grass-dev mailing list