Problem/Motivation

field_tags is used on both the Recipe and Article type.

On the Article type, the examples in the help text for this field are nothing like the tags you would actually use on this website:

The controls for editing an article showing inappropriate help text examples

We should change these examples to be culinary related ones that indicate how this field would actually be used.

The recipe content also has field_tags, but here it has no help. We should reimplement the help text from article once updated here.

Proposed resolution

Update help text on both content types.

Remaining tasks

  • Decide on new example tags.
  • Change the example tags on Article.
  • Copy the entire help text to Recipe.

User interface changes

UI will have more appropriate help text.

API changes

None.

Data model changes

None.

Comments

Eli-T created an issue. See original summary.

msankhala’s picture

What about this:

field_tag description for the article content type for Umami profile:

Enter a comma-separated list. For example Cold Drink, Hot Beverages, Vegetarian etc.

field_tag description for the recipe content type for Umami profile:
we can use the same description as the article content type or something like:

Enter a comma-separated list. For example Egg, Vegetarian, Dessert etc.

ltrain’s picture

Assigned: Unassigned » ltrain

Picking this up as part of Drupal North Sprint Day 2018.

ltrain’s picture

Issue tags: +DrupalNorth2018
StatusFileSize
new1.34 KB

Added description "Enter a comma-separated list. For example: herbs, vegetarian, chocolate brownies" for the field in both content types.

ltrain’s picture

Status: Active » Needs review
eli-t’s picture

Status: Needs review » Needs work

Thanks for working on this - looks good, but I'd suggest the examples use sentence case, to match the tags created at install time.

ltrain’s picture

StatusFileSize
new1.39 KB

Taking another shot at it!

Enter a comma-separated list. For example: vegetarian, chocolate brownies, "French fries, cooking techniques"

ltrain’s picture

Status: Needs work » Needs review
eli-t’s picture

Issue summary: View changes
Status: Needs review » Needs work
StatusFileSize
new48.6 KB

Thanks for taking another shot. We're not quite there yet though. By "sentence case" I meant that the tags should have the first letter of the first word capitalised, to match how they are listed in the Tag listing:

Tag listing showing Sentence case

See https://en.wikipedia.org/wiki/Capitalization#Sentence_case.

Also, the example of "Cleveland, Ohio" in the original tags help text is to demonstrate how you can add a tag with a comma in to a comma separated list. This patch adapts that to "French fries, cooking techniques" which is odd to have as a single tag. I'd suggest that all the examples that we use in the description should exist in the tag list created when we install, especially as they aren't set to auto create for recipe (I'll raise a follow up for that).

eli-t’s picture

ltrain’s picture

Point taken with regard to the capitalization!

I had thought you were requesting that one of the terms include a use of comma, for which I tried to come up with a food-related case - I took this from the index of a cookbook, meaning "Cooking techniques for french fries".

If I go back to the previous list but with capitalization, will that work?

imalabya’s picture

Status: Needs work » Needs review
StatusFileSize
new1.35 KB

Added a set of Tags from the list.

Baking, Cocktail party, "Healthy, Vegetarian" for Articles
Alcohol free, Herbs, "Pastry, Seasonal" for Recipes

joachim’s picture

"Healthy, Vegetarian" doesn't make sense as a single tag. It should be two tags surely.

I don't think think there is an equivalent culinary term we can use that contains a comma to demonstrate how to escape a comma.

eli-t’s picture

@joachim +1. That was the point I was trying to make in #9

ltrain’s picture

StatusFileSize
new1.35 KB

Enter a comma-separated list. For example: Vegetarian, Chocolate brownies, Appetizers

joachim’s picture

Status: Needs review » Reviewed & tested by the community

LGTM.

We could open a follow-up to think of a suitable culinary term that contains a comma.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 15: 2991573-help-text-for-field-tags.patch, failed testing. View results

eli-t’s picture

Status: Needs work » Needs review

Fail looks unrelated. Putting back to Needs Review to trigger testbot.

eli-t’s picture

Status: Needs review » Reviewed & tested by the community

Tests passed after being retriggered in #18.
Patch looks good and covers what was required in the issue summary - we have culinary examples of tags when editing recipes and articles.
Applied and successfullt manually tested using SimplyTest.me.

Returning to RTBC.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed and pushed 019f7e10b0 to 8.7.x and ebeefc8197 to 8.6.x. Thanks!

  • alexpott committed 019f7e1 on 8.7.x
    Issue #2991573 by Laura Johnson, imalabya, Eli-T, joachim, msankhala:...

  • alexpott committed ebeefc8 on 8.6.x
    Issue #2991573 by Laura Johnson, imalabya, Eli-T, joachim, msankhala:...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.