From 25a16daba1873361b4616c71618059bd6ba0e53e Mon Sep 17 00:00:00 2001
From: alshapton <alshapton@gmail.com>
Date: Wed, 10 Aug 2022 09:05:46 +0100
Subject: [PATCH 1/6] Added new --heading option to change ADR page heading,
 also fixed mission --template-dir option from README.md

---
 README.md                       | 12 +++++++-----
 adr_viewer/__init__.py          | 28 +++++++++++++++++-----------
 adr_viewer/templates/index.html |  4 ++--
 3 files changed, 26 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 27199d1..f784301 100644
--- a/README.md
+++ b/README.md
@@ -35,11 +35,13 @@ $ python setup.py install
 Usage: adr-viewer [OPTIONS]
 
 Options:
-  --adr-path TEXT  Directory containing ADR files.  [default: doc/adr/]
-  --output TEXT    File to write output to.  [default: index.html]
-  --serve          Serve content at http://localhost:8000/
-  --port INT       Custom server port [default: 8000]
-  --help           Show this message and exit.
+  --adr-path TEXT      Directory containing ADR files.  [default: doc/adr/]
+  --output TEXT        File to write output to.  [default: index.html]
+  --serve              Serve content at http://localhost:8000/
+  --port INTEGER       Change port for the server  [default: 8000]
+  --template-dir TEXT  Template directory
+  --heading TEXT       ADR Page Heading [default: ADR Viewer - ]
+  --help               Show this message and exit
 ```
 
 The default for `--adr-path` is `doc/adr/` because this is the default path generated by `adr-tools`.
diff --git a/adr_viewer/__init__.py b/adr_viewer/__init__.py
index 8093691..adddbf6 100644
--- a/adr_viewer/__init__.py
+++ b/adr_viewer/__init__.py
@@ -46,7 +46,7 @@ def parse_adr_to_config(path):
     header = soup.find('h1')
 
     if header:
-          return {
+        return {
                 'status': status,
                 'body': adr_as_html,
                 'title': header.text
@@ -80,15 +80,17 @@ def run_server(content, port):
     run(app, host='localhost', port=port, quiet=True)
 
 
-def generate_content(path, template_dir_override=None):
+def generate_content(path, template_dir_override=None, heading=None):
 
     files = get_adr_files("%s/*.md" % path)
 
+    if not heading:
+        heading = 'ADR Viewer - ' + os.path.basename(os.getcwd())
+
     config = {
-        'project_title': os.path.basename(os.getcwd()),
+        'heading': heading,
         'records': []
     }
-
     for index, adr_file in enumerate(files):
 
         adr_attributes = parse_adr_to_config(adr_file)
@@ -104,16 +106,20 @@ def generate_content(path, template_dir_override=None):
 
 
 @click.command()
-@click.option('--adr-path',      default='doc/adr/',   help='Directory containing ADR files.',         show_default=True)
-@click.option('--output',        default='index.html', help='File to write output to.',                show_default=True)
-@click.option('--serve',         default=False,        help='Serve content at http://localhost:8000/', is_flag=True)
-@click.option('--port',          default=8000,         help='Change port for the server',              show_default=True)
-@click.option('--template-dir',  default=None,         help='Template directory.',                     show_default=True)
-def main(adr_path, output, serve, port, template_dir):
-    content = generate_content(adr_path, template_dir)
+@click.option('--adr-path',      default='doc/adr/',      help='Directory containing ADR files.',         show_default=True)
+@click.option('--output',        default='index.html',    help='File to write output to.',                show_default=True)
+@click.option('--serve',         default=False,           help='Serve content at http://localhost:8000/', is_flag=True)
+@click.option('--port',          default=8000,            help='Change port for the server',              show_default=True)
+@click.option('--template-dir',  default=None,            help='Template directory.',                     show_default=True)
+@click.option('--heading',       default='ADR Viewer - ', help='ADR Page Heading',                        show_default=True)
+def main(adr_path, output, serve, port, template_dir, heading):
+    content = generate_content(adr_path, template_dir, heading)
 
     if serve:
         run_server(content, port)
     else:
         with open(output, 'w') as out:
             out.write(content)
+
+if __name__ == '__main__':
+    main()
\ No newline at end of file
diff --git a/adr_viewer/templates/index.html b/adr_viewer/templates/index.html
index 6f5639b..07db540 100644
--- a/adr_viewer/templates/index.html
+++ b/adr_viewer/templates/index.html
@@ -6,7 +6,7 @@
         <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
         <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script>
         <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.2.0/css/all.css">
-        <title>ADR Viewer - {{ config.project_title }}</title>
+        <title>{{ config.heading }}</title>
 
         <style type="text/css">
             body {
@@ -63,7 +63,7 @@
     </head>
     <body>
         <header>
-            <h1>ADR Viewer - {{ config.project_title }}</h1>
+            <h1>{{ config.heading }}</h1>
         </header>
         <div class="panel-group">
             {% for adr_record in config.records %}

From 08c406d8eb0eea3d59b001c942e62000b82034a1 Mon Sep 17 00:00:00 2001
From: alshapton <alshapton@gmail.com>
Date: Thu, 11 Aug 2022 13:13:38 +0100
Subject: [PATCH 2/6] (feature): Introduced ability to use a configuration file
 for the colours of bars etc)

---
 .gitignore                      |  3 +-
 CHANGELOG.md                    | 57 +++++++++++++++++++++++++
 README.md                       |  7 +--
 adr_viewer/__init__.py          | 75 ++++++++++++++++++++++++++-------
 adr_viewer/config.toml          | 23 ++++++++++
 adr_viewer/templates/index.html | 12 +++---
 6 files changed, 152 insertions(+), 25 deletions(-)
 create mode 100644 CHANGELOG.md
 create mode 100644 adr_viewer/config.toml

diff --git a/.gitignore b/.gitignore
index 32fc916..e2075ba 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,4 +3,5 @@ venv/
 dist/
 build/
 adr_viewer.egg-info/
-.pytest_cache/
\ No newline at end of file
+.pytest_cache/
+.DS_Store
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..775b1c4
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,57 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [1.3.0](https://pypi.org/project/adr-viewer/1.3.0/) - 2022-02-28
+
+### Added
+- Ignore badly-formed ADR files and report
+- Allow template override and pass in a teplate directory
+- Customizing server port
+
+### Fixed
+- Some typos
+
+### Removed
+- Support for Python 2.7
+
+## [1.2.0](https://pypi.org/project/adr-viewer/1.2.0/) - 2019-06-19
+
+### Added
+- Support for Pending ADRs
+
+## [1.1.1](https://pypi.org/project/adr-viewer/1.1.1/) - 2019-02-26
+
+### Added
+- Python 3 support
+
+
+### Fixed
+- Included HTML file in package
+
+## [1.1.0](https://pypi.org/project/adr-viewer/1.1.0/) - 2018-09-10
+
+### Added
+- Pypi release details
+- Accepted records are green
+- Superceded records are now grey and have their titles struck through
+- Records with unknown state default to white
+- Amended records are yellow
+- Since multiple statuses are possible in ADR files, we now extract all `p` objects below the Status header and use those for deciding on which style to apply
+- Statuses also now represented by icons (colour-blindness)
+- Created and updated this project's ADRs and visualised them
+- Improved `README.md`
+
+## [1.0.1](https://pypi.org/project/adr-viewer/1.0.1/) - 2018-09-02
+
+### Added
+- Classifiers to `setup.py`
+
+
+## [1.0.0](https://pypi.org/project/adr-viewer/1.0.0/) - 2018-09-02
+
+### Initial Release
+
diff --git a/README.md b/README.md
index f784301..8704d83 100644
--- a/README.md
+++ b/README.md
@@ -39,9 +39,10 @@ Options:
   --output TEXT        File to write output to.  [default: index.html]
   --serve              Serve content at http://localhost:8000/
   --port INTEGER       Change port for the server  [default: 8000]
-  --template-dir TEXT  Template directory
-  --heading TEXT       ADR Page Heading [default: ADR Viewer - ]
-  --help               Show this message and exit
+  --template-dir TEXT  Template directory.
+  --heading TEXT       ADR Page Heading  [default: ADR Viewer - ]
+  --config TEXT        Configuration settings  [default: config.toml]
+  --help               Show this message and exit.
 ```
 
 The default for `--adr-path` is `doc/adr/` because this is the default path generated by `adr-tools`.
