pages and tag generator plugin.

Author: RossBugginsNHS

_config.yml

@@ -30,6 +30,11 @@ url: "https://nhsdigital.github.io" # the base hostname & protocol for your site
 twitter_username: jekyllrb
 github_username:  jekyll
 
+plugins_dir: _plugins
+#plugins:
+  #- tags
+
+safe: false
 
 collections:
   safs:

_includes/prev_next/set_prev_next.md

@@ -23,10 +23,14 @@
 {%- assign prev_site_order = site_order -%} 
 {%- assign prev_url = query_page.url | relative_url -%}
 {%- assign prev_name = query_page.title -%} 
+{%- if query_page.description -%}{%- assign prev_name = prev_name | append: ": " | append: query_page.description  -%} {%- endif -%} 
+
 {%- elsif site_order > page_site_order and site_order < next_site_order -%} 
 {%- assign next_site_order = site_order -%} 
 {%- assign next_url = query_page.url | relative_url -%} 
 {%- assign next_name = query_page.title -%} 
 
+{%- if query_page.description -%}{%- assign next_name = next_name | append: ": " | append: query_page.description  -%} {%- endif -%} 
+
 {%- endif -%} 
 {%- endfor -%}

_includes/saf.html

@@ -3,7 +3,10 @@
 {%- if page.description -%}
 <h1>{{ page.title }}:  {{ page.description }}</a></h1>
 <p><a href="{{ saf_dimension.url | relative_url  }}">{{ saf_dimension.title }}</a></p>
+
 {%- else -%}
 <h1>{{ page.title }}: <a href="{{ saf_dimension.url | relative_url  }}">{{ saf_dimension.title }}</a>  </h1>
 {%- endif -%}
+
+<p>{%- include prev_next/prev_next.md -%}</p>
 {% include saf_content.html summary_only=false saf=page %}

_includes/tags.html

@@ -2,19 +2,26 @@
 {%- assign site_saf_dimensions = site.saf_dimensions -%} 
 {%- assign site_safs = site.safs -%} 
 
-{% assign site_pages = site_pages_only | concat: site_saf_dimensions | concat: site_safs %}
+{% assign site_pages_all = site_pages_only | concat: site_saf_dimensions | concat: site_safs %}
+{% assign site_pages = site_safs %}
+
+
 
 {% assign alldocs = site_pages %}	
 
 {% assign alltags =  alldocs | map: 'tags' | join: ',' | split: ',' | where_exp: "item", "item != ''" | group_by_exp: "item", "item" %}
 
+{% assign alltags =  alltags | sort_natural: "size" | reverse %}
+
 {%- for tag in alltags -%}
-<h3> {{tag.name}}: {{tag.size}}</h3>
+
+{%- assign tag_path = "tags/" | append: tag.name  -%} 
+<h3> <a href="{{tag_path | relative_url}}"> {{tag.name}}</a>: {{tag.size}}</h3>
 
 <ul>
 {%- for doc in site_pages -%}
 {%- if doc.tags contains tag.name -%}
-<li><a href="{{doc.url | relative_url}}">{{doc.title}}</a></li>
+<li><a href="{{doc.url | relative_url}}">{{doc.title}}{%- if doc.description -%}: {{doc.description}}{%- endif -%}</a></li>
 {%- endif -%}
 {%- endfor -%}
 </ul>

_layouts/saf.html

@@ -30,7 +30,10 @@
                         nhsnotify-side-nav__item--current
                       {% endif %}
                     ">
-                  <a class="nhsnotify-side-nav__link" href="{{ site.baseurl | append: saf.url }}">{{ saf.title }}</a>
+                 {%- assign title = saf.title -%}
+                  {%- if saf.description -%}{%- assign title = title | append: ": " | append: saf.description  -%} {%- endif -%} 
+                  <a class="nhsnotify-side-nav__link" href="{{ site.baseurl | append: saf.url }}">{{ title }}</a>
+
                 </li>
                 {% endfor %}
 

_layouts/safs.html

@@ -52,7 +52,12 @@
                         nhsnotify-side-nav__item--current
                       {% endif %}
                     ">
-                  <a class="nhsnotify-side-nav__link" href="{{ site.baseurl | append: saf.url }}">{{ saf.title }}</a>
+
+                  {%- assign title = saf.title -%}
+                  {%- if saf.description -%}{%- assign title = title | append: ": " | append: saf.description  -%} {%- endif -%} 
+                  <a class="nhsnotify-side-nav__link" href="{{ site.baseurl | append: saf.url }}">{{ title }}</a>
+
+                  
                 </li>
                 {% endfor %}
                 {% endfor %}    

_plugins/tags.rb

@@ -0,0 +1,72 @@
+module SamplePlugin
+  class CategoryPageGenerator < Jekyll::Generator
+    safe true
+
+    def generate(site)
+      safs = site.collections['safs']
+      saftags = safs.docs.map { |saf| saf.data['tags'] }
+      flat = saftags.flatten
+      
+      groups = flat.group_by{ |doc| doc }.map {|k,v| [k, v.length]}
+
+      sorted_groups = groups.sort_by {|k, v| [-v, k]}
+      hashed_sorted_groups = sorted_groups.to_h
+
+      counter = 4.2
+      hashed_sorted_groups.each do |group, count|
+        site.pages << CategoryPage.new(site, group, count, counter)
+        counter += 0.01
+
+      end
+      
+    end
+  end
+
+  # Subclass of `Jekyll::Page` with custom method definitions.
+  class CategoryPage < Jekyll::Page
+    def initialize(site, group, count, counter)
+      #puts group
+      @site = site             # the current site instance.
+      @base = site.source      # path to the source directory.
+      @dir  = "tags"
+
+      # All pages have the same filename, so define attributes straight away.
+      @basename = group      # filename without the extension.
+      @ext      = '.html'      # the extension.
+      @name     = group + '.html' # basically @basename + @ext.
+
+      @excerpt = nil
+
+      safs = site.collections['safs'].docs.map {|saf| saf.data['title']}
+
+      @data = {
+        'linked_docs' => "",
+        "layout" => "page",
+        "title" => group,
+        "nav_order" => counter,
+        "tag_name" => group,
+        "tag_count" => count,
+        "safs" => safs,
+        }
+        @content = "<div>" + group + ": " + count.to_s + "</div>"
+
+        @content += "<div><ul>"
+        site.collections['safs'].docs.each do |saf|
+          if saf.data['tags'].include? group
+            @content += "<li><a href=\"..#{saf.url}\">#{saf.data['title']}</a></li>"
+          end
+        end
+        @content += "</ul></div>"
+    end
+
+    # Placeholders that are used in constructing page URL.
+    def url_placeholders
+      {
+        :path       => @dir,
+        :category   => @dir,
+        :basename   => basename,
+        :output_ext => output_ext,
+      }
+    end
+  end
+end

_safs/dm/dm02.md

@@ -1,8 +1,36 @@
 ---
 title: DM02
 dimension: decisions
-tags: []
+tags: [spend,finops]
 nav_order: 2.22
----
 
-Relevant spend control and associated CDDO & Service Design related guidance **MUST** be followed whilst developing the solution **AND MUST** be evidenced for service design & spend control reviews 
+description: Spend Control
+
+requirement: |
+    Relevant spend control and associated CDDO & Service Design related guidance **MUST** be followed whilst developing the solution and **MUST** be evidenced for service design & spend control reviews 
+
+more_info: |
+ asd
+ asd
+ **asdasd**
+ - asd 
+ - asd
+
+ asadasd
+
+examples: 
+    - title: Example 01 - Working with big data
+      content: |
+        Something
+
+technology:
+    - title: Grafana
+      content: |
+        Using Grafana
+
+further_reading:
+    - title: Google
+      content: |
+        google.com
+      url: https://www.google.com
+---

_safs/dm/dm03.md

@@ -1,8 +1,36 @@
 ---
 title: DM03
 dimension: decisions
-tags: []
+tags: [risks,issues,vibibility,ownership]
 nav_order: 2.23
----
 
-Architecture risks and issues **MUST** be managed effectively with the appropriate level of visibility and ownership 
+description: Risk Management
+
+requirement: |
+    Architecture risks and issues **MUST** be managed effectively with the appropriate level of visibility and ownership 
+
+more_info: |
+ asd
+ asd
+ **asdasd**
+ - asd 
+ - asd
+
+ asadasd
+
+examples: 
+    - title: Example 01 - Working with big data
+      content: |
+        Something
+
+technology:
+    - title: Grafana
+      content: |
+        Using Grafana
+
+further_reading:
+    - title: Google
+      content: |
+        google.com
+      url: https://www.google.com
+---

_safs/dm/dm04.md

@@ -1,8 +1,36 @@
 ---
 title: DM04
 dimension: decisions
-tags: []
+tags: [involvement]
 nav_order: 2.24
----
 
-There **MUST** be effective and commensurate stakeholder involvement with respects to solution design and architecture decisions. 
+description: Stakeholder Involvement
+
+requirement: |
+    There **MUST** be effective and commensurate stakeholder involvement with respects to solution design and architecture decisions. 
+
+more_info: |
+ asd
+ asd
+ **asdasd**
+ - asd 
+ - asd
+
+ asadasd
+
+examples: 
+    - title: Example 01 - Working with big data
+      content: |
+        Something
+
+technology:
+    - title: Grafana
+      content: |
+        Using Grafana
+
+further_reading:
+    - title: Google
+      content: |
+        google.com
+      url: https://www.google.com
+---