Class RDoc::TemplatePage
In: lib/rdoc/template.rb
Parent: Object

An ERb wrapper that allows nesting of one ERb template inside another.

This TemplatePage operates similarly to RDoc 1.x‘s TemplatePage, but uses ERb instead of a custom template language.

Converting from a RDoc 1.x template to an RDoc 2.x template is fairly easy.

  • %blah% becomes <%= values["blah"] %>
  • !INCLUDE! becomes <%= template_include %>
  • HREF:aref:name becomes <%= href values["aref"], values["name"] %>
  • IF:blah becomes <% if values["blah"] then %>
  • IFNOT:blah becomes <% unless values["blah"] then %>
  • ENDIF:blah becomes <% end %>
  • START:blah becomes <% values["blah"].each do |blah| %>
  • END:blah becomes <% end %>

To make nested loops easier to convert, start by converting START statements to: 

  <% values["blah"].each do |blah| $stderr.puts blah.keys %>

So you can see what is being used inside which loop.

Methods

href   new   write_html_on  

Public Class methods

new(*templates)

Create a new TemplatePage that will use templates.

Public Instance methods

href(ref, name)

Returns "<a href=\"#{ref}\">#{name}</a>"

write_html_on(io, values)

Process the template using values, writing the result to io.

[Validate]

ruby-doc.org is a service of James Britt and Happy Camper Studios, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.