diff --git a/adr_viewer/__init__.py b/adr_viewer/__init__.py
index adddbf6..32fce41 100644
--- a/adr_viewer/__init__.py
+++ b/adr_viewer/__init__.py
@@ -1,11 +1,14 @@
-import glob
-from jinja2.loaders import FileSystemLoader
-import mistune
 import os
+import glob
+import toml
+import ast
+
+from bottle import Bottle, run
 from bs4 import BeautifulSoup
-from jinja2 import Environment, PackageLoader, select_autoescape
 import click
-from bottle import Bottle, run
+from jinja2 import Environment, PackageLoader, select_autoescape
+from jinja2.loaders import FileSystemLoader
+import mistune
 
 
 def extract_statuses_from_adr(page_object):
@@ -58,7 +61,7 @@ def parse_adr_to_config(path):
 def render_html(config, template_dir_override=None):
 
     env = Environment(
-        loader=PackageLoader('adr_viewer', 'templates') if template_dir_override is None else FileSystemLoader(template_dir_override),
+        loader = PackageLoader('adr_viewer', 'templates') if template_dir_override is None else FileSystemLoader(template_dir_override),
         autoescape=select_autoescape(['html', 'xml'])
     )
 
@@ -80,7 +83,8 @@ def run_server(content, port):
     run(app, host='localhost', port=port, quiet=True)
 
 
