Problem/Motivation

The functionality of the Link module has changed since the hook_help text got committed.
There now is an option to restrict links to internal or external links as "Allowed link type"

Proposed resolution

Add another use to describe the Allowed link type option.

Remaining tasks

User interface changes

API changes

CommentFileSizeAuthor
#7 drupal_core-update_hook_help_link_2470960-7.patch1.42 KBmeramo
#6 drupal_core-update_hook_help_link_2470960-6.patch1.42 KBmeramo
#4 link_help.png23.48 KBReno Greenleaf
#3 drupal_core-update_hook_help_link_2470960-3.patch1.42 KBmeramo
#1 drupal_core-update_hook_help_link_2470960-1.patch2.38 KBmeramo

Comments

meramo’s picture

meramo commented
Status: Active » Needs review
Issue tags: +drupaldevdays
StatusFileSize
new drupal_core-update_hook_help_link_2470960-1.patch2.38 KB

See the patch

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Thanks for the patch! It's a good start... a couple of comments:

  1. +++ b/core/modules/link/link.module
@@ -23,8 +23,12 @@ function link_help($route_name, RouteMatchInterface $route_match) {
+      $output .= '<dd>' . t('In the field settings you can define the allowed link type to be <em>internal links only</em>, <em>external links only</em> or <em>both internal and external links</em>. <em>Internal links only</em> and <em>both internal and external links</em> options enable an easy interface for internal linking by using an autocomplete widget, so a user does not have to copy or remember a URL.') . '</dd>';

    We use serial commas in Drupal docs. So before "or" you need a ,

    Also ... we don't normally want to tell people that something is "easy". Better to be descriptive of the interface. Is it an auto-complete interface? or ... something like that. 

  2. +++ b/core/modules/link/link.module
@@ -23,8 +23,12 @@ function link_help($route_name, RouteMatchInterface $route_match) {
+      $output .= '<dt>' . t('Setting the link type') . '</dt>';
+      $output .= '<dd>' . t('You can set the link type to be internal, external or both by changing the ') . '</dd>';
       $output .= '<dt>' . t('Adding attributes to links') . '</dt>';

    I think these two lines are extra, given that you added something similar above?

meramo’s picture

meramo commented
Status: Needs work » Needs review
StatusFileSize
new drupal_core-update_hook_help_link_2470960-3.patch1.42 KB

Whoops, my bad!
Resubmitting the amended patch.

Reno Greenleaf’s picture

Reno Greenleaf commented
StatusFileSize
new link_help.png23.48 KB

Checked last patch.
Looks fine.
Screenshot

ifrik’s picture

ifrik
she/her
commented
Status: Needs review » Needs work

Thanks Igor Kandyba,

just one tiny thing. "internal linking" sounds a bit akward.
"enable an autocomplete widget for internal links." should be sufficient. Don't worry about repeating the existing wording from the interface text.

meramo’s picture

meramo commented
StatusFileSize
new drupal_core-update_hook_help_link_2470960-6.patch1.42 KB

Good spot!

meramo’s picture

meramo commented
StatusFileSize
new drupal_core-update_hook_help_link_2470960-7.patch1.42 KB

Sorry, haven't uploaded the file

meramo’s picture

meramo commented
Status: Needs work » Needs review

Setting for review.

ifrik’s picture

ifrik
she/her
commented
Status: Needs review » Reviewed & tested by the community

Thanks!

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Reviewed & tested by the community » Fixed

Yay docs! :)

Committed and pushed to 8.0.x. Thanks!

  • webchick committed 115617d on 8.0.x 
    Issue #2470960 by Igor Kandyba, Reno Greenleaf, ifrik, jhodgdon: Update...

Status: Fixed » Closed (fixed)

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