Issue #2976202 by Mile23: Ensure that all description page paths are clickable

Author: Mile23

field_example/templates/description.html.twig

@@ -4,9 +4,12 @@ Description text for the Field Example.
 
 #}
 
+{% set edit_content_types = path('entity.node_type.collection')  %}
+
 {% trans %}
 
 <p>The Field Example provides a field composed of an HTML RGB value, like
-  <code>#ff00ff</code>. To use it, add the field to a content type.</p>
+<code>#ff00ff</code>. To use it, <a href={{ edit_content_types }}>add the
+field to a content type</a>.</p>
 
 {% endtrans %}

field_permission_example/templates/description.html.twig

@@ -8,21 +8,25 @@
  */
 #}
 
-<div class='examples-description'>
+{% set edit_content_types = path('entity.node_type.collection')  %}
+
 {% trans %}
-  <p>The Field Permission Example module shows how you can restrict view and edit permissions
-  within your field implementation. It adds a new field type called Fieldnote. Fieldnotes
-  appear as simple text boxes on the create/edit form, and as sticky notes when viewed.
-  By 'sticky note' we mean 'Post-It Note' but that's a trademarked term.</p>
 
-  <p>To see this field in action, add it to a content type or user profile. Go to the
-  permissions page ({{admin_link}}) and look at the 'Field Permission Example' section. This
-  allows you to change which roles can see and edit Fieldnote fields.</p>
+<p>The Field Permission Example module shows how you can restrict view and edit
+permissions within your field implementation. It adds a new field type called
+Fieldnote. Fieldnotes appear as simple text boxes on the create/edit form, and
+as sticky notes when viewed. By 'sticky note' we mean 'Post-It Note' but that's
+a trademarked term.</p>
+
+<p>To see this field in action, <a href={{ edit_content_types }}>add it to a
+content type</a> or user profile. Go to the permissions page ({{admin_link}})
+and look at the 'Field Permission Example' section. This allows you to change
+which roles can see and edit Fieldnote fields.</p>
+
+<p>Creating different users with different capabilities will let you see these
+behaviors in action. Fieldnote helpfully displays a message telling you which
+permissions it is trying to resolve for the current field/user combination.</p>
 
-  <p>Creating different users with different capabilities will let you see these behaviors
-  in action. Fieldnote helpfully displays a message telling you which permissions it is
-  trying to resolve for the current field/user combination.</p>
+<p>Definitely look through the code to see various implementation details.</p>
 
-  <p>Definitely look through the code to see various implementation details.</p>
 {% endtrans %}
-</div>

hooks_example/hooks_example.links.menu.yml

@@ -0,0 +1,5 @@
+hooks_example.description:
+  title: Hooks Example
+  description: Hook examples using Drupal hooks.
+  route_name: hooks_example.description
+  expanded: TRUE

hooks_example/hooks_example.module

@@ -75,7 +75,7 @@ function hooks_example_help($route_name, RouteMatchInterface $route_match) {
   switch ($route_name) {
     // For help overview pages we use the route help.page.$moduleName.
     case 'help.page.hooks_example':
-      return '<p>' . t('This text is provided by the function hooks_example_help(), which is an implementation of the hook hook_help(). To learn more about how this works checkout the code in hooks_example.module.') . '</p>';
+      return '<p>' . t('This text is provided by the function <code>hooks_example_help()</code>, which is an implementation of <code>hook hook_help()</code>. To learn more about how this works checkout the code in <code>hooks_example.module</code>.') . '</p>';
   }
 }
 

hooks_example/templates/description.html.twig

@@ -4,27 +4,40 @@ Description text for the Hooks Example.
 
 #}
 
+{% set help_hooks_example = path('help.page', {'name': 'hooks_example'}) %}
+{% set node_add_page = path('node.add_page') %}
+{% set user_login = path('user.login') %}
+
 {% trans %}
+
 <h2>Implementing, defining, and invoking hooks</h2>
 
 <p>The code in this module implements a couple of new features which you can see
 in action.</p>
 
-<p><strong>Implements hook_help():</strong> In hooks_example.module you'll find
-an implementation of the hook hook_help() which is used to add contents to this
-module's help overview. Visible at admin/help/hooks_example.</p>
+<p><strong>Implements <code>hook_help()</code>:</strong> In
+<code>hooks_example.module</code> you'll find an implementation of the
+<code>hook hook_help()</code> which is used to add contents to this module's
+help overview. Visible at <a href={{ help_hooks_example }}>
+<code>admin/help/hooks_example</code></a>.</p>
 