-def generate_content(path, template_dir_override=None, heading=None):
+def generate_content(path, template_dir_override=None,
+                     heading=None, configuration=None):
 
     files = get_adr_files("%s/*.md" % path)
 
@@ -91,6 +95,30 @@ def generate_content(path, template_dir_override=None, heading=None):
         'heading': heading,
         'records': []
     }
+
+    # Set defaults for colours (or use passed in configuration)
+    conf = {}
+    if type(configuration) == type(None):
+        conf = ast.literal_eval('{ \
+        "accepted": {"background-color": "lightgreen"}, \
+        "amended": {"background-color": "yellow"}, \
+        "pending": {"background-color": "lightblue"}, \
+        "superseded": { \
+            "background-color": "lightgrey", \
+            "text-decoration": "line-through"}, \
+        "unknown": {"background-color": "white"}}')
+    else:
+        conf = configuration['status']
+
+    print(type(conf))
+    print(conf)
+    # Retrieve properties from configuration
+    for status in conf:
+        properties = {}
+        for property in conf[status]:
+            properties[property] = conf[status][property]
+        config[status] = properties
+
     for index, adr_file in enumerate(files):
 
         adr_attributes = parse_adr_to_config(adr_file)
@@ -106,14 +134,30 @@ def generate_content(path, template_dir_override=None, heading=None):
 
 
 @click.command()
