mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-05-28 14:42:34 +02:00
47d30f803e
* Refactored the RSS reports in rdadmin(1) to include information on missing items. * Modified the feed report in rdcastmanager to include information on missing items. Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
184 lines
9.4 KiB
XML
184 lines
9.4 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||
<article xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||
<info>
|
||
<title>The Rivendell "rivendell" Namespace</title>
|
||
<subtitle>Version 0.1</subtitle>
|
||
<revnumber>v0.1</revnumber>
|
||
<author>
|
||
<personname>
|
||
<firstname>Fred</firstname>
|
||
<surname>Gleason</surname>
|
||
<email>fredg@paravelsystems.com</email>
|
||
</personname>
|
||
</author>
|
||
<edition>
|
||
v0.1
|
||
</edition>
|
||
<copyright><year>2023</year><holder>Fred Gleason</holder></copyright>
|
||
<legalnotice>
|
||
<para>
|
||
Permission is granted to copy, distribute and/or modify this document
|
||
under the terms of the GNU Free Documentation License, Version 1.3
|
||
or any later version published by the Free Software Foundation;
|
||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||
</para>
|
||
</legalnotice>
|
||
</info>
|
||
|
||
<sect1 xml:id="overview">
|
||
<title>Overview</title>
|
||
<para>
|
||
The "superfeed" XML namespace adds support for additional
|
||
fields used by Rivendell RSS podcasting report generation. It's use is
|
||
limited to internal documents generated within Rivendell.
|
||
</para>
|
||
</sect1>
|
||
<sect1 xml:id="namespace_declaration">
|
||
<title>Namespace Declaration</title>
|
||
<para>
|
||
The namespace declaration is:
|
||
</para>
|
||
<para>
|
||
<code>xmlns:rivendell="http://www.rivendellaudio.org/dtds/rivendell-0.1.dtd"</code>
|
||
</para>
|
||
</sect1>
|
||
<sect1 xml:id="fields">
|
||
<title>Fields</title>
|
||
<para>
|
||
The namespace adds the following fields:
|
||
</para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term>
|
||
<code><item rivendell:id=<replaceable>id</replaceable>></code>
|
||
</term>
|
||
<listitem>
|
||
<para>
|
||
This attribute is added to the <channel> and <item>
|
||
tags. It is a unique unsigned integer ID that associates the object
|
||
to a record in the <computeroutput>FEEDS</computeroutput> and
|
||
<computeroutput>PODCASTS</computeroutput> database tables,
|
||
respectively.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
|
||
<varlistentry>
|
||
<term>
|
||
<code><item rivendell:status=<replaceable>class-name</replaceable>></code>
|
||
</term>
|
||
<listitem>
|
||
<para>
|
||
This attribute is added to the <item> tag. It indicates
|
||
a class name to use for this item when rendering reports.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</sect1>
|
||
|
||
<sect1 xml:id="example">
|
||
<title>Example</title>
|
||
<literallayout>
|
||
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
||
<rss version="2.0" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:superfeed="http://www.rivendellaudio.org/dtds/superfeed-0.1.dtd" xmlns:rivendell="http://www.rivendellaudio.org/dtds/rivendell-0.1.dtd">
|
||
<channel rivendell:id="1234">
|
||
<title>Rivendell Radio Automation</title>
|
||
<description>All about the Rivendell Radio Automation System</description>
|
||
<itunes:summary>All about the Rivendell Radio Automation System</itunes:summary>
|
||
<category>Technology</category>
|
||
<link>http://feeds.example.com/rivendel</link>
|
||
<language>en-us</language>
|
||
<copyright><EFBFBD> 2020 John Q. Author</copyright>
|
||
<lastBuildDate>Thu, 4 Jun 2020 12:18:54 GMT</lastBuildDate>
|
||
<pubDate>Thu, 21 May 2020 10:43:55 GMT</pubDate>
|
||
<managingEditor>editor@example.com</managingEditor>
|
||
<webMaster>webmaster@example.com</webMaster>
|
||
<generator>Rivendell 3.3.0int1</generator>
|
||
<image>
|
||
<url>http://feeds.example.com/rivendel/img000022_000038.png</url>
|
||
<title>Rivendell Radio Automation</title>
|
||
<link>http://feeds.example.com/rivendel</link>
|
||
<width>2048</width>
|
||
<height>2048</height>
|
||
<description>The Rivendell Icon</description>
|
||
</image>
|
||
<atom:link href="http://feeds.example.com/rivendel/RIVENDEL.rss" rel="self" type="application/rss+xml" />
|
||
<itunes:author>author@example.com</itunes:author>
|
||
<itunes:type>episodic</itunes:type>
|
||
<itunes:owner>
|
||
<itunes:name>John Q. Author</itunes:name>
|
||
<itunes:email>fredg@paravelsystems.com</itunes:email>
|
||
</itunes:owner>
|
||
<itunes:image href="http://feeds.example.com/rivendel/img000022_000038.png" />
|
||
<itunes:category text="Technology" />
|
||
<itunes:explicit>false</itunes:explicit>
|
||
<item rivendell:id="4321" rivendell:class="active-rounded-block">
|
||
<superfeed:channelTitle>RDAirPlay</superfeed:channelTitle>
|
||
<superfeed:channelDescription>All about RDAirPlay in Rivendell</superfeed:channelDescription>
|
||
<title>Thurber Jewelers</title>
|
||
<itunes:title>Thurber Jewelers</itunes:title>
|
||
<link>http://feeds.example.com/airplay</link>
|
||
<guid isPermaLink="false">http://feeds.example.com/airplay/000019_000026.mp3_000019_000026</guid>
|
||
<description>All about RDAirPlay in Rivendell</description>
|
||
<itunes:summary>All about RDAirPlay in Rivendell</itunes:summary>
|
||
<author>someone@example.com (John Q. Author)</author>
|
||
<itunes:author>someone@example.com (John Q. Author)</itunes:author>
|
||
<comments>http://feeds.example.com/airplay</comments>
|
||
<source url="http://feeds.example.com/airplay/RIVENDEL">Rivendell Radio Automation</source>
|
||
<enclosure url="http://feeds.example.com/airplay/000019_000026.mp3" length="170496" type="audio/mpeg" />
|
||
<category>Technology</category>
|
||
<pubDate>Thu, 21 May 2020 20:31:26 GMT</pubDate>
|
||
<itunes:duration>14</itunes:duration>
|
||
<itunes:image href="http://feeds.example.com/airplay/img000019_000024.png" />
|
||
<itunes:explicit>false</itunes:explicit>
|
||
</item>
|
||
<item rivendell:id="4322" rivendell:class="active-rounded-block">
|
||
<superfeed:channelTitle>RDCartSlots</superfeed:channelTitle>
|
||
<superfeed:channelDescription>All channel all about RDCartSlots!</superfeed:channelDescription>
|
||
<title>Liberty Tax</title>
|
||
<itunes:title>Liberty Tax</itunes:title>
|
||
<link>http://feeds.example.com</link>
|
||
<guid isPermaLink="false">http://feeds.example.com/cartslts/000025_000025.mp3_000025_000025</guid>
|
||
<description>The Liberty tax advisors.</description>
|
||
<itunes:summary>The Liberty tax advisors.</itunes:summary>
|
||
<author>someone@example.com (John Q. Author)</author>
|
||
<itunes:author>someone@example.com (John Q. Author)</itunes:author>
|
||
<comments>http://feeds.example.com/cartslts</comments>
|
||
<source url="http://feeds.example.com/cartslts/RIVENDEL">Rivendell Radio Automation</source>
|
||
<enclosure url="http://feeds.example.com/cartslts/000025_000025.mp3" length="369216" type="audio/mpeg" />
|
||
<category>Technology</category>
|
||
<pubDate>Thu, 21 May 2020 19:17:26 GMT</pubDate>
|
||
<itunes:duration>15</itunes:duration>
|
||
<itunes:image href="http://feeds.example.com/cartslts/img000025_000037.png" />
|
||
<itunes:explicit>false</itunes:explicit>
|
||
</item>
|
||
<item>
|
||
<superfeed:channelTitle>RDLibrary</superfeed:channelTitle>
|
||
<superfeed:channelDescription>A channel all about RDLibrary</superfeed:channelDescription>
|
||
<title>The Peanut Shoppe</title>
|
||
<itunes:title>The Peanut Shoppe</itunes:title>
|
||
<link>http://feeds.example.com/library</link>
|
||
<guid isPermaLink="false">http://feeds.example.com/library/000024_000024.mp3_000024_000024</guid>
|
||
<description>A trip to a peanut and candy shop in downtown Wadsworth OH.</description>
|
||
<itunes:summary>A trip to a peanut and candy shop in downtown Wadsworth OH.</itunes:summary>
|
||
<author>someone@example.com (John Q. Author)</author>
|
||
<itunes:author>someone@example.com (John Q. Author)</itunes:author>
|
||
<comments>http://feeds.example.com/library</comments>
|
||
<source url="http://feeds.example.com/library/RIVENDEL">Rivendell Radio Automation</source>
|
||
<enclosure url="http://feeds.example.com/library/000024_000024.mp3" length="196992" type="audio/mpeg" />
|
||
<category>Technology</category>
|
||
<pubDate>Thu, 21 May 2020 19:14:53 GMT</pubDate>
|
||
<itunes:duration>16</itunes:duration>
|
||
<itunes:image href="http://feeds.example.com/library/img000024_000036.png" />
|
||
<itunes:explicit>false</itunes:explicit>
|
||
</item>
|
||
</channel>
|
||
</rss>
|
||
|
||
</literallayout>
|
||
</sect1>
|
||
|
||
</article>
|