Post about mod_admin
This commit is contained in:
parent
b82d04c895
commit
02b2a5cf5a
22
feed.xml
22
feed.xml
|
|
@ -814,5 +814,27 @@
|
|||
<p>If you are more of an <abbr title="Internet Engineering Task Force">IETF</abbr> fan, you can also get an <a href="https://cosmic.voyage/atom.xml" target="_blank">Atom feed</a>.</p>
|
||||
]]></description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>More explicit feed error reporting with mod_admin</title>
|
||||
<pubDate>Mon, 30 May 2022 17:39:56 +0200</pubDate>
|
||||
<guid isPermaLink="false">mod_admin</guid>
|
||||
<category domain="https://envs.net/~lucidiot/rsrsss/">Tip</category>
|
||||
<link>https://web.resource.org/rss/1.0/modules/admin/</link>
|
||||
<description><![CDATA[
|
||||
<p>While the <a href="https://www.rssboard.org/rss-specification#optionalChannelElements" target="_blank">RSS specification</a> and <a href="https://www.rssboard.org/rss-profile" target="_blank">RSS profile</a> both specify that the <a href="https://www.rssboard.org/rss-profile#element-channel-managingeditor" target="_blank"><code><managingEditor></code></a> and <a href="https://www.rssboard.org/rss-profile#element-channel-webmaster" target="_blank"><code><webMaster></code></a> must use e-mail addresses, and both also explicitly state that the <code>webMaster</code> is the e-mail address to contact for technical issues regarding the feed, most developers and users of RSS feeds and feed readers do not seem to have that in mind. Most feeds do not use those tags or might not even use valid e-mail addresses. Since most feed readers are focused on just getting the user to read some articles, and spit out some incomprehensible error or fail silently when something is wrong in a feed, they do not use those tags even when they are correctly specified to let the user ask for help.</p>
|
||||
<p>I could go and ask for some enhancements to error reporting on all feed readers, but that would be extremely exhausting, as most work in open-source projects feels to me—I definitely am not great at communication. Instead, here is a small initiative that RSS feed developers can make to make the internals of their RSS feed generation system more visible and, for a user that is curious enough to be reading the feed's source, point directly to where they can complain at.</p>
|
||||
<p>One of the approved <abbr title="RDF Site Summary">RSS</abbr> 1.0 modules, <a href="https://web.resource.org/rss/1.0/modules/admin/" target="_blank"><code>mod_admin</code></a>, also called the Administrative Module, defines an XML namespace, <code>xmlns:admin="http://webns.net/mvcb/"</code>, and two extra tags you can use:</p>
|
||||
<dl>
|
||||
<dt><code><admin:generatorAgent></code></dt>
|
||||
<dd>Should use an URI in a <code>rdf:resource</code> attribute to point to the feed generator. This is redundant with the <abbr title="Really Simple Syndication">RSS</abbr> 2.0 <a href="https://www.rssboard.org/rss-profile#element-channel-generator" target="_blank"><code><generator></code></a> tag, and the <a href="https://validator.w3.org/feed/" target="_blank">W3C Feed Validation Service</a> will complain if you use both tags at once, but with this new tag, you can specify a URI instead of some arbitrary string, which could let a feed reader make a link available more easily.</dd>
|
||||
<dt><code><admin:errorReportsTo></code></dt>
|
||||
<dd>As above, the <code>rdf:resource</code> attribute should point to somewhere to report issues with this feed. This is usually a <code>mailto:</code> URI, but you could also point it to a contact form over HTTP. This is similar to the <a href="https://www.rssboard.org/rss-profile#element-channel-webmaster" target="_blank"><code><webMaster></code></a> tag, but the W3C validator does not complain about a redundancy here, so you can safely use both.</dd>
|
||||
</dl>
|
||||
<p>By adding <code><admin:generatorAgent></code> to your feed, you could let some random developer, let's say, <em>me</em>, look at your RSS feed generation code, and maybe find the bug for you. By adding <code><admin:errorReportsTo></code>, a tag name that is more explicit than <code>webMaster</code>, with a clickable <code>mailto:</code> link or a link to a contact form, you can make it easier for curious users and random developers to tell you that something is wrong.</p>
|
||||
<p>It is obviously not that likely that some random user is going to look at the source of the feed when something is wrong, but considering that content syndication over feeds is dying and that most of its remaining users are the tech-savvy ones, it is not impossible.</p>
|
||||
<p>And if, like me, you are using an <abbr title="eXtensible Stylesheet Language Transformation">XSLT</abbr> as your <a href="https://www.w3.org/TR/xml-stylesheet/" target="_blank"><code><?xml-stylesheet?></code></a>, you could add a link to report errors with your feed if someone is displaying it in a browser. If you open RSRSSS in your web browser and your browser does not have native support for RSS feeds, then you can find this link at the very bottom of the page.</p>
|
||||
]]></description>
|
||||
</item>
|
||||
</channel>
|
||||
</rss>
|
||||
|
|
|
|||
Loading…
Reference in New Issue