-@click.option('--adr-path',      default='doc/adr/',      help='Directory containing ADR files.',         show_default=True)
-@click.option('--output',        default='index.html',    help='File to write output to.',                show_default=True)
-@click.option('--serve',         default=False,           help='Serve content at http://localhost:8000/', is_flag=True)
-@click.option('--port',          default=8000,            help='Change port for the server',              show_default=True)
-@click.option('--template-dir',  default=None,            help='Template directory.',                     show_default=True)
-@click.option('--heading',       default='ADR Viewer - ', help='ADR Page Heading',                        show_default=True)
-def main(adr_path, output, serve, port, template_dir, heading):
-    content = generate_content(adr_path, template_dir, heading)
+@click.option('--adr-path',      default='doc/adr/',
+              help='Directory containing ADR files.', show_default=True)
+@click.option('--output',        default='index.html',
+              help='File to write output to.', show_default=True)
+@click.option('--serve',         default=False,
+              help='Serve content at http://localhost:8000/', is_flag=True)
+@click.option('--port',          default=8000,
+              help='Change port for the server', show_default=True)
+@click.option('--template-dir',  default=None,
+              help='Template directory.', show_default=True)
+@click.option('--heading',       default='ADR Viewer - ',
+              help='ADR Page Heading', show_default=True)
+@click.option('--config',        default='config.toml',
+              help='Configuration settings', show_default=True)
+def main(adr_path, output, serve, port, template_dir, heading, config):
+    from os.path import exists
+    # Ensure that there is a configuration file
+    if exists(config):
+        configuration_file = toml.load(config)
+    else:
+        configuration_file = None
+
+    content = generate_content(adr_path, template_dir,
+                               heading, configuration_file)
 
     if serve:
         run_server(content, port)
@@ -121,5 +165,6 @@ def main(adr_path, output, serve, port, template_dir, heading):
         with open(output, 'w') as out:
             out.write(content)
 
+
 if __name__ == '__main__':
     main()
