From e5b269fb366c069653b59a38f6def73b03904d2f Mon Sep 17 00:00:00 2001
From: Robert Kaussow <mail@thegeeklab.de>
Date: Sun, 6 Feb 2022 21:53:22 +0100
Subject: [PATCH] refactor: cleanup Atom feed template and remove CDATA (#195)

---
 layouts/_default/list.atom.xml    | 78 +++++++++++++++----------------
 layouts/partials/head/others.html | 15 +++---
 2 files changed, 46 insertions(+), 47 deletions(-)

diff --git a/layouts/_default/list.atom.xml b/layouts/_default/list.atom.xml
index 1d909dd..f97a91e 100644
--- a/layouts/_default/list.atom.xml
+++ b/layouts/_default/list.atom.xml
@@ -1,51 +1,49 @@
-{{ printf `<?xml version="1.0" encoding="utf-8"?>` | safeHTML }} {{/* ref: https://validator.w3.org/feed/docs/atom.html */}}
+{{ printf `<?xml version="1.0" encoding="utf-8"?>` | safeHTML }}
 <feed xmlns="http://www.w3.org/2005/Atom"{{ with .Site.Language.Lang }} xml:lang="{{ . }}"{{ end }}>
     <generator uri="https://gohugo.io/" version="{{ hugo.Version }}">Hugo</generator>
     {{- $title := .Site.Title -}}
-    {{- if not (eq .Kind "home") -}}
+    {{- if not (eq .Kind "home") }}
         {{- $title = printf `%s on %s` (partial "utils/title" .) $title -}}
-    {{- end -}}
-    {{ printf `<title type="html"><![CDATA[%s]]></title>` $title | safeHTML }}
-    {{ with .Site.Params.subtitle }}
-        {{ printf `<subtitle type="html"><![CDATA[%s]]></subtitle>` . | safeHTML }}
-    {{ end }}
-    {{ $output_formats := .OutputFormats }}
-    {{ range $output_formats -}}
+    {{- end }}
+    <title>{{ trim ($title | plainify) "\n" }}</title>
+    {{- with .Site.Params.subtitle }}
+        <subtitle>{{ trim (. | plainify) "\n" }}</subtitle>
+    {{- end }}
+    {{- $output_formats := .OutputFormats -}}
+    {{- range $output_formats -}}
         {{- $rel := (or (and (eq "atom" (.Name | lower)) "self") "alternate") -}}
-        {{ with $output_formats.Get .Name }}
+        {{- with $output_formats.Get .Name }}
             {{ printf `<link href=%q rel=%q type=%q title=%q />` .Permalink $rel .MediaType.Type .Name | safeHTML }}
-        {{- end -}}
+        {{- end }}
     {{- end }}
     <updated>{{ now.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</updated>
-    <generator uri="https://gohugo.io" version="{{ hugo.Version }}">Hugo</generator>
-    {{ with .Site.Params.GeekblogAuthor -}}
-        {{ with index $.Site.Data.authors . }}
+    {{- with .Site.Params.GeekblogAuthor -}}
+        {{- with index $.Site.Data.authors . }}
         <author>
             <name>{{ .name }}</name>
-            {{ with .email }}
+            {{- with .email }}
                 <email>{{ . }}</email>
-            {{ end -}}
+            {{- end }}
         </author>
-        {{ end }}
+        {{- end }}
     {{- end }}
     <id>{{ .Permalink }}</id>
     {{- $pages := where .RegularPages "Type" "in" .Site.Params.mainSections -}}
     {{- if (eq .Kind "home") -}}
         {{- $pages = where .Site.RegularPages "Type" "in" .Site.Params.mainSections -}}
     {{- end -}}
-    {{- range $pages }}
-        {{ $page := . }}
+    {{- range $page := $pages }}
         <entry>
-            {{ printf `<title type="html"><![CDATA[%s]]></title>` (partial "utils/title" .) | safeHTML }}
-            <link href="{{ .Permalink }}?utm_source=atom_feed" rel="alternate" type="text/html" {{ with .Site.Language.Lang }} hreflang="{{ . }}"{{ end }} />
+            <title>{{ trim (partial "utils/title" . | plainify) "\n" }}</title>
+            <link href="{{ .Permalink }}" rel="alternate" type="text/html" {{ with .Site.Language.Lang }} hreflang="{{ . }}"{{ end }} />
             <id>{{ .Permalink }}</id>
-            {{ with .Params.authors -}}
-                {{- range sort . -}}
-                    {{ $author := index $.Site.Data.authors . }}
+            {{- with .Params.authors }}
+                {{- range sort . }}
+                    {{- $author := index $.Site.Data.authors . }}
                     <author>
                         <name>{{ $author.name }}</name>
                     </author>
-                {{- end -}}
+                {{- end }}
             {{- end }}
             <published>{{ .Date.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</published>
             <updated>{{ .Lastmod.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</updated>
@@ -54,20 +52,22 @@
                 {{- $featured := .Fill (printf "910x280 %s" (default "Smart" .Params.anchor)) -}}
                 {{- $img = printf `<img src="%s" width="%d" height="%d" alt="%s" /><br/>` $featured.Permalink $featured.Width $featured.Height (default (partial "utils/title" $page) .Params.description) -}}
             {{- end }}
-            {{ printf `<content type="html"><![CDATA[%s%s]]></content>` $img .Content | safeHTML }}
-            {{ with .Site.Taxonomies }}
-                {{ range $taxo,$_ := . }} <!-- Defaults taxos: "tags", "categories" -->
-                    {{ with $page.Param $taxo }}
-                        {{ $taxo_list := . }} <!-- $taxo_list will be the tags/categories list -->
-                        {{ with $.Site.GetPage (printf "/%s" $taxo) }}
-                            {{ $taxonomy_page := . }}
-                            {{ range $taxo_list }} <!-- Below, assuming pretty URLs -->
+            <content type="html">
+                {{ printf "%s%s" $img .Content | htmlEscape | safeHTML }}
+            </content>
+            {{- with .Site.Taxonomies }}
+                {{- range $taxo,$_ := . }} <!-- Defaults taxos: "tags", "categories" -->
+                    {{- with $page.Param $taxo }}
+                        {{- $taxo_list := . -}} <!-- $taxo_list will be the tags/categories list -->
+                        {{- with $.Site.GetPage (printf "/%s" $taxo) }}
+                            {{- $taxonomy_page := . -}}
+                            {{- range $taxo_list }} <!-- Below, assuming pretty URLs -->
                                 <category scheme="{{ printf "%s%s" $taxonomy_page.Permalink (. | urlize) }}" term="{{ (. | urlize) }}" label="{{ . }}" />
-                            {{ end }}
-                        {{ end }}
-                    {{ end }}
-                {{ end }}
-            {{ end }}
+                            {{- end }}
+                        {{- end }}
+                    {{- end }}
+                {{- end }}
+            {{- end }}
         </entry>
-    {{ end }}
+    {{- end }}
 </feed>
diff --git a/layouts/partials/head/others.html b/layouts/partials/head/others.html
index 3b9eee1..3e1ab23 100644
--- a/layouts/partials/head/others.html
+++ b/layouts/partials/head/others.html
@@ -65,15 +65,14 @@
   href="{{ index (index .Site.Data.assets "custom.css") "src" | relURL }}"
   media="all"
 />
-
-<link rel="canonical" href="{{ .Permalink }}" />
-
-{{- with (.Site.GetPage "home").OutputFormats.Get "atom" }}
-  {{ printf `<link rel="%s" type="%s" href="%s" title="%s Atom Feed">` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
+{{- with .OutputFormats.Get "html" }}
+  {{ printf `<link href=%q rel=%q type=%q />` .Permalink .Rel .MediaType.Type | safeHTML }}
 {{- end }}
-
-{{- with (.Site.GetPage "home").OutputFormats.Get "json" }}
-  {{ printf `<link rel="%s" type="%s" href="%s" title="%s JSON Feed">` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
+{{- $output_formats := (.Site.GetPage "home").OutputFormats }}
+{{- range $format := (.Site.GetPage "home").OutputFormats }}
+  {{- if not (eq $format.Rel "canonical") }}
+    {{ printf `<link href=%q rel=%q type=%q title="%s %s Feed" />` $format.Permalink $format.Rel $format.MediaType.Type $.Site.Title $format.Name | safeHTML }}
+  {{- end }}
 {{- end }}
 
 {{- if (default false $.Site.Params.GeekblogOverwriteHTMLBase) }}