Get help text title from field label if htxt title is not provided #26265
Conversation
|
(Standard links)
|
larssandergreen
changed the title
larssandergreen
changed the title
|
jenkins, test this please |
|
Technically the htxt id can be any string. By convention it begins with |
larssandergreen
force-pushed
the
Add-title-to-form-elements-so-we-can-use-it-for-help-text-titles
branch
from
70bdbbb
to
3af6469
Compare
|
Definitely would want to add some documentation about this. Could also get rid of the id string mess and simply look for an exact match to the field_name and just use that going forward. I don't see any reason we need the id in there. |
| @@ -67,6 +67,12 @@ function smarty_function_help($params, &$smarty) { | |||
| $name = trim(strip_tags($params['title'])); | |||
| } | |||
|
|
|||
| if (empty($name)) { | |||
| // sometimes the htxt id is field_name like the field, sometimes field-name instead so we fix it | |||
| $fieldID = str_replace('-', '_', str_replace('id-', '', $params['id'])); | |||
There was a problem hiding this comment.
I'm going to suggest doing the id- part as either a preg_replace(/^id-/, or checking with substr that it's only removing ones at the start of the string, otherwise if it says something like paid-amount or covid-vaccine it won't work.
There was a problem hiding this comment.
Yes, have done.
| @@ -67,6 +67,12 @@ function smarty_function_help($params, &$smarty) { | |||
| $name = trim(strip_tags($params['title'])); | |||
| } | |||
|
|
|||
| if (empty($name)) { | |||
There was a problem hiding this comment.
If you have an extra.hlp file (usage described at #13488), the body part still works but for the title it ALWAYS overrides whether you put override=1 or not. I'm not sure how often titles are appended to rather than overwritten so probably not a blocker.
There was a problem hiding this comment.
Easy enough to fix, have done. Also added a small bonus fix to the description above (or can break that out into a separate PR if preferred).
larssandergreen
force-pushed
the
Add-title-to-form-elements-so-we-can-use-it-for-help-text-titles
branch
from
3af6469
to
2b631b4
Compare
larssandergreen
force-pushed
the
Add-title-to-form-elements-so-we-can-use-it-for-help-text-titles
branch
from
2b631b4
to
7abcf85
Compare
|
Also documented the htxt override in docs. |
|
Thanks @larssandergreen looks pretty good.
It feels both right and wrong that the help feature needs its own help... |
larssandergreen
deleted the
Add-title-to-form-elements-so-we-can-use-it-for-help-text-titles
branch
|
More help feature help in docs. Turns out the help feature was in fact undocumented, so to add the default title, I had to add it entirely. |
Overview
This PR is for discussion, not sure the approach makes sense.
The aim is to avoid having to put the help text title for each help text in the .hlp files when the title is usually the field label. This would prevent the field label and help text title from getting out of sync if the field label changes and it makes it faster to add help texts. Question is if this is worthwhile or better just to keep copy-pasting the field names into the titles manually.
After
If the help text title is provided, no change.
If the help text title is not provided, the field label is used, providing the htxt id is
id-field_nameorid-field-name(both are used).Bonus
Before if an extra.hlp file existed with a non-override title, it was appended without a space like
TitleExtra. Now it is appended with a space likeTitle Extra, which is how the help text itself works.