\ No newline at end of file
diff --git a/adr_viewer/config.toml b/adr_viewer/config.toml
new file mode 100644
index 0000000..3bf9911
--- /dev/null
+++ b/adr_viewer/config.toml
@@ -0,0 +1,23 @@
+# Configuration for adr-viewer
+# in TOML format http://toml.io
+
+title = "TOML Configuration for adr-viewer look and feel"
+
+[status]
+# Properties for the bars that display each ADR 
+
+# Accepted
+accepted.background-color   = "lightgreen"
+
+# Amended
+amended.background-color    = "yellow"
+
+# Pending
+pending.background-color    = "lightblue"
+
+# Superseded
+superseded.background-color = "lightgrey"
+superseded.text-decoration  = "line-through"
+
+# Unknown
+unknown.background-color    = "white"
diff --git a/adr_viewer/templates/index.html b/adr_viewer/templates/index.html
index 07db540..af33b8d 100644
--- a/adr_viewer/templates/index.html
+++ b/adr_viewer/templates/index.html
@@ -33,27 +33,27 @@
             }
 
             .panel-heading.adr-accepted {
-                background-color: lightgreen;
+                background-color: {{ config.accepted['background-color'] }};
             }
 
             .panel-heading.adr-superseded {
-                background-color: lightgrey;
+                background-color: {{ config.superseded['background-color'] }};
             }
 
             .panel-heading.adr-amended {
-                background-color: yellow;
+                background-color: {{ config.amended['background-color'] }};
             }
 
             .panel-heading.adr-unknown {
-                background-color: white;
+                background-color: {{ config.unknown['background-color'] }};
             }
 
             .panel-heading.adr-pending {
-                background-color: lightblue;
+                background-color: {{ config.pending['background-color'] }};
             }
 
             .adr-superseded > .panel-title > a {
-                text-decoration: line-through;
+                text-decoration: {{ config.superseded['text-decoration'] }};
             }
 
             .adr-icon {

From 5559eba095e1bed1f47729110c52b4fa08a464ca Mon Sep 17 00:00:00 2001
From: alshapton <alshapton@gmail.com>
Date: Thu, 11 Aug 2022 17:44:46 +0100
Subject: [PATCH 3/6] Updated to include ability to change the background
 colour of the ADR page

---
 README.md                       | 44 +++++++++++++++++++++++++++++++++
 adr_viewer/__init__.py          | 11 +++++----
 adr_viewer/config.toml          |  4 +++
 adr_viewer/templates/index.html |  1 +
 4 files changed, 55 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 8704d83..2ce902f 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,50 @@ Options:
   --help               Show this message and exit.
 ```
 
+The configuration file (in [TOML](http://toml.io) format) has settings that control the look of the ADR page. These settings are specifically targetted at the colours of the page to aid with those who have colour-blindness.
+
+The colours (the example used here is `green`) can be specified in a number of formats:
+
+  - Hex values: #00FF00
+  - HTML Colour codes: Green
+  - RGB values: rgb(0,255,0)
+  - RGB with alpha: rgba(0,255,0,0)
+  - HSL values: hsl(0,100%,50%)
+  - HSL with alpha: hsla(0,100%,50%,0)
+
+More information about codes and names for HTML colours can be found [here](http://htmlcolorcodes.com).
+
+```bash
+# Configuration for adr-viewer
+# in TOML format http://toml.io
+
+title = "TOML Configuration for adr-viewer colours"
+
+[page]
+# Properties for the page
+background-color            = "white"
+
+[status]
+# Properties for the bars that display each ADR 
+
+# Accepted
+accepted.background-color   = "#00FF00"
+
+# Amended
+amended.background-color    = "yellow"
+
+# Pending
+pending.background-color    = "lightblue"
+
+# Superseded
+superseded.background-color = "lightgrey"
+superseded.text-decoration  = "line-through"
+
+# Unknown
+unknown.background-color    = "white"
+
+```
+
 The default for `--adr-path` is `doc/adr/` because this is the default path generated by `adr-tools`.
 
 ## Supported Record Types
diff --git a/adr_viewer/__init__.py b/adr_viewer/__init__.py
index 32fce41..927e599 100644
--- a/adr_viewer/__init__.py
+++ b/adr_viewer/__init__.py
@@ -1,5 +1,6 @@
 import os
 import glob
+from re import M
 import toml
 import ast
 
@@ -93,9 +94,9 @@ def generate_content(path, template_dir_override=None,
 
     config = {
         'heading': heading,
-        'records': []
+        'records': [],
+        'page': []
     }
-
     # Set defaults for colours (or use passed in configuration)
     conf = {}
     if type(configuration) == type(None):
@@ -107,11 +108,11 @@ def generate_content(path, template_dir_override=None,
             "background-color": "lightgrey", \
             "text-decoration": "line-through"}, \
         "unknown": {"background-color": "white"}}')
+        config['page'] = ast.literal_eval('{"background-color": "white"}')
     else:
         conf = configuration['status']
+        config['page'] = configuration['page']
 
-    print(type(conf))
-    print(conf)
     # Retrieve properties from configuration
     for status in conf:
         properties = {}
@@ -146,7 +147,7 @@ def generate_content(path, template_dir_override=None,
               help='Template directory.', show_default=True)
 @click.option('--heading',       default='ADR Viewer - ',
               help='ADR Page Heading', show_default=True)
-@click.option('--config',        default='config.toml',
+@click.option('--config',        default='config2.toml',
               help='Configuration settings', show_default=True)
 def main(adr_path, output, serve, port, template_dir, heading, config):
     from os.path import exists
diff --git a/adr_viewer/config.toml b/adr_viewer/config.toml
index 3bf9911..503c3b8 100644
--- a/adr_viewer/config.toml
+++ b/adr_viewer/config.toml
@@ -3,6 +3,10 @@
 
 title = "TOML Configuration for adr-viewer look and feel"
 
+[page]
+# Properties for the page
+background-color            = "white"
+
 [status]
 # Properties for the bars that display each ADR 
 
diff --git a/adr_viewer/templates/index.html b/adr_viewer/templates/index.html
index af33b8d..6b1596c 100644
--- a/adr_viewer/templates/index.html
+++ b/adr_viewer/templates/index.html
@@ -10,6 +10,7 @@
 
         <style type="text/css">
             body {
+                background-color: {{ config.page['background-color'] }};
                 display: grid;
                 width: auto;
                 height: auto;

From 2409f85cad551b0e934ef27ff4443c97c8ef51c3 Mon Sep 17 00:00:00 2001
From: alshapton <alshapton@gmail.com>
Date: Sun, 14 Aug 2022 19:52:44 +0100
Subject: [PATCH 4/6] Added facility to change icon for each status (using
 fontawesome icons).

---
 README.md                       | 12 ++++++++++--
 adr_viewer/__init__.py          | 28 +++++++++++++++++++---------
 adr_viewer/config.toml          |  7 ++++++-
 adr_viewer/templates/index.html | 14 ++++++++------
 4 files changed, 43 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 2ce902f..7e704b4 100644
--- a/README.md
+++ b/README.md
@@ -58,6 +58,10 @@ The colours (the example used here is `green`) can be specified in a number of f
 
 More information about codes and names for HTML colours can be found [here](http://htmlcolorcodes.com).
 
+The icons for each bar can also be modified using the `.icon` property of each bar. The icon names can be sourced from the [`fontawesome` library's documentation](https://fontawesome.com/v4/icons/).
+
+Note that only ***FREE*** icons are allowed. ***Pro*** icons will not be displayed.
+
 ```bash
 # Configuration for adr-viewer
 # in TOML format http://toml.io
@@ -72,21 +76,25 @@ background-color            = "white"
 # Properties for the bars that display each ADR 
 
 # Accepted
-accepted.background-color   = "#00FF00"
+accepted.icon               = "fa-check"
+accepted.background-color   = "lightgreen"
 
 # Amended
+amended.icon                = "fa-arrow-down" 
 amended.background-color    = "yellow"
 
 # Pending
+pending.icon                = "fa-hourglass-half"
 pending.background-color    = "lightblue"
 
 # Superseded
+superseded.icon             = "fa-times"
 superseded.background-color = "lightgrey"
 superseded.text-decoration  = "line-through"
 
 # Unknown
+unknown.icon                = "fa-question"
 unknown.background-color    = "white"
-
 ```
 
 The default for `--adr-path` is `doc/adr/` because this is the default path generated by `adr-tools`.
diff --git a/adr_viewer/__init__.py b/adr_viewer/__init__.py
index 927e599..ad67359 100644
--- a/adr_viewer/__init__.py
+++ b/adr_viewer/__init__.py
@@ -1,6 +1,5 @@
 import os
 import glob
-from re import M
 import toml
 import ast
 
@@ -35,12 +34,13 @@ def parse_adr_to_config(path):
     soup = BeautifulSoup(adr_as_html, features='html.parser')
 
     status = list(extract_statuses_from_adr(soup))
-
-    if any([line.startswith("Amended by") for line in status]):
+    if any([line.startswith("Amended") for line in status]):
         status = 'amended'
     elif any([line.startswith("Accepted") for line in status]):
         status = 'accepted'
-    elif any([line.startswith("Superseded by") for line in status]):
+    elif any([line.startswith("Superceded") for line in status]):
+        status = 'superseded'
+    elif any([line.startswith("Superseded") for line in status]):
         status = 'superseded'
     elif any([line.startswith("Pending") for line in status]):
         status = 'pending'
@@ -97,17 +97,27 @@ def generate_content(path, template_dir_override=None,
         'records': [],
         'page': []
     }
+
     # Set defaults for colours (or use passed in configuration)
     conf = {}
     if type(configuration) == type(None):
         conf = ast.literal_eval('{ \
-        "accepted": {"background-color": "lightgreen"}, \
-        "amended": {"background-color": "yellow"}, \
-        "pending": {"background-color": "lightblue"}, \
+        "accepted": { \
+            "icon": "fa-check", \
+            "background-color": "lightgreen"}, \
+        "amended": {\
+            "icon": "fa-arrow-down", \
+            "background-color": "yellow"}, \
+        "pending": { \
+            "icon": "fa-hourglass-half", \
+            "background-color": "lightblue"}, \
         "superseded": { \
+            "icon" : "fa-times",\
             "background-color": "lightgrey", \
             "text-decoration": "line-through"}, \
-        "unknown": {"background-color": "white"}}')
+        "unknown": { \
+            "icon" : "fa-question", \
+            "background-color": "white"}}')
         config['page'] = ast.literal_eval('{"background-color": "white"}')
     else:
         conf = configuration['status']
@@ -147,7 +157,7 @@ def generate_content(path, template_dir_override=None,
               help='Template directory.', show_default=True)
 @click.option('--heading',       default='ADR Viewer - ',
               help='ADR Page Heading', show_default=True)
-@click.option('--config',        default='config2.toml',
+@click.option('--config',        default='config.toml',
               help='Configuration settings', show_default=True)
 def main(adr_path, output, serve, port, template_dir, heading, config):
     from os.path import exists
diff --git a/adr_viewer/config.toml b/adr_viewer/config.toml
index 503c3b8..ebdf706 100644
--- a/adr_viewer/config.toml
+++ b/adr_viewer/config.toml
@@ -11,17 +11,22 @@ background-color            = "white"
 # Properties for the bars that display each ADR 
 
 # Accepted
+accepted.icon               = "fa-check"
 accepted.background-color   = "lightgreen"
 
 # Amended
-amended.background-color    = "yellow"
+amended.icon                = "fa-arrow-down" 
+amended.background-color    = "yellow"  
 
 # Pending
+pending.icon                = "fa-hourglass-half"
 pending.background-color    = "lightblue"
 
 # Superseded
+superseded.icon             = "fa-times"
 superseded.background-color = "lightgrey"
 superseded.text-decoration  = "line-through"
 
 # Unknown
+unknown.icon                = "fa-question"
 unknown.background-color    = "white"
diff --git a/adr_viewer/templates/index.html b/adr_viewer/templates/index.html
index 6b1596c..7ea89e0 100644
--- a/adr_viewer/templates/index.html
+++ b/adr_viewer/templates/index.html
@@ -5,7 +5,9 @@
         <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css">
         <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
         <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script>
-        <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.2.0/css/all.css">
+<!--        <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.2.0/css/all.css"> -->
+        <link rel="stylesheet" href="https://use.fontawesome.com/releases/v6.1.2/css/all.css">
+
         <title>{{ config.heading }}</title>
 
         <style type="text/css">
@@ -74,15 +76,15 @@ <h4 class="panel-title">
                         <a data-toggle="collapse" href="#collapse{{ adr_record.index }}">{{ adr_record.title }}</a>
 
                         {% if adr_record.status == "accepted" %}
-                        <i class="adr-icon fas fa-fw fa-check"></i>
+                        <i class="adr-icon fas fa-fw {{ config.accepted['icon'] }}"></i>
                         {% elif adr_record.status == "superseded" %}
-                        <i class="adr-icon fas fa-fw fa-times"></i>
+                        <i class="adr-icon fas fa-fw {{ config.superseded['icon'] }}"></i>
                         {% elif adr_record.status == "amended" %}
-                        <i class="adr-icon fas fa-fw fa-arrow-down"></i>
+                        <i class="adr-icon fas fa-fw {{ config.amended['icon'] }}"></i>
                         {% elif adr_record.status == "pending" %}
-                        <i class="adr-icon fas fa-fw fa-hourglass-half"></i>
+                        <i class="adr-icon fas fa-fw {{ config.pending['icon'] }}"></i>
                         {% else %}
-                        <i class="adr-icon fas fa-fw fa-question"></i>
+                        <i class="adr-icon fas fa-fw {{ config.unknown['icon'] }}"></i>
                         {% endif %}
 
                     </h4>

From 6281c65129ff8ec405f24e56403793f0a42c75a4 Mon Sep 17 00:00:00 2001
From: alshapton <alshapton@gmail.com>
Date: Sun, 14 Aug 2022 23:45:00 +0100
Subject: [PATCH 5/6] Upgraded to latest FontAwesome version

---
 adr_viewer/templates/index.html | 1 -
 1 file changed, 1 deletion(-)

diff --git a/adr_viewer/templates/index.html b/adr_viewer/templates/index.html
index 7ea89e0..5738039 100644
--- a/adr_viewer/templates/index.html
+++ b/adr_viewer/templates/index.html
@@ -5,7 +5,6 @@
         <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css">
         <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
         <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script>
-<!--        <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.2.0/css/all.css"> -->
         <link rel="stylesheet" href="https://use.fontawesome.com/releases/v6.1.2/css/all.css">
 
         <title>{{ config.heading }}</title>

From 413adac39ed46b4c47ef9e5f9e1593c83bbd9786 Mon Sep 17 00:00:00 2001
From: alshapton <alshapton@gmail.com>
Date: Mon, 15 Aug 2022 22:51:05 +0100
Subject: [PATCH 6/6] * Fixed inaccurate footer ( the < symbol was being
 interpreted incorrectly) * Added tooltips to icons and tested all with
 ChromeVox Screenreader * Changed <i..... class to <em>.....</em> '

---
 adr_viewer/templates/index.html | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/adr_viewer/templates/index.html b/adr_viewer/templates/index.html
index 5738039..993b2d0 100644
--- a/adr_viewer/templates/index.html
+++ b/adr_viewer/templates/index.html
@@ -11,13 +11,13 @@
 
         <style type="text/css">
             body {
-                background-color: {{ config.page['background-color'] }};
                 display: grid;
                 width: auto;
                 height: auto;
                 align-items: center;
                 justify-items: center;
                 grid-template-rows: 2fr minmax(80%, auto) 2fr;
+                background-color: {{ config.page['background-color'] }};
             }
 
             @media only screen and (min-width: 1025px) {
@@ -67,6 +67,7 @@
         <header>
             <h1>{{ config.heading }}</h1>
         </header>
+        {% set icon_root = 'adr-icon fas fa-fw' %}
         <div class="panel-group">
             {% for adr_record in config.records %}
             <div class="panel panel-default">
@@ -75,15 +76,20 @@ <h4 class="panel-title">
                         <a data-toggle="collapse" href="#collapse{{ adr_record.index }}">{{ adr_record.title }}</a>
 
                         {% if adr_record.status == "accepted" %}
-                        <i class="adr-icon fas fa-fw {{ config.accepted['icon'] }}"></i>
+                        <em class="{{icon_root}} {{ config.accepted['icon'] }}"
+                        title="Status is Accepted"> </em>
                         {% elif adr_record.status == "superseded" %}
-                        <i class="adr-icon fas fa-fw {{ config.superseded['icon'] }}"></i>
+                        <embed class="{{icon_root}} {{ config.superseded['icon'] }}"
+                        title="Status is Superseded"> </em>
                         {% elif adr_record.status == "amended" %}
-                        <i class="adr-icon fas fa-fw {{ config.amended['icon'] }}"></i>
+                        <em class="{{icon_root}} {{ config.amended['icon'] }}"
+                        title="Status is Amended"></em>
                         {% elif adr_record.status == "pending" %}
-                        <i class="adr-icon fas fa-fw {{ config.pending['icon'] }}"></i>
+                        <em class="{{icon_root}} {{ config.pending['icon'] }}"
+                        title="Status is Pending"> </em>
                         {% else %}
-                        <i class="adr-icon fas fa-fw {{ config.unknown['icon'] }}"></i>
+                        <em class="{{icon_root}} {{ config.unknown['icon'] }}"
+                        title="Status is Unknown"> </em>
                         {% endif %}
 
                     </h4>
@@ -95,7 +101,7 @@ <h4 class="panel-title">
             {% endfor %}
         </div>
         <footer>
-            Generated with <3 using ADR Viewer
+            Generated with &lt3 using ADR Viewer
         </footer>
     </body>
 </html>
\ No newline at end of file