File: C:/Ruby27-x64/share/doc/ruby/html/RSS/RootElementMixin.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module RSS::RootElementMixin - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="XMLStyleSheetMixin.html">RSS::XMLStyleSheetMixin</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-feed_info">#feed_info</a>
<li ><a href="#method-i-maker_target">#maker_target</a>
<li ><a href="#method-i-ns_declarations">#ns_declarations</a>
<li ><a href="#method-i-output_encoding-3D">#output_encoding=</a>
<li ><a href="#method-i-same_feed_type-3F">#same_feed_type?</a>
<li class="calls-super" ><a href="#method-i-setup_maker">#setup_maker</a>
<li class="calls-super" ><a href="#method-i-tag">#tag</a>
<li ><a href="#method-i-to_atom">#to_atom</a>
<li ><a href="#method-i-to_feed">#to_feed</a>
<li ><a href="#method-i-to_rss">#to_rss</a>
<li ><a href="#method-i-to_xml">#to_xml</a>
<li ><a href="#method-i-xmldecl">#xmldecl</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-RSS::RootElementMixin">
<h1 id="module-RSS::RootElementMixin" class="module">
module RSS::RootElementMixin
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-encoding" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">encoding</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-feed_subtype" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">feed_subtype</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-feed_type" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">feed_type</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-feed_version" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">feed_version</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-output_encoding" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">output_encoding</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-standalone" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">standalone</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-version" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">version</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(feed_version, version=nil, encoding=nil, standalone=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="XMLStyleSheetMixin.html#method-c-new"><code>RSS::XMLStyleSheetMixin::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1246</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">feed_version</span>, <span class="ruby-identifier">version</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">encoding</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">standalone</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">super</span>()
<span class="ruby-ivar">@feed_type</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@feed_subtype</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@feed_version</span> = <span class="ruby-identifier">feed_version</span>
<span class="ruby-ivar">@version</span> = <span class="ruby-identifier">version</span> <span class="ruby-operator">||</span> <span class="ruby-string">'1.0'</span>
<span class="ruby-ivar">@encoding</span> = <span class="ruby-identifier">encoding</span>
<span class="ruby-ivar">@standalone</span> = <span class="ruby-identifier">standalone</span>
<span class="ruby-ivar">@output_encoding</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-feed_info" class="method-detail ">
<div class="method-heading">
<span class="method-name">feed_info</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="feed_info-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1257</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">feed_info</span>
[<span class="ruby-ivar">@feed_type</span>, <span class="ruby-ivar">@feed_version</span>, <span class="ruby-ivar">@feed_subtype</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-output_encoding-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">output_encoding=</span><span
class="method-args">(enc)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="output_encoding-3D-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1261</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">output_encoding=</span>(<span class="ruby-identifier">enc</span>)
<span class="ruby-ivar">@output_encoding</span> = <span class="ruby-identifier">enc</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">converter</span> = <span class="ruby-constant">Converter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@output_encoding</span>, <span class="ruby-ivar">@encoding</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setup_maker" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup_maker</span><span
class="method-args">(maker)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="setup_maker-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1266</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_maker</span>(<span class="ruby-identifier">maker</span>)
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">version</span> = <span class="ruby-identifier">version</span>
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">encoding</span> = <span class="ruby-identifier">encoding</span>
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">standalone</span> = <span class="ruby-identifier">standalone</span>
<span class="ruby-identifier">xml_stylesheets</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">xss</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">xss</span>.<span class="ruby-identifier">setup_maker</span>(<span class="ruby-identifier">maker</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_atom" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_atom</span><span
class="method-args">(type, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="to_atom-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1289</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_atom</span>(<span class="ruby-identifier">type</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">to_feed</span>(<span class="ruby-node">"atom:#{type}"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_feed" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_feed</span><span
class="method-args">(type, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="to_feed-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1278</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_feed</span>(<span class="ruby-identifier">type</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-constant">Maker</span>.<span class="ruby-identifier">make</span>(<span class="ruby-identifier">type</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">maker</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">setup_maker</span>(<span class="ruby-identifier">maker</span>)
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">maker</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_rss" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_rss</span><span
class="method-args">(type, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="to_rss-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1285</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_rss</span>(<span class="ruby-identifier">type</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">to_feed</span>(<span class="ruby-node">"rss#{type}"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_xml" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_xml</span><span
class="method-args">(type=nil, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="to_xml-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1293</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_xml</span>(<span class="ruby-identifier">type</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">same_feed_type?</span>(<span class="ruby-identifier">type</span>)
<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">to_feed</span>(<span class="ruby-identifier">type</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>).<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-maker_target" class="method-detail ">
<div class="method-heading">
<span class="method-name">maker_target</span><span
class="method-args">(target)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="maker_target-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1338</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">maker_target</span>(<span class="ruby-identifier">target</span>)
<span class="ruby-identifier">target</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ns_declarations" class="method-detail ">
<div class="method-heading">
<span class="method-name">ns_declarations</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="ns_declarations-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1329</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ns_declarations</span>
<span class="ruby-identifier">decls</span> = {}
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">NSPOOL</span>.<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">uri</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">prefix</span> = <span class="ruby-node">":#{prefix}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">prefix</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">decls</span>[<span class="ruby-node">"xmlns#{prefix}"</span>] = <span class="ruby-identifier">uri</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">decls</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-same_feed_type-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">same_feed_type?</span><span
class="method-args">(type)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="same_feed_type-3F-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1302</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">same_feed_type?</span>(<span class="ruby-identifier">type</span>)
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/^(atom|rss)?(\d+\.\d+)?(?::(.+))?$/i</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">type</span>
<span class="ruby-identifier">feed_type</span> = (<span class="ruby-node">$1</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@feed_type</span>).<span class="ruby-identifier">downcase</span>
<span class="ruby-identifier">feed_version</span> = <span class="ruby-node">$2</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@feed_version</span>
<span class="ruby-identifier">feed_subtype</span> = <span class="ruby-node">$3</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@feed_subtype</span>
[<span class="ruby-identifier">feed_type</span>, <span class="ruby-identifier">feed_version</span>, <span class="ruby-identifier">feed_subtype</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">feed_info</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tag" class="method-detail ">
<div class="method-heading">
<span class="method-name">tag</span><span
class="method-args">(indent, attrs={}, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="tag-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1313</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tag</span>(<span class="ruby-identifier">indent</span>, <span class="ruby-identifier">attrs</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">rv</span> = <span class="ruby-keyword">super</span>(<span class="ruby-identifier">indent</span>, <span class="ruby-identifier">ns_declarations</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">attrs</span>), <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">rv</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">rv</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-node">"#{xmldecl}#{xml_stylesheet_pi}#{rv}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-xmldecl" class="method-detail ">
<div class="method-heading">
<span class="method-name">xmldecl</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="xmldecl-source">
<pre><span class="ruby-comment"># File lib/rss/rss.rb, line 1319</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">xmldecl</span>
<span class="ruby-identifier">rv</span> = <span class="ruby-node">%Q[<?xml version="#{@version}"]</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@output_encoding</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@encoding</span>
<span class="ruby-identifier">rv</span> <span class="ruby-operator"><<</span> <span class="ruby-node">%Q[ encoding="#{@output_encoding or @encoding}"]</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">rv</span> <span class="ruby-operator"><<</span> <span class="ruby-string">%Q[ standalone="yes"]</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@standalone</span>
<span class="ruby-identifier">rv</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"?>\n"</span>
<span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>