Module: MetaTags::ViewHelper
- Defined in:
- lib/meta_tags/view_helper.rb,
sig/lib/meta_tags/view_helper.rbs
Overview
Contains methods to use in views and helpers.
Instance Method Summary collapse
-
#description(description) ⇒ String
Set the page description.
-
#display_meta_tags(defaults = {}) ⇒ String
Set default meta tag values and display meta tags.
-
#display_title(defaults = {}) ⇒ String
Returns full page title as a string without surrounding
tag.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/meta-tags/MetaTags/ViewHelper#keywords-instance_method" title="#keywords (instance method)">#<strong>keywords</strong>(keywords) ⇒ String, Array </a> </span> <span class="summary_desc"><div class='inline'><p>Set the legacy keywords meta tag.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/meta-tags/MetaTags/ViewHelper#meta_tags-instance_method" title="#meta_tags (instance method)">#<strong>meta_tags</strong> ⇒ MetaTagsCollection </a> </span> <span class="summary_desc"><div class='inline'><p>Get meta tags for the page.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/meta-tags/MetaTags/ViewHelper#nofollow-instance_method" title="#nofollow (instance method)">#<strong>nofollow</strong>(nofollow = true) ⇒ Boolean, ... </a> </span> <span class="summary_desc"><div class='inline'><p>Set the nofollow meta tag.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/meta-tags/MetaTags/ViewHelper#noindex-instance_method" title="#noindex (instance method)">#<strong>noindex</strong>(noindex = true) ⇒ Boolean, ... </a> </span> <span class="summary_desc"><div class='inline'><p>Set the noindex meta tag.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/meta-tags/MetaTags/ViewHelper#refresh-instance_method" title="#refresh (instance method)">#<strong>refresh</strong>(refresh) ⇒ Integer, String </a> </span> <span class="summary_desc"><div class='inline'><p>Set the refresh meta tag.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/meta-tags/MetaTags/ViewHelper#set_meta_tags-instance_method" title="#set_meta_tags (instance method)">#<strong>set_meta_tags</strong>(meta_tags = {}) ⇒ void </a> </span> <span class="summary_desc"><div class='inline'><p>Set meta tags for the page.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="/gems/meta-tags/MetaTags/ViewHelper#title-instance_method" title="#title (instance method)">#<strong>title</strong>(title = nil, headline = "") ⇒ String </a> </span> <span class="summary_desc"><div class='inline'><p>Set the page title and return it.</p></div></span> </li> </ul> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="description-instance_method"> #<strong>description</strong>(description) ⇒ <tt>String</tt> </h3><script> document.getElementById("description-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:description">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Set the page description.</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <pre class="example code"><code><span class='id identifier rubyid_description'>description</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>This is login page</span><span class='tstring_end'>'</span></span></code></pre> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>description</span> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p>page description to be set in the HEAD section of the HTML document. Please note that any HTML tags will be stripped from the output string, and the string will be truncated to the configured description limit.</p></div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p>passed value.</p></div> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#display_meta_tags-instance_method" title="MetaTags::ViewHelper#display_meta_tags (method)">#display_meta_tags</a></span></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 84 85 86 87</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 84</span> <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span><span class='lparen'>(</span><span class='id identifier rubyid_description'>description</span><span class='rparen'>)</span> <span class='id identifier rubyid_set_meta_tags'>set_meta_tags</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='rparen'>)</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="display_meta_tags-instance_method"> #<strong>display_meta_tags</strong>(defaults = {}) ⇒ <tt>String</tt> </h3><script> document.getElementById("display_meta_tags-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:display_meta_tags">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Set default meta tag values and display meta tags. This method should be used in the layout file.</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <h5 class="example_title"><div class='inline'><p>Render meta tags in a layout</p></div></h5> <pre class="example code"><code><span class='id identifier rubyid_display_meta_tags'>display_meta_tags</span> <span class='label'>site:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>My website</span><span class='tstring_end'>'</span></span></code></pre> <h5 class="example_title"><div class='inline'><p>ERB layout usage</p></div></h5> <pre class="example code"><code><span class='heredoc_beg'><<~ERB</span> <span class='tstring_content'> <head> </span><span class='tstring_content'> <%= display_meta_tags site: 'My website' %> </span><span class='tstring_content'> </head> </span><span class='heredoc_end'>ERB</span></code></pre> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>defaults</span> <span class='type'>(<tt><span class='object_link'><a href="/gems/meta-tags/Hash" title="Hash (class)">Hash</a></span></tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'><p>default meta tag values.</p></div> </li> <li> <span class='name'>default</span> <span class='type'>(<tt><span class='object_link'><a href="/gems/meta-tags/Hash" title="Hash (class)">Hash</a></span></tt>)</span> — <div class='inline'><p>a customizable set of options</p></div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p>HTML meta tags to render in HEAD section of the HTML document.</p></div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 167 168 169</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 167</span> <span class='kw'>def</span> <span class='id identifier rubyid_display_meta_tags'>display_meta_tags</span><span class='lparen'>(</span><span class='id identifier rubyid_defaults'>defaults</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='id identifier rubyid_meta_tags'>meta_tags</span><span class='period'>.</span><span class='id identifier rubyid_with_defaults'>with_defaults</span><span class='lparen'>(</span><span class='id identifier rubyid_defaults'>defaults</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'><span class='object_link'><a href="/gems/meta-tags/MetaTags/Renderer" title="MetaTags::Renderer (class)">Renderer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="/gems/meta-tags/MetaTags/Renderer#initialize-instance_method" title="MetaTags::Renderer#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_meta_tags'>meta_tags</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_render'><span class='object_link'><a href="/gems/meta-tags/MetaTags/Renderer#render-instance_method" title="MetaTags::Renderer#render (method)">render</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="display_title-instance_method"> #<strong>display_title</strong>(defaults = {}) ⇒ <tt>String</tt> </h3><script> document.getElementById("display_title-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:display_title">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Returns full page title as a string without surrounding <title> tag.</p> <p>The only case when you may need this helper is when you use PJAX. This means that your layout file (with the display_meta_tags helper) will not be rendered, so you have to pass default arguments such as the site title here. You probably want to define a helper with default options to minimize code duplication.</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <h5 class="example_title"><div class='inline'><p>Build a PJAX-compatible title string</p></div></h5> <pre class="example code"><code><span class='id identifier rubyid_display_title'>display_title</span> <span class='label'>title:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>My Page</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>site:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>PJAX Site</span><span class='tstring_end'>'</span></span></code></pre> <h5 class="example_title"><div class='inline'><p>ERB PJAX container usage</p></div></h5> <pre class="example code"><code><span class='heredoc_beg'><<~ERB</span> <span class='tstring_content'> <div data-page-container="true" title="<%= display_title title: 'My Page', site: 'PJAX Site' %>"> </span><span class='tstring_content'> </div> </span><span class='heredoc_end'>ERB</span></code></pre> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>defaults</span> <span class='type'>(<tt><span class='object_link'><a href="/gems/meta-tags/Hash" title="Hash (class)">Hash</a></span></tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'><p>list of meta tags.</p></div> </li> <li> <span class='name'>default</span> <span class='type'>(<tt><span class='object_link'><a href="/gems/meta-tags/Hash" title="Hash (class)">Hash</a></span></tt>)</span> — <div class='inline'><p>a customizable set of options</p></div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>String</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 195 196 197</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 195</span> <span class='kw'>def</span> <span class='id identifier rubyid_display_title'>display_title</span><span class='lparen'>(</span><span class='id identifier rubyid_defaults'>defaults</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='id identifier rubyid_meta_tags'>meta_tags</span><span class='period'>.</span><span class='id identifier rubyid_full_title'>full_title</span><span class='lparen'>(</span><span class='id identifier rubyid_defaults'>defaults</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="keywords-instance_method"> #<strong>keywords</strong>(keywords) ⇒ <tt>String</tt>, <tt>Array</tt> </h3><script> document.getElementById("keywords-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:keywords">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Set the legacy keywords meta tag.</p> <p>Modern search engines ignore this tag, but some older integrations and internal systems may still read it.</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <pre class="example code"><code><span class='id identifier rubyid_keywords'>keywords</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>keyword1, keyword2</span><span class='tstring_end'>'</span></span> <span class='id identifier rubyid_keywords'>keywords</span> <span class='qwords_beg'>%w(</span><span class='tstring_content'>keyword1</span><span class='words_sep'> </span><span class='tstring_content'>keyword2</span><span class='tstring_end'>)</span></span></code></pre> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>keywords</span> <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span> — <div class='inline'><p>keywords meta tag value to render in the HEAD section of the HTML document.</p></div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span> — <div class='inline'><p>passed value.</p></div> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#display_meta_tags-instance_method" title="MetaTags::ViewHelper#display_meta_tags (method)">#display_meta_tags</a></span></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 69 70 71 72</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 69</span> <span class='kw'>def</span> <span class='id identifier rubyid_keywords'>keywords</span><span class='lparen'>(</span><span class='id identifier rubyid_keywords'>keywords</span><span class='rparen'>)</span> <span class='id identifier rubyid_set_meta_tags'>set_meta_tags</span><span class='lparen'>(</span><span class='label'>keywords:</span> <span class='id identifier rubyid_keywords'>keywords</span><span class='rparen'>)</span> <span class='id identifier rubyid_keywords'>keywords</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="meta_tags-instance_method"> #<strong>meta_tags</strong> ⇒ <tt><span class='object_link'><a href="/gems/meta-tags/MetaTags/MetaTagsCollection" title="MetaTags::MetaTagsCollection (class)">MetaTagsCollection</a></span></tt> </h3><script> document.getElementById("meta_tags-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:meta_tags">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Get meta tags for the page.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'><a href="/gems/meta-tags/MetaTags/MetaTagsCollection" title="MetaTags::MetaTagsCollection (class)">MetaTagsCollection</a></span></tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 7 8 9</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 7</span> <span class='kw'>def</span> <span class='id identifier rubyid_meta_tags'>meta_tags</span> <span class='ivar'>@meta_tags</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="/gems/meta-tags/MetaTags/MetaTagsCollection" title="MetaTags::MetaTagsCollection (class)">MetaTagsCollection</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="/gems/meta-tags/MetaTags/MetaTagsCollection#initialize-instance_method" title="MetaTags::MetaTagsCollection#initialize (method)">new</a></span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="nofollow-instance_method"> #<strong>nofollow</strong>(nofollow = true) ⇒ <tt>Boolean</tt>, ... </h3><script> document.getElementById("nofollow-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:nofollow">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Set the nofollow meta tag.</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <pre class="example code"><code><span class='id identifier rubyid_nofollow'>nofollow</span> <span class='kw'>true</span> <span class='id identifier rubyid_nofollow'>nofollow</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>googlebot</span><span class='tstring_end'>'</span></span></code></pre> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>nofollow</span> <span class='type'>(<tt>Boolean</tt>, <tt>String</tt>, <tt>Array<String></tt>)</span> <em class="default">(defaults to: <tt>true</tt>)</em> — <div class='inline'><p>a nofollow value.</p></div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>, <tt>String</tt>, <tt>Array<String></tt>)</span> — <div class='inline'><p>passed value.</p></div> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#display_meta_tags-instance_method" title="MetaTags::ViewHelper#display_meta_tags (method)">#display_meta_tags</a></span></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 110 111 112 113</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 110</span> <span class='kw'>def</span> <span class='id identifier rubyid_nofollow'>nofollow</span><span class='lparen'>(</span><span class='id identifier rubyid_nofollow'>nofollow</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='id identifier rubyid_set_meta_tags'>set_meta_tags</span><span class='lparen'>(</span><span class='label'>nofollow:</span> <span class='id identifier rubyid_nofollow'>nofollow</span><span class='rparen'>)</span> <span class='id identifier rubyid_nofollow'>nofollow</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="noindex-instance_method"> #<strong>noindex</strong>(noindex = true) ⇒ <tt>Boolean</tt>, ... </h3><script> document.getElementById("noindex-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:noindex">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Set the noindex meta tag.</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <pre class="example code"><code><span class='id identifier rubyid_noindex'>noindex</span> <span class='kw'>true</span> <span class='id identifier rubyid_noindex'>noindex</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>googlebot</span><span class='tstring_end'>'</span></span></code></pre> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>noindex</span> <span class='type'>(<tt>Boolean</tt>, <tt>String</tt>, <tt>Array<String></tt>)</span> <em class="default">(defaults to: <tt>true</tt>)</em> — <div class='inline'><p>a noindex value.</p></div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>, <tt>String</tt>, <tt>Array<String></tt>)</span> — <div class='inline'><p>passed value.</p></div> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#display_meta_tags-instance_method" title="MetaTags::ViewHelper#display_meta_tags (method)">#display_meta_tags</a></span></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 97 98 99 100</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 97</span> <span class='kw'>def</span> <span class='id identifier rubyid_noindex'>noindex</span><span class='lparen'>(</span><span class='id identifier rubyid_noindex'>noindex</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='id identifier rubyid_set_meta_tags'>set_meta_tags</span><span class='lparen'>(</span><span class='label'>noindex:</span> <span class='id identifier rubyid_noindex'>noindex</span><span class='rparen'>)</span> <span class='id identifier rubyid_noindex'>noindex</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="refresh-instance_method"> #<strong>refresh</strong>(refresh) ⇒ <tt>Integer</tt>, <tt>String</tt> </h3><script> document.getElementById("refresh-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:refresh">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Set the refresh meta tag.</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <pre class="example code"><code><span class='id identifier rubyid_refresh'>refresh</span> <span class='int'>5</span> <span class='id identifier rubyid_refresh'>refresh</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>5;url=http://www.example.com/</span><span class='tstring_end'>"</span></span></code></pre> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>refresh</span> <span class='type'>(<tt>Integer</tt>, <tt>String</tt>)</span> — <div class='inline'><p>a refresh value.</p></div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Integer</tt>, <tt>String</tt>)</span> — <div class='inline'><p>passed value.</p></div> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#display_meta_tags-instance_method" title="MetaTags::ViewHelper#display_meta_tags (method)">#display_meta_tags</a></span></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 123 124 125 126</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 123</span> <span class='kw'>def</span> <span class='id identifier rubyid_refresh'>refresh</span><span class='lparen'>(</span><span class='id identifier rubyid_refresh'>refresh</span><span class='rparen'>)</span> <span class='id identifier rubyid_set_meta_tags'>set_meta_tags</span><span class='lparen'>(</span><span class='label'>refresh:</span> <span class='id identifier rubyid_refresh'>refresh</span><span class='rparen'>)</span> <span class='id identifier rubyid_refresh'>refresh</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="set_meta_tags-instance_method"> #<strong>set_meta_tags</strong>(meta_tags = {}) ⇒ <tt>void</tt> </h3><script> document.getElementById("set_meta_tags-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:set_meta_tags">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p class="note returns_void">This method returns an undefined value.</p><p>Set meta tags for the page.</p> <p>This method can be used several times, and all passed options will be merged. If you set the same property several times, the last one will take precedence.</p> <p>Usually you will not call this method directly. Use helpers like <span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#title-instance_method" title="MetaTags::ViewHelper#title (method)">#title</a></span>, <span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#description-instance_method" title="MetaTags::ViewHelper#description (method)">#description</a></span>, <span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#noindex-instance_method" title="MetaTags::ViewHelper#noindex (method)">#noindex</a></span>, and #canonical for daily tasks. <span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#keywords-instance_method" title="MetaTags::ViewHelper#keywords (method)">#keywords</a></span> remains available for legacy compatibility.</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <pre class="example code"><code><span class='id identifier rubyid_set_meta_tags'>set_meta_tags</span> <span class='label'>title:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Login Page</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Here you can login</span><span class='tstring_end'>'</span></span> <span class='id identifier rubyid_set_meta_tags'>set_meta_tags</span> <span class='label'>canonical:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://example.com/login</span><span class='tstring_end'>'</span></span></code></pre> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>meta_tags</span> <span class='type'>(<tt><span class='object_link'><a href="/gems/meta-tags/Hash" title="Hash (class)">Hash</a></span></tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'><p>list of meta tags. See <span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#display_meta_tags-instance_method" title="MetaTags::ViewHelper#display_meta_tags (method)">#display_meta_tags</a></span> for allowed options.</p></div> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#display_meta_tags-instance_method" title="MetaTags::ViewHelper#display_meta_tags (method)">#display_meta_tags</a></span></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 27 28 29</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 27</span> <span class='kw'>def</span> <span class='id identifier rubyid_set_meta_tags'>set_meta_tags</span><span class='lparen'>(</span><span class='id identifier rubyid_meta_tags'>meta_tags</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_meta_tags'>meta_tags</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_meta_tags'>meta_tags</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="title-instance_method"> #<strong>title</strong>(title = nil, headline = "") ⇒ <tt>String</tt> </h3><script> document.getElementById("title-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/meta-tags/MetaTags%2FViewHelper:title">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> <p>Set the page title and return it.</p> <p>This method is best suited for use in helpers. It sets the page title and returns it (or <code>headline</code> if specified).</p> </div> </div> <div class="tags"> <div class="examples"> <h4 class="tag_title">Examples:</h4> <h5 class="example_title"><div class='inline'><p>Set HTML title to "Login Page", return "Login Page"</p></div></h5> <pre class="example code"><code><span class='id identifier rubyid_title'>title</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Login Page</span><span class='tstring_end'>'</span></span></code></pre> <h5 class="example_title"><div class='inline'><p>Set HTML title to "Login Page", return "Please login"</p></div></h5> <pre class="example code"><code><span class='id identifier rubyid_title'>title</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Login Page</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Please login</span><span class='tstring_end'>'</span></span></code></pre> <h5 class="example_title"><div class='inline'><p>Set title as array of strings</p></div></h5> <pre class="example code"><code><span class='id identifier rubyid_title'>title</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>part1</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>part2</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='comment'># => "part1 | part2"</span></code></pre> <h5 class="example_title"><div class='inline'><p>Get current title</p></div></h5> <pre class="example code"><code><span class='id identifier rubyid_title'>title</span></code></pre> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>title</span> <span class='type'>(<tt>nil</tt>, <tt>String</tt>, <tt>Array</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>page title. When passed as an <code>Array</code>, parts will be joined using configured separator value (see <span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#display_meta_tags-instance_method" title="MetaTags::ViewHelper#display_meta_tags (method)">#display_meta_tags</a></span>). When nil, current title will be returned.</p></div> </li> <li> <span class='name'>headline</span> <span class='type'>(<tt>String</tt>)</span> <em class="default">(defaults to: <tt>""</tt>)</em> — <div class='inline'><p>the value to return from the method. Useful for using this method in views to set both page title and the content of the heading tag.</p></div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p>returns <code>title</code> value or <code>headline</code> if passed.</p></div> </li> </ul> <p class="tag_title">See Also:</p> <ul class="see"> <li><span class='object_link'><a href="/gems/meta-tags/MetaTags/ViewHelper#display_meta_tags-instance_method" title="MetaTags::ViewHelper#display_meta_tags (method)">#display_meta_tags</a></span></li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 52 53 54 55</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/meta_tags/view_helper.rb', line 52</span> <span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span><span class='lparen'>(</span><span class='id identifier rubyid_title'>title</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_headline'>headline</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='id identifier rubyid_set_meta_tags'>set_meta_tags</span><span class='lparen'>(</span><span class='label'>title:</span> <span class='id identifier rubyid_title'>title</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_title'>title</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='id identifier rubyid_headline'>headline</span><span class='period'>.</span><span class='id identifier rubyid_presence'>presence</span> <span class='op'>||</span> <span class='id identifier rubyid_meta_tags'>meta_tags</span><span class='period'>.</span><span class='id identifier rubyid_page_title'>page_title</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Tue Sep 22 02:47:28 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.7). </div> </div> </body> </html>