Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable template developers to include an illustrative sample string within the field. #1194

Open
johardi opened this issue Oct 3, 2023 · 5 comments

Comments

@johardi
Copy link
Member

johardi commented Oct 3, 2023

This feature would allow template developers to provide an illustrative sample string for users to reference when completing the form.

@johardi johardi added the feature label Oct 3, 2023
@johardi johardi changed the title Add "Example" field on the template field options Enable template developers to include an illustrative sample string within the field. Oct 3, 2023
@johardi johardi added the HuBMAP label Oct 3, 2023
@matthewhorridge
Copy link

We would like this for RADx too. This shouldn't just be a string though, it needs to be an actual instance object (literal or IRI for fields)

@matthewhorridge
Copy link

Furthermore... I believe these example need to be in the context of an element or a template. One thought that I have is to create a canonical or prototype instance for a template and tie it to the template so that the example can be viewed easily inline or whereever

@graybeal
Copy link
Member

graybeal commented Oct 3, 2023

When I had to make The Greatest Template Ever, I put the example text at the end of each description between square brackets. Crude but effective.

From that experience I believe that the user doesn't seen instance objects, they see a string. What we used the example for is to trigger the user about what kind of information will go in the field, not tell them what type of field they are filling out. The fact that it's done with a term object and not a literal is almost invisible to them

@johardi
Copy link
Member Author

johardi commented Oct 3, 2023

What I have in mind to implement this on CEDAR is another attribute under "OPTIONS" that says "Enter input example", and template developers can add an example string there.

Screenshot 2023-10-03 at 1 53 53 PM

And this will work nicely with the OpenView to make the straight line look less awkward.

Screenshot 2023-10-03 at 1 59 03 PM

@matthewhorridge
Copy link

Some more requirements/ideas: I think it should be possible to specify multiple examples. And, I want to use real terms, numbers etc. and this should be programatically accessible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants