Implemented More detailed Error Message for Value Match Requirements (Item Fields & Review Fields)

[Hentai]

I have a lot of fields that require specific syntax.

I would love to be able to give my users a clue about what they are doing wrong beyond the very generic (and not really descriptive) "Please enter a value that matches the required format" error that pops up.

Its a usability issue that pops up quite often with users unfamiliar with the Showcase with them not sure where exactly they went wrong. So either custom error messages, or one telling them the errored field might be really helpful.

 

[Bob]

You are asking about the Value Match Requirements correct?

 

[Hentai]

Correct. Sometimes people try to enter words into a number field. Soemtimes people enter invalid URLs.

I would like to tell my users which fields they have in the wrong format.

 

[Bob]

Did a bit of R&D on this and I think its going to be possible with some code modification. The code modification is not 'minor', so I want to do a little more R&D on it before I commit to it.

 

[Hentai]

It doesn't have to be completely custom, just better indicators on what fields my users are getting wrong would be better than the current generic "Please enter a value that matches the required format".

My own Showcase has 4 tabs of information, with each tab having multiple value matched fields, so it is not immediately obvious to my users where the error comes from. I appreciate you putting the R&D time at least.

 

[Alpha1]

This would be really useful to have. People generally don't understand undefined errors and give up on it.

Maybe its an idea to also highlight the field in red and add a red information text above the field.

 

[0ptima]

My showcase has lots of custom fields with regex and I just had a member who could simply not create a new item as he did no know what was wrong. He ended up taking pictures of his screen with a camera to show me what he was entering.

This is must, even if some sort of basic indicator of which field is incorrect would be really helpful.

 

[0ptima]

I made a change to the Showcase code to display the description of the custom field when the regex fails

Here is an example with a custom field that only accepts numeric values.



When the regex fails, the description will be shown in the error message


To make this change, open CustomField.php located in the NFLJ/Showcase/Model folder

Go to the verifyCustomFieldValue() method and comment out

//   $error = new XenForo_Phrase('please_enter_value_that_matches_required_format');

and replace it with

$error =  new XenForo_Phrase("sc_custom_field_" .  $field['field_id']."_desc");

 

[Alpha1]

THis might be of interest as the functionality is similar:
https://xenforo.com/community/resources/wmtech-custom-field-error-enhancer.4718/

 

[Dadparvar]

Hi,

While creating or editing an item, users should fill field as we set criteria in "Value Match Requirements".
Now, imagine there are more than 30 fields to fill for an item, and all of them have their own criteria.
If a user write something else in some fields, he/she just will see this error when trying to submit the item:

But, which field has error? user should start checking all fields to see which one has problem.
I have Two suggestions for this:

• below the error, it writes list of the fields that should be edited. OR
• the field with error become red. or show a red error below it.

For first suggestion, I can refer to Advanced Application Forms add-on that worked perfect. We can write even what error to show when a user write wrong content in a field (for each field). See:

And for second suggestion I refer to xenforo itself:


Regards

 

[BT012SS]

http://xenaddons.com/threads/custom-error-messages-for-regex-ed-fields.1426/#post-7150

 

[Bob]

I've made a minor modification to the error message that should help most cases. It is also up to you as administrators when creating Item Fields and or Review Fields, to provided a detailed description if you are forcing value match requirements eg, if you are wanting them to enter a URL, then tell them the required format in the description.

NOTE: This works with both custom ITEM Fields and custom REVIEW Fields (they share the same 2 phrases)

If they enter the wrong format, there are 2 possible error messages. One for fields that have a description (first image) and one for fields that do not have a description (2nd image).

Phrase: nflj_sc_custom_field_error_name_description




Phrase: nflj_sc_custom_field_error_name

 

[Dadparvar]

Like Always, Awesome!
Thanks Bob

 

[0ptima]

The formatting is off when multiple errors are displayed



For regex failures, I suggest that the "Required Format:regex" not be shown as most users wont know what a regex is.
Site owners should provide the type of input the user should be entering in the custom field description.

 

[Bob]

For regex failures, I suggest that the "Required Format:regex" not be shown as most users wont know what a regex is.
Site owners should provide the type of input the user should be entering in the custom field description.

It is also up to you as administrators when creating Item Fields and or Review Fields, to provided a detailed description if you are forcing value match requirements eg, if you are wanting them to enter a URL, then tell them the required format in the description.

on both those REGEX fields, you DO NOT have a description that even remotes serves the purpose of a description. The description for fields ONLY displays on the INPUT FORM, so you can get very detailed about what you need users to enter. 1/4 Mile MPH as a description doesn't tell them the exact format. Having an example of the required format IN the description is what the entire purpose of the description is for. The description does NOT display on the ITEM page itself.

 

[0ptima]

on both those REGEX fields, you DO NOT have a description that even remotes serves the purpose of a description. The description for fields ONLY displays on the INPUT FORM, so you can get very detailed about what you need users to enter. 1/4 Mile MPH as a description doesn't tell them the exact format. Having an example of the required format IN the description is what the entire purpose of the description is for. The description does NOT display on the ITEM page itself.

Let me clarify what I meant.
WHP, 60 ft ET and 1/4 Mile MPH are all regex fields and I have updated the description to reflect the expected format to show the user a relevant error message.
What is not intuitive for the user in the error message is the "Required Format:regex" as most users wont know what a regex is.



When a regex fails, I would not want the "Required Format:regex" be shown. Here is what I would like to see.

 

[Bob]

no thank you. Something like that you can do on your own.

 

[0ptima]

What about the spacing? Is that as designed?
The item name error (Please enter a valid item name) should be the first error to be displayed.