Making annotations?

Dirk · 2017-07-03 20:24

Can one make annotations to presets? E.g., add an annotation to this preset like to adapt the "Filters" and such?

den4b · 2017-07-03 23:07

There is no official way to add comments to rules or presets, yet.

There is an unofficial way using Pascal Script rule with the whole script consisting of a code comment, as described here: Add comments for rules.

Incidentally, which would be more useful?
A) a separate "Comment" rule,
B) a generic comment field per rule,
C) some other way?

Dirk · 2017-07-04 00:03

There is an unofficial way using Pascal Script rule with the whole script consisting of a code comment, as described here: Add comments for rules.

Alright, thank you, so I will do it.

Incidentally, which of two would be more useful?
A) a separate "Comment" rule,
B) a generic comment field per rule,
C) some other way?

I would say, in any case B): so one knows what, to which rule a comment refers to, (may be "Comment", clickable, opening the annotation, at the end of a rule in the upper pane)

And C), I would say, an annotation to set for the preset (generally). Both A) and C) could open in the same window, so one could see / edit all of the rules without opening them separately.

An annotation (may be dis/activatable by the user), respectively the existing of one, could be automactially displayed (when one opens a preset may be showing something like "Annotation!" or such, clickable opening a window) that there is a rule at all, so without having to look for a rule which might exist.

Or, if the effort is too big for the above just a commentation function per preset and the display that there is a comment after one has loaded the preset. So one could note something like: Comment to rule 2: etc.

At the moment this manner appears to be quite useful, so one cannot miss a comment:

May be like the above on the screenshot (may be easier to code), the same field (one creates with a rule in the "Edit rule" window but empty named "Comment" indented under the rule to be commented. And the same with a general comment for the preset on top of the rules (may be something like "Comment for preset" / "Preset annotation") or at the bottom. May be in the middle / colored or indented.

Last edited by Dirk (2017-07-04 00:30)

den4b · 2017-07-07 15:49

Thanks a lot for your feedback!

This will help shape up the commenting feature when the time comes to implement it.

Dirk · 2017-07-07 18:19

You are very welcome!

den4b · 2018-06-24 23:55

Rule comments have been implemented in ReNamer 6.8.0.4 Beta.

- You can add/edit rule comments via the rules context menu, or using a Shift+Enter hotkey.
- Comments are displayed in the Statement column, replacing the auto-generated rule description, when available.

Dirk · 2018-06-25 08:56

That's great, thank you very much!

den4b Forum

#1 2017-07-03 20:24

Making annotations?

#2 2017-07-03 23:07

Re: Making annotations?

#3 2017-07-04 00:03

Re: Making annotations?

#4 2017-07-07 15:49

Re: Making annotations?

#5 2017-07-07 18:19

Re: Making annotations?

#6 2018-06-24 23:55

Re: Making annotations?

#7 2018-06-25 08:56

Re: Making annotations?

Board footer