govuk_publishing_components 9.28.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd97893a0b544cc658d03a410175d5f5bef9173a23368563ad0b1bfc3a3f1e98
-  data.tar.gz: 380f25942322cee9c5efb96fa977faf46ae5597dddf5012333f99a294946df6a
+  metadata.gz: eedc7db41f2d178ff05e1905a8eb380dd37140a8a0ed8c8e35adce4843820dcd
+  data.tar.gz: 02b05d72c20971d88bff48a36c42a910e8bf9882c4e9a88d827a9d4a5b399ae0
 SHA512:
-  metadata.gz: 97c7bf5aa73ddb895bd8cf6457d5f0f0d18f3ea7aa06f52a9e4d5a2aa51dd3472f8340fd4ebc263976d2d02aae75579d33968288970a167756f8401d1ba7a50b
-  data.tar.gz: 32476ad88ae096153c99d1fd6ecb9036d1c69e9bd24b6c888986aa0ff32183d4944ee9ac348ec8400946cb97ccfbcafb1b3e381386f2ce5a227a273658fdb932
+  metadata.gz: 61fd9a082433a65c367b1e9f56b50d417bfcf1b1479e0830c2be22d7b63af18e91b923058be1d057e104a5bd7587b1e4d59a5887325f116712fa714729431341
+  data.tar.gz: 97c87c351d487aec51b61d9a9e2f6a696d21c6bf219ef94340be088d6f5e368b1692bcab27ecf6e204208d108188c3c7c46fd74549a13c679ee3012375c79e3b

data/app/views/govuk_publishing_components/components/docs/related_navigation.yml

@@ -1,5 +1,5 @@
 name: Related Navigation
-description: Component showing related content, including topics, guidance, collections and policies (where applicable)
+description: Component showing related content, including topics, guidance and collections
 accessibility_criteria: |
   - Should have a role of 'navigation' on any navigation elements inside the component
   - Should be marked up as navigation and not as tangential content
@@ -41,16 +41,6 @@ examples:
           - title: The future of jobs and skills
             base_path: /government/collections/the-future-of-jobs-and-skills
             document_type: document_collection
-  with_policies:
-    data:
-      links:
-        related_policies:
-          - title: Further education and training
-            base_path: /government/policies/further-education-and-training
-            document_type: policy
-          - title: Primary school education
-            base_path: /government/policies/primary-school-education
-            document_type: policy
   with_topical_events:
     data:
       links:
@@ -151,10 +141,6 @@ examples:
           - title: The future of jobs and skills
             base_path: /government/collections/the-future-of-jobs-and-skills
             document_type: document_collection
-        related_policies:
-          - title: Further education and training
-            base_path: /government/policies/further-education-and-training
-            document_type: policy
         world_locations:
           - title: South Sudan
             base_path: /world/south-sudan/news

data/app/views/govuk_publishing_components/components/docs/step_by_step_nav.yml

@@ -403,6 +403,87 @@ examples:
           ]
         }
       ]
