Share Forms - How to set help text

[loftux]

In the release notes for 3.3 it says aboout Forms Engine "Help text for fields, renders a "?" icon that reveals the configured help text…"
How do you set that?

I've tried setting that in

<appearance>
    <field id="my:customfield" mandatory="true" read-only="false" help-text-id="label.form.help.customfieldhelp"/>‍‍

with lots of variations of "help-text-id". Nothing seems to work
Going to source code I found in web-framework-commons/source/java/org/alfresco/web/config/forms/FormElementReader.java that there is nothing declared for help text (as there is for things like message-id).

So what would be the correct way of adding help text?

[gavinc]

Hi,

You're almost there  :wink:

You need to either use "help" or "help-id" as the attribute name. For example:

<appearance>
   <field id="fdk:state" help-id="fdk.help.state />
   <field id="fdk:zip" help="Please enter a valid ZIP code" />
</appearance>‍‍‍‍

As you've noticed the Forms wiki page has not been updated with this information yet, I'm hoping to rectify that in the next couple of days.

[loftux]

Hi,
Thanks, I do recall I tried that. But it does not render if there is a constraint on the field, which is was for the field I tried. Trying "help-id" on plain text field, and it works.
Filed a case for it, https://issues.alfresco.com/jira/browse/ALF-2414

Also filed an enhancement request. It would be cool if it respected html tags, as is done for many properties strings. Then you could do something like

label.form.help.casetype=Choose case type. <a href="/share/page/search?t=test" target="_top">Read more…</a>‍

My idea is that you could get a hyperlink that dynamically links to SOPs and guides (probably with a better search than above).
https://issues.alfresco.com/jira/browse/ALF-2415

[nikhilesh_s1vak]

If either the help-id or help attributes are provided a "?" icon is rendered at the end of the field that will reveal the help text when clicked. Fields that have a constraint applied (except regular expression constraints) automatically get help text applied with an indication of what the user needs to enter. The "?" icon will not appear when the form is in view mode.

https://wiki.alfresco.com/wiki/Forms#field