From 1e1279025ed18c5dd794bbacc6f607de458d8eec Mon Sep 17 00:00:00 2001
From: Patrice Chalin <chalin@users.noreply.github.com>
Date: Fri, 2 Feb 2024 12:54:17 -0500
Subject: [PATCH] Footer: factor out copyright, and code cleanup (#1817)

---
 CHANGELOG.md                           |  9 ++++++++-
 assets/scss/main.scss                  | 10 +++++++++-
 layouts/partials/footer.html           |  8 +++++---
 layouts/partials/footer/center.html    | 18 +++++++++---------
 layouts/partials/footer/copyright.html |  3 +++
 layouts/partials/footer/left.html      | 10 +++++-----
 layouts/partials/footer/right.html     | 10 +++++-----
 7 files changed, 44 insertions(+), 24 deletions(-)
 create mode 100644 layouts/partials/footer/copyright.html

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0907049350..54c8c380dd 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -42,9 +42,15 @@ For the full list of changes, see the [0.9.0] release notes.
   [render-heading.html](https://gohugo.io/templates/render-hooks/) hook. This is
   _potentially_ a breaking change for projects that override the hook.
 
+- The footer layout has been factored into parts: left, right, and center, with
+  copyright a subpart of center. Each part has its own style tag, for example:
+  `td-footer__left`. Note that the style `td-footer__copyright-etc` has been
+  renamed to `td-footer__center`. For details concerning all foot changes, see
+  [#1818].
+
 **Other changes**:
 
-- The latest release of [Mermaid] resources are fetch at build time ([#1410])
+- The latest release of [Mermaid] resources are fetched at build time ([#1410]).
 - Docsy follows recommended accessibility practice: page-body links are
   underlined. For details, see [#1814] and [#1815].
 
@@ -53,6 +59,7 @@ For the full list of changes, see the [0.9.0] release notes.
 [#1744]: https://github.com/google/docsy/pull/1744
 [#1814]: https://github.com/google/docsy/issues/1814
 [#1815]: https://github.com/google/docsy/pull/1815
+[#1818]: https://github.com/google/docsy/pull/1818
 [mermaid]:
   https://www.docsy.dev/docs/adding-content/diagrams-and-formulae/#diagrams-with-mermaid
 [multi-language]: https://www.docsy.dev/docs/language/
diff --git a/assets/scss/main.scss b/assets/scss/main.scss
index 3e81ecca2d..540fdc69f7 100644
--- a/assets/scss/main.scss
+++ b/assets/scss/main.scss
@@ -49,9 +49,17 @@
     min-height: 200px;
   }
 
-  &__copyright-etc {
+  /* &__left { } */
+
+  &__center {
     @extend .small;
+    text-align: center;
+  }
+
+  &__right {
+    text-align: right;
   }
+
   &__about {
     font-size: initial;
   }
diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html
index 1bda7e9486..c61969b488 100644
--- a/layouts/partials/footer.html
+++ b/layouts/partials/footer.html
@@ -1,13 +1,15 @@
 <footer class="td-footer row d-print-none">
   <div class="container-fluid">
     <div class="row mx-md-2">
-      <div class="col-6 col-sm-4 text-xs-center order-sm-1">
+      <div class="td-footer__left col-6 col-sm-4 order-sm-1">
         {{ partial "footer/left.html"  . }}
       </div>
-      <div class="col-6 col-sm-4 text-end text-xs-center order-sm-3">
+      {{- /* Trim WS */ -}}
+      <div class="td-footer__right col-6 col-sm-4 order-sm-3">
         {{ partial "footer/right.html"  . }}
       </div>
-      <div class="td-footer__copyright-etc col-12 col-sm-4 text-center py-2 order-sm-2">
+      {{- /* Trim WS */ -}}
+      <div class="td-footer__center col-12 col-sm-4 py-2 order-sm-2">
         {{ partial "footer/center.html"  . }}
       </div>
     </div>
diff --git a/layouts/partials/footer/center.html b/layouts/partials/footer/center.html
index 0654746d7b..46335abe59 100644
--- a/layouts/partials/footer/center.html
+++ b/layouts/partials/footer/center.html
@@ -1,11 +1,11 @@
-{{ with .Site.Params.copyright -}}
-<span>&copy; {{ now.Year }} {{ . }} {{ T "footer_all_rights_reserved" }}</span>
-{{- end }}
+{{ partial "footer/copyright.html"  . -}}
+
 {{ with .Site.Params.privacy_policy -}}
-<span class="ms-1"><a href="{{ . }}" target="_blank" rel="noopener">{{ T "footer_privacy_policy" }}</a></span>
-{{- end }}
-{{ if not .Site.Params.ui.footer_about_disable -}}
-{{ with .Site.GetPage "about" -}}
-	<p class="td-footer__about mt-2"><a href="{{ .RelPermalink }}">{{ .Title }}</a></p>
+  <span class="ms-2"><a href="{{ . }}" target="_blank" rel="noopener">{{ T "footer_privacy_policy" }}</a></span>
 {{- end -}}
-{{ end }}
+
+{{ if not .Site.Params.ui.footer_about_disable -}}
+  {{ with .Site.GetPage "about" -}}
+    <p class="td-footer__about mt-2"><a href="{{ .RelPermalink }}">{{ .Title }}</a></p>
+  {{- end -}}
+{{ end -}}
diff --git a/layouts/partials/footer/copyright.html b/layouts/partials/footer/copyright.html
new file mode 100644
index 0000000000..2142b31969
--- /dev/null
+++ b/layouts/partials/footer/copyright.html
@@ -0,0 +1,3 @@
+{{ with .Site.Params.copyright -}}
+  <span class="td_footer__copyright">&copy; {{ now.Year }} {{ . }} {{ T "footer_all_rights_reserved" }}</span>
+{{- end -}}
diff --git a/layouts/partials/footer/left.html b/layouts/partials/footer/left.html
index 2f093d4b21..ed9265f4c2 100644
--- a/layouts/partials/footer/left.html
+++ b/layouts/partials/footer/left.html
@@ -1,5 +1,5 @@
-{{ with .Site.Params.links }}
-{{ with index . "user" }}
-{{ partial "footer/links.html"  . }}
-{{ end }}
-{{ end }}
+{{ with .Site.Params.links -}}
+  {{ with index . "user" -}}
+    {{- partial "footer/links.html"  . -}}
+  {{ end -}}
+{{ end -}}
diff --git a/layouts/partials/footer/right.html b/layouts/partials/footer/right.html
index 57cf429573..3afc3d2744 100644
--- a/layouts/partials/footer/right.html
+++ b/layouts/partials/footer/right.html
@@ -1,5 +1,5 @@
-{{ with .Site.Params.links }}
-{{ with index . "developer" }}
-{{ partial "footer/links.html"  . }}
-{{ end }}
-{{ end }}
+{{ with .Site.Params.links -}}
+  {{ with index . "developer" -}}
+    {{- partial "footer/links.html"  . -}}
+  {{ end -}}
+{{ end -}}