Problem/Motivation

Currently, the link field auto-inserts help text based on what is selected under "allowed field type" in the field configuration.

"External links only" results in the help text "This must be an external URL such as http://example.com."

"Both internal and external links" results in the help text "Start typing the title of a piece of content to select it. You can also enter an internal path such as /node/add or an external URL such as http://example.com. Enter <front> to link to the front page."

("Internal links only", interestingly, doesn't generate any help text, including the relevant help text from the "both" option.)

Proposed resolution

Add help text to the option "Internal links only"

Remaining tasks

Send first patch

User interface changes

Adds help text

Without the patch:

With the patch:

API changes

none

Reported by

Issue reported by @rootwork on #2462087: Make displaying fields' help text optional

RC phase evaluation

Reference: https://www.drupal.org/core/d8-allowed-changes
Issue category Documentation bug because the help text for "internal links" is present when the "both" option is selected, but not when the "internal only" option is selected.
Issue priority Normal because it's a site-builder DX issue with documentation.
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Mac_Weber’s picture

Mac_Weber’s picture

Status: Active » Needs review
rootwork’s picture

Title: Add help text to the option "External links only" » Add help text to the option "internal links only"
Issue summary: View changes

Updated what I think was a typo in the issue title.

rootwork’s picture

Screenshots--

Without patch:
Screenshot without patch

With patch:
Screenshot with patch

Mac_Weber’s picture

@rootwork thank you for catching the typo and sending the screenshots!
Let me know if you have reviewed the patch and feel free to switch the status to "RTBC" if you don't find any problems.

Mac_Weber’s picture

Issue summary: View changes
rootwork’s picture

Category: Task » Bug report
Status: Needs review » Reviewed & tested by the community

I'm sorry I never came back to this, but remarkably the patch from #1 still applies. I just confirmed this, and the screenshots from #4 are still the result. So I think this is RTBC.

rootwork’s picture

Issue summary: View changes

Updated summary with RC phase evaluation.

xjm’s picture

Status: Reviewed & tested by the community » Needs work

This should also mention that it can use autocomplete. The equivalent text with external links is:

Start typing the title of a piece of content to select it. You can also enter an internal path such as /node/add or an external URL such as http://example.com. Enter to link to the front page.

I'm not sure on whether this change can go into 8.0.0 post-release or whether it should wait for 8.1.x. It does change the user interface in a small way in this case, but it does not break any existing strings so there's not really any disruption, and it also just plain doesn't make sense for there to be help text with the one option but not the other.

xjm’s picture

Issue summary: View changes

Also removing the note in the summary about it being a documentation change -- this is changing user interface text. "Documentation" refers to developer documentation that is never displayed on the site.

Thanks!

Mac_Weber’s picture

Status: Needs work » Needs review
FileSize
1.47 KB

Changed the text to:

'This must be an internal path such as /node/add. You can also start typing the title of a piece of content to select it. Enter <front> to link to the front page.'

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

osman’s picture

mallezie’s picture

Status: Needs review » Reviewed & tested by the community

This still apllies, works, and is clean.

  • xjm committed 1f97aeb on 8.3.x
    Issue #2474469 by Mac_Weber, rootwork, xjm: Add help text to the option...
xjm’s picture

Version: 8.2.x-dev » 8.3.x-dev
Status: Reviewed & tested by the community » Fixed
Issue tags: +String change in 8.3.0

Committed 1f97aeb and pushed to 8.3.x. Thanks!

Status: Fixed » Closed (fixed)

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