Verified Commit 5691efb0 authored by Lee Rowlands's avatar Lee Rowlands
Browse files

Issue #3069109 by alexpott, markcarver, jhodgdon, lauriii: Replace help_topic...

Issue #3069109 by alexpott, markcarver, jhodgdon, lauriii: Replace help_topic meta tags with front matter
parent 8524be36
Loading
Loading
Loading
Loading
+1 −1
Changes for core/modules/help_topics/help_topics.module: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ function help_topics_help($route_name, RouteMatchInterface $route_match) {
      $output .= '<dt>' . t('Viewing help topics') . '</dt>';
      $output .= '<dd>' . t('The top-level help topics are listed on the main <a href=":help_page">Help page</a>. Links to other topics, including non-top-level help topics, can be found under the "Related" heading when viewing a topic page.', [':help_page' => $help_home]) . '</dd>';
      $output .= '<dt>' . t('Providing help topics') . '</dt>';
      $output .= '<dd>' . t("Modules and themes can provide help topics as Twig-file-based plugins in a project sub-directory called <em>help_topics</em>; plugin meta-data is provided in meta tags within each Twig file. Plugin-based help topics provided by modules and themes will automatically be updated when a module or theme is updated. Use the plugins in <em>core/modules/help_topics/help_topics</em> as a guide when writing and formatting a help topic plugin for your theme or module.") . '</dd>';
      $output .= '<dd>' . t("Modules and themes can provide help topics as Twig-file-based plugins in a project sub-directory called <em>help_topics</em>; plugin meta-data is provided in YAML front matter within each Twig file. Plugin-based help topics provided by modules and themes will automatically be updated when a module or theme is updated. Use the plugins in <em>core/modules/help_topics/help_topics</em> as a guide when writing and formatting a help topic plugin for your theme or module.") . '</dd>';
      $output .= '<dt>' . t('Translating help topics') . '</dt>';
      $output .= '<dd>' . t('The title and body text of help topics provided by contributed modules and themes are translatable using the <a href=":locale_help">Interface Translation module</a>. Topics provided by custom modules and themes are also translatable if they have been viewed at least once in a non-English language, which triggers putting their translatable text into the translation database.', [':locale_help' => $locale_help]) . '</dd>';
      $output .= '</dl>';
+6 −3
Changes for core/modules/help_topics/help_topics/core.config_basic.html.twig: 6 added lines, 3 removed lines.
Original line number Diff line number Diff line
<meta name="help_topic:label" content="Changing basic site settings"/>
<meta name="help_topic:top_level"/>
<meta name="help_topic:related" content="user.security_account_settings"/>
---
label: 'Changing basic site settings'
top_level: true
related:
  - user.security_account_settings
---
{% set regional_url = render_var(url('system.regional_settings')) %}
{% set information_url = render_var(url('system.site_information_settings')) %}
{% set datetime_url = render_var(url('entity.date_format.collection')) %}
+6 −2
Changes for core/modules/help_topics/help_topics/core.config_error.html.twig: 6 added lines, 2 removed lines.
Original line number Diff line number Diff line
<meta name="help_topic:label" content="Configuring error responses, including 403/404 pages"/>
<meta name="help_topic:related" content="core.config_basic,core.maintenance"/>
---
label: 'Configuring error responses, including 403/404 pages'
related:
  - core.config_basic
  - core.maintenance
---
{% set log_settings_url = render_var(url('system.logging_settings')) %}
{% set site_settings_url = render_var(url('system.site_information_settings')) %}
<h2>{% trans %}Configuring 403/404 pages{% endtrans %}</h2>
+4 −2
Changes for core/modules/help_topics/help_topics/core.maintenance.html.twig: 4 added lines, 2 removed lines.
Original line number Diff line number Diff line
<meta name="help_topic:label" content="Maintaining and troubleshooting your site"/>
<meta name="help_topic:top_level"/>
---
label: 'Maintaining and troubleshooting your site'
top_level: true
---
<p>{% trans %}The related topics listed here will help you keep your site running and troubleshoot problems.{% endtrans %}</p>
+4 −2
Changes for core/modules/help_topics/help_topics/core.menu_overview.html.twig: 4 added lines, 2 removed lines.
Original line number Diff line number Diff line
<meta name="help_topic:label" content="Defining navigation and URLs"/>
<meta name="help_topic:top_level"/>
---
label: 'Defining navigation and URLs'
top_level: true
---
<p>{% trans %}The related topics listed here describe how to set up various aspects of site navigation and URLs.{% endtrans %}</p>
Loading