+  tracking_the_user_journey_through_the_query_string:
+    description: |
+      When the step by step pattern was first introduced, one of the problems we noticed was that if a content page is in more than one step by step journey, it wasn't practical to expand all of the step by steps, as the sidebar became very long.
+
+      We solved this problem in a few ways:
+
+      1. Only show a list of titles for the step by steps that the content page is part of.
+      2. Only display this list if the content item is part of fewer than 5 step by step journeys
+      3. Allow content designers to optionally hide a step by step journey on content pages.
+
+      The consequence of this is that if users land on any of these pages, they lose sight of the journey they are on, and which step of the journey they have reached (the black dot).
+
+      The solution is to track the step by step journey the user is on.
+
+      This has been achieved by adding a query string to all of the internal links in the step by step that contains the content_id of the step by step.
+
+      For example, if the step by step contains a link to [/check-uk-visa](/check-uk-visa), the component will renders the link as [/check-uk-visa?step-by-step-nav=d8f3c2e0-d544-4664-9616-ab71323e4d18](/check-uk-visa?step-by-step-nav=d8f3c2e0-d544-4664-9616-ab71323e4d18)
+
+      As long as the user follows the links in the step by step (and not the inline links in the content), the component will know which step by step journey the user is on.
+
+      If the content item is part of multiple step by steps, the component fetches the content_id of the `active` step by step from the query string and expands that one. The other step by steps that the content item is part of are displayed as a list of titles under an "Also part of" heading.
+
+      Additionally, if content designers have chosen to "hide" a step by step on a content page, but we can see that the user is following a step by step journey (the content_id of the step by step is in the querystring), the step by step will still be displayed and expanded in the sidebar, and the other step by steps that the content item is part of, but content designers have chosen to hide will also be displayed as a list of titles under an "Also part of heading".
+
+      In both cases, we never show more than 5 step by steps in the list.
+
+      If the user lands on the content page "cold", i.e. from Google, and not from the step by step sidebar (or overview page), the original rules for the displaying the step by step sidebar will apply.
+
+      The rules are as follows:
+
+      1. Content item is part of one step by step
+
+          Expand the step by step in the sidebar
+
+      2. Content item is part of multiple step by steps
+
+          Show a list of step by steps under the "Part of" heading
+
+      3. Step by step is marked as "hidden" for the content page
+
+          Do not display the step by step
+
+      Changes to the rules when the user is on a step by step journey (the query string is in the url):
+
+      1. Content item is part of one step by step
+
+          No change, expand the step by step in the sidebar
+
+      2. Content item is part of multiple step by steps
+
+          Expand the step by step in the querystring
+
+          Show a list of the other step by steps under an "Also part of" heading, if the content item is part of less than 5 step by step journeys
+
+      3. Step by step is marked as "hidden" for the content page
+
+          Expand the step by step in the querystring
+
+          Show a list of the other step by steps (including other step by steps that have been marked as "hidden") under an "Also part of" heading, if the content item is part of less than 5 step by step journeys
+    data:
+      tracking_id: "this-is-the-content-id"
+      steps: [
+        {
+          title: "With query string",
+          contents: [
+            {
+              type: 'list',
+              contents: [
+                {
+                  href: '/component-guide/step_by_step_navigation/with_links/preview?step-by-step-nav=this-is-the-content-id',
+                  text: 'This is an internal link with a query string',
+                },
+                {
+                  href: 'http://google.com',
+                  text: 'This is an external link without a query string'
+                }
+              ]
+            }
+          ]
+        }
+      ]
   with_optional_steps:
     description: |
       Steps can be optional. This is controlled by two parameters, 'optional' and 'logic'.

data/lib/govuk_publishing_components/presenters/content_item.rb

@@ -90,10 +90,6 @@ module GovukPublishingComponents
         filter_link_type(content_store_response.dig("links", "organisations").to_a, "organisation")
       end
 
-      def related_policies
-        filter_link_type(content_store_response.dig("links", "related_policies").to_a, "policy")
-      end
-
       def related_statistical_data_sets
         filter_link_type(content_store_response.dig("links", "related_statistical_data_sets").to_a, "statistical_data_set")
       end

data/lib/govuk_publishing_components/presenters/related_navigation_helper.rb

@@ -8,7 +8,6 @@ module GovukPublishingComponents
         related_guides
         topics
         collections
-        policies
         topical_events
         world_locations
         statistical_data_sets
@@ -24,7 +23,6 @@ module GovukPublishingComponents
           "related_guides" => related_guides,
           "collections" => related_collections,
           "topics" => related_topics,
-          "policies" => related_policies,
           "topical_events" => related_topical_events,
           "world_locations" => related_world_locations,
           "statistical_data_sets" => related_statistical_data_sets,
@@ -106,11 +104,6 @@ module GovukPublishingComponents
         end
       end
 
-      def related_policies
-        policies = filter_link_type("related_policies", "policy")
-        build_links_for_sidebar(policies)
-      end
-
       def related_statistical_data_sets
         statistical_data_sets = filter_link_type("related_statistical_data_sets", "statistical_data_set")
         build_links_for_sidebar(statistical_data_sets)

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '9.28.0'.freeze
+  VERSION = '10.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 9.28.0
+  version: 10.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config