-<p><strong>View counts:</strong> hooks_example_node_view() is an implementation
-of the hook hook_ENTITY_TYPE_view() that adds a basic page view counter. You can
-see this in action by navigating to any node on the site and looking for the the
-text telling you how many times you've viewed that page.</p>
+<p><strong>View counts:</strong> <code>hooks_example_node_view()</code> is an
+implementation of the hook <code>hook_ENTITY_TYPE_view()</code> that adds a
+basic page view counter. You can see this in action by navigating to any node on
+the site and looking for the the text telling you how many times you've viewed
+that page.</p>
 
-<p><strong>Implements hook_form_alter():</strong> In hookse_example.module
-you'll find an implementation of hook_form_alter() which demonstrates the use of
-one of the most commonly used alter hooks. You can view the altered form at
-user/login.</p>
+<p>Don't have any nodes? <a href={{ node_add_page }}>Add some</a> and look at
+their counters.</p>
+
+<p><strong>Implements <code>hook_form_alter()</code>:</strong> In
+<code>hooks_example.module</code> you'll find an implementation of
+<code>hook_form_alter()</code> which demonstrates the use of one of the most
+commonly used alter hooks. You can view the altered form at
+<a href={{ user_login }}><code>user/login</code></a>.</p>
 
 <p>To learn more about how to implement an existing hook, or how to define and
-invoke a new hook start by reading the @docblock comments in
-hooks_example.module</p>
+invoke a new hook start by reading the <code>@docblock</code> comments in
+<code>hooks_example.module</code>.</p>
+
 {% endtrans %}

hooks_example/tests/src/Functional/HooksExampleTest.php

@@ -40,6 +40,10 @@ public function setUp() {
    * Test the output of the example page.
    */
   public function testHooksExample() {
+    // Make sure our menus and links work.
+    $this->drupalGet('<front>');
+    $this->assertSession()->linkExists('Hooks Example');
+
     // Test the description page at examples/hook-example returns a 200.
     $this->drupalGet('examples/hooks-example');
     $this->assertSession()->statusCodeEquals(200);

js_example/js_example.links.menu.yml

@@ -10,9 +10,11 @@ js_example.weights:
   description: Show list weighting through JavaScript.
   route_name: js_example.weights
   parent: js_example.info
+  weight: 10
 
 js_example.accordion:
   title: jQuery UI accordion
   description: jQuery UI accordion demo.
   route_name: js_example.accordion
   parent: js_example.info
+  weight: 1

js_example/templates/description.html.twig

@@ -4,20 +4,26 @@ Description text for the JavaScript Example.
 
 #}
 
+{% set js_weights = path('js_example.weights') %}
+{% set js_accordion = path('js_example.accordion') %}
+
 {% trans %}
 
 <p>Drupal includes jQuery and jQuery UI.</p>
 
 <p>We have two examples of using these:</p>
 
 <ol>
-<li>
-<p>An accordion-style section reveal effect: This demonstrates calling a jQuery
-  UI function using Drupal rendering system.
-</li>
-<li>
-<p>Sorting according to numeric weight:  This demonstrates attaching your own
-  JavaScript code to individual page elements using Drupal rendering system.</p>
-</li>
+  <li>
+    <p><a href={{ js_accordion }}>An accordion-style section reveal effect</a>:
+        This demonstrates calling a jQuery UI function using Drupal rendering
+        system.
+  </li>
+  <li>
+    <p><a href={{ js_weights }}>Sorting according to numeric weight</a>: This
+        demonstrates attaching your own JavaScript code to individual page
+        elements using Drupal rendering system.</p>
+  </li>
 </ol>
+
 {% endtrans %}

testing_example/templates/description.html.twig

@@ -4,9 +4,15 @@ Description text for the PHPUnit Example.
 
 #}
 
+{% set sum_in_hands = path('testing_example.sum_in_hands') %}
+
 {% trans %}
 <h2>Testing Frameworks in Drupal</h2>
 
+<p>This module <a href={{ sum_in_hands }}>provides a path</a> so we can test it.
+    The path takes two numeric arguments, and tells you how many hands are
+    required to count the sum of both numbers.</p>
+
 <h3>How to use this example module</h3>
 <p>You really should be reading the various docblocks in the files under
   <code>tests/src/</code>.</p>