[SOLVED] RSS output issues: character rendering and relative urls

gaetawoo 2017-08-11 20:57:11 UTC #1

I have an RSS template here:

gaetawoo/djmmc/blob/master/layouts/rss.xml

<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:content="http://purl.org/rss/1.0/modules/content/">
  <channel>
    <title>{{ .Site.Title }}</title>
    <link>{{ .Site.BaseURL }}</link>
    <description>Recent content in {{ .Site.Title }}</description>
    <generator>Hugo -- gohugo.io</generator>{{ with .Site.LanguageCode }}
    <language>{{.}}</language>{{end}}{{ with .Site.Author.email }}
    <managingEditor>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</managingEditor>{{end}}{{ with .Site.Author.email }}
    <webMaster>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</webMaster>{{end}}{{ with .Site.Copyright }}
    <copyright>{{.}}{{ now.Format "2006" }}</copyright>{{end}}{{ if not .Date.IsZero }}
    <lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>{{ end }}
    <atom:link href="{{ .Site.BaseURL }}index.xml" rel="self" type="application/rss+xml" />
    {{ range where .Data.Pages "Section" "post" }}
    <item>
      <title>{{ .Title }}</title>
      <link>{{ .Permalink }}</link>
      <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
      {{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}}
      <guid>{{ .Permalink }}</guid>
      <description><![CDATA[{{ .Summary }}]]></description>

This file has been truncated. show original

This outputs the following file here (I recommend to view-source):
https://www.djtennessee.com/index.xml

This is the RSS validation of that output:
https://validator.w3.org/feed/check.cgi?url=https%3A%2F%2Fwww.djtennessee.com%2Findex.xml

Question 1:
On Line 20 of the RSS template I have <content:encoded><![CDATA[...... The < before the ! in the template gets rendered to < in the output index.xml. The same happens for the same character on Line 21. Why is this happening? I can force it to render as an < in the output xml if I use {{ "<" | safeHTML }} but that’s silly to have it there when it’s not supposed to be necessary. Why is Hugo converting it to to code form?

Question 2:
When things are working fine, the RSS validator recommends not having any relative urls in the content. The relative urls are from markdown image links in content files. I thought setting canonifyURLs = true in config.toml would force all URLs referenced to become absolute urls, but it doesn’t for those graphics. Is there a way to force that to happen? I want to keep the url in the body of the markdown file relative since that’s the best practice, but I want the output to be absoluteURL. I know I could probably do something like ![Graphic]({{ "images/graphic.jpg" | absURL }}) but is that the only way?

Thanks!

maiki 2017-08-11 21:44:56 UTC #2

I know why one would use CDATA, but why are you? Do you have a special requirement for it? Because you could remove it and one of yer problems is solved.

I use the default spec, modified to show full content, rather than the summary.

The second issue may be something we need to bring up as a bug.

gaetawoo 2017-08-11 21:51:56 UTC #3

I saw that it would work if I didn’t have CDATA but all the recommendations online seemed to say to use CDATA if you were including styled html. What is your understanding on it?

maiki 2017-08-11 22:11:23 UTC #4

Don’t include inline styles. It is a feed, it is meant to be styled however the reader prefers.

But you ought to search the forums as well, for instance there is:

I checked, it fixes your feed issue. The same doesn’t work for summary, but you may want to remove that and make the template simpler.

gaetawoo 2017-08-11 22:13:41 UTC #5

I didn’t mean inline styles in the css sense. I meant html markup.

anyway, i removed the CDATA tags and added the pipe to html like you had, and it worked, not only that but also the relative urls for the graphics were fixed too. so i guess that helped!

maiki 2017-08-11 22:28:31 UTC #6

Glad that worked. Mark as solved, if you can.

What is “styled html”? I want to know I am on the same page.

rdwatters 2017-08-12 00:58:20 UTC #7

A couple quick things:

RSS and ATOM are different XML namespaces, no?
safeHTML may seem inconvenient, but it’s a matter of Golang template’s normal behavior to escape possibly pernicious ML, JS, etc…

gaetawoo 2017-08-12 01:57:20 UTC #8

I mean html with html tags, bold, italic, links, etc.

gaetawoo 2017-08-12 01:58:00 UTC #9

They play nice enough together on the same xml, it seems.

maiki 2017-08-12 02:46:22 UTC #10

CDATA is one way of doing, encoding it is another (which is what we are doing, via piping to a frontmatter).

Are you referring to <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">?

That is a shortcut, so RSS will render as a valid Atom feed, for Atom readers.