Contrib.social

Update breadcrumbs in user and views_ui help topics to use help_route_link function

Open on Drupal.org →
Created on 3 September 2022, about 2 years ago
Updated 24 February 2023, over 1 year ago

Problem/Motivation

In 🌱 [META] Fix up topics to use new help_route_link function Fixed , the patch was too large and too burdensome to review, so the issue was re-scoped and child issues created. The patches in #58 (9.5.x) 🌱 [META] Fix up topics to use new help_route_link function Fixed and #61 (10.1.x) 🌱 [META] Fix up topics to use new help_route_link function Fixed can be used as a reference.

On 📌 Make a way for help topics to generate links only if they work and are accessible Fixed , we've added two new functions for making safe links with access checks in help topics.
Related change record is https://www.drupal.org/node/3192582 →

As an example, this is how the block.place.html.twig file was updated in the patch on that issue (that was the only production topic that was updated):

-{% set layout_url = render_var(url('block.admin_display')) %}
+{% set layout_link_text %}
+{% trans %}Block layout{% endtrans %}
+{% endset %}
+{% set layout_link = render_var(help_route_link(layout_link_text, 'block.admin_display')) %}
 
...

-  <li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Structure</em> &gt; <a href="{{ layout_url }}"><em>Block layout</em></a>.{% endtrans %}</li>
+  <li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Structure</em> &gt; {{ layout_link }}.{% endtrans %}</li>

...

-  <li>{% trans %}Configure the block and click <em>Save block</em>; see <a href="{{ configure }}">Configuring a previously-placed block</a> for configuration details.{% endtrans %}</li>
+  <li>{% trans %}Configure the block and click <em>Save block</em>; see {{ configure_topic }} for configuration details.{% endtrans %}</li>

Steps to reproduce

N/A

Proposed resolution

1. Update breadcrumb links in steps or standalone "navigate to X" links in the following help topics:

  • core/modules/help_topics/help_topics/user.create.html.twig
  • core/modules/help_topics/help_topics/user.new_role.html.twig
  • core/modules/help_topics/help_topics/user.permissions.html.twig
  • core/modules/help_topics/help_topics/user.security_account_settings.html.twig
  • core/modules/help_topics/help_topics/user.update.html.twig
  • core/modules/help_topics/help_topics/views_ui.add_display.html.twig
  • core/modules/help_topics/help_topics/views_ui.create.html.twig
  • core/modules/help_topics/help_topics/views_ui.edit.html.twig

2. Ensure that no other breadcrumb links need to be updated in user or views_ui-prefixed help topics. (Search for usages of render_var(url( or uses of HTML anchor tags (for breadcrumbs only!) in those help topics.)

3. Please do NOT include any sentence-embedded links in the patch, as these will be reviewed in a separate issue with respect to translatability.

Remaining tasks

Patch, review, commit.

User interface changes

None.

API changes

None.

Data model changes

None.

Release notes snippet

Not necessary. This is an experimental module.

📌 Task
Status

Fixed

Version

10.1 ✨

Component
Help  →

Last updated 22 days ago

No maintainer
Created by

🇺🇸United States Amber Himes Matz Portland, OR USA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024