colour coding should and musts. Added extra meta data support. see NF examples.

Author: RossBugginsNHS

_data/primary-navigation.yml

@@ -1,13 +1,15 @@
 - title: Home
   link: /
 
-
 - title: Guidance
   link: /guidance/
 
 - title: The Framework
   link: /safs/
 
+- title: Tags
+  link: /tags/
+
 - title: Dimensions
   link: /saf_dimensions/
 

_includes/saf.html

@@ -1,3 +1,9 @@
 {% include construction.html %}
-<h1>{{ page.title }}:  <a href="{{ saf_dimension.url | relative_url  }}">{{ saf_dimension.title }}</a>  </h1>
-{{ content }}
+
+{%- 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 -%}
+{% include saf_content.html summary_only=false saf=page %}

_includes/saf_content.html

@@ -0,0 +1,7 @@
+
+{% assign saf_to_render = include.saf %}
+{% if include.summary_only == true %}
+  {% include saf_content_summary.html saf=saf_to_render %}
+{% else %}
+  {% include saf_content_full.html saf=saf_to_render %}
+{% endif %}

_includes/saf_content_full.html

@@ -0,0 +1,68 @@
+{% assign saf_to_render = include.saf %}
+
+{% if saf_to_render.requirement != null %}
+  <div>
+  <h2>Requirement</h2>
+  {{ saf_to_render.requirement | markdownify }}
+  </div>
+{% endif %}
+
+{% if saf_to_render.more_info != null %}
+  <div>
+  <h2>More information</h2>
+  {{ saf_to_render.more_info | markdownify }}
+  </div>
+{% endif %}
+
+{% if saf_to_render.examples != null %}
+  <div>
+  <h2>Examples</h2>
+  {% for example in saf_to_render.examples %}
+    <div>
+      <h3>{{ example.title }}</h3>
+      {{ example.content | markdownify }}
+    </div>
+  {% endfor %}
+  </div>
+{% endif %}
+
+{% if saf_to_render.technology != null %}
+  <div>
+  <h2>Technology</h2>
+  {% for technology in saf_to_render.technology %}
+    <div>
+      <h3>{{ technology.title }}</h3>
+      {{ technology.content | markdownify }}
+    </div>
+  {% endfor %}
+  </div>
+{% endif %}
+
+{% if saf_to_render.further_reading != null %}
+  <div>
+  <h2>Further Reading</h2>
+  {% for reading in saf_to_render.further_reading %}
+    <div>
+      <h3>
+        {% if reading.url %}
+          <a href="{{reading.url | relative_url}}">
+        {% endif %}
+            {{ reading.title }} 
+        {% if reading.url %}
+          </a>
+        {% endif %}
+        </h3>
+      {{ reading.content | markdownify }}
+    </div>
+  {% endfor %}
+  </div>
+{% endif %}
+
+{% assign content =  saf_to_render.content  %}
+{% assign requirement = saf_to_render.requirement | markdownify %}
+
+{% if content != requirement %}
+  <div>
+  {{ content }}
+  </div>
+{% endif %}

_includes/saf_content_summary.html

@@ -0,0 +1,2 @@
+{% assign saf_to_render = include.saf %}
+{{saf_to_render.requirement | default: saf_to_render.content  | markdownify | remove: '<p>' | remove: '</p>' }}

_includes/saf_dimension.html

@@ -12,7 +12,7 @@
     </a>
   </td>
   <td>
-    {{saf.content | markdownify | remove: '<p>' | remove: '</p>' }}
+    {{saf.requirement | default: saf.content  | markdownify | remove: '<p>' | remove: '</p>' }}
   </td>
 </tr>
 

_includes/safs.html

@@ -8,13 +8,14 @@ <h3>  <a href="{{ saf_dimension.url | relative_url }}">{{saf_dimension.title}}</
 {% continue %}
 {% endif %}
 <tr>
-  <td>
+  <td {%- if saf.requirement -%} {%- if saf.requirement contains '**MUST**' %} style="background-color: red;" {%- elsif saf.requirement contains '**SHOULD**' %} style="background-color: orange;" {%- else %} style="background-color: blue;" {%- endif -%}{%- endif -%}>
     <a href="{{ saf.url | relative_url }}">
       {{ saf.title }}
     </a>
   </td>
-  <td>
-    {{saf.content | markdownify | remove: '<p>' | remove: '</p>' }}
+  <td >
+
+    {% include saf_content.html summary_only=true saf=saf %}
   </td>
 </tr>
 {% endfor %}

_includes/tags.html

@@ -0,0 +1,22 @@
+{%- assign site_pages_only = site.pages -%} 
+{%- 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 alldocs = site_pages %}	
+
+{% assign alltags =  alldocs | map: 'tags' | join: ',' | split: ',' | where_exp: "item", "item != ''" | group_by_exp: "item", "item" %}
+
+{%- for tag in alltags -%}
+<h3> {{tag.name}}: {{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>
+{%- endif -%}
+{%- endfor -%}
+</ul>
+{%- endfor -%}
+

_safs/d/d01.md

@@ -1,7 +1,7 @@
 ---
 title: D01
 dimension: documentation
-tags: [req]
+tags: []
 nav_order: 2.71
 ---
 

_safs/dm/dm01.md

@@ -1,7 +1,7 @@
 ---
 title: DM01
 dimension: decisions
-tags: [saf,DM]
+tags: []
 nav_order: 2.21
 ---