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> > <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> > {{ 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/statistics.tracking_popular_content.html.twig
- core/modules/help_topics/help_topics/system.cache.html.twig
- core/modules/help_topics/help_topics/system.config_basic.html.twig
- core/modules/help_topics/help_topics/system.config_error.html.twig
- core/modules/help_topics/help_topics/system.maintenance_mode.html.twig
- core/modules/help_topics/help_topics/system.module_install.html.twig
- core/modules/help_topics/help_topics/system.module_uninstall.html.twig
- core/modules/help_topics/help_topics/system.reports.html.twig
- core/modules/help_topics/help_topics/system.theme_install.html.twig
- core/modules/help_topics/help_topics/system.theme_uninstall.html.twig
2. Ensure that no other breadcrumb links need to be updated in statistics or system-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.
