Class: Tilt::RDocTemplate

Inherits:
Template show all
Defined in:
lib/tilt/rdoc.rb

Overview

RDoc template. See: rdoc.rubyforge.org/

It's suggested that your program require 'rdoc/markup' and 'rdoc/markup/to_html' at load time when using this template engine.

Instance Attribute Summary

Attributes inherited from Template

#data, #file, #line, #options

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Template

#basename, cached_evaluate, #compile_template_method, #eval_file, #evaluate_source, #initialize, #name, #render

Constructor Details

This class inherits a constructor from Tilt::Template

Class Method Details

+ (Boolean) engine_initialized?

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/tilt/rdoc.rb', line 13

def self.engine_initialized?
  defined? ::RDoc::Markup
end

Instance Method Details

- (Object) evaluate(scope, locals, &block) 



28
29
30
 
# File 'lib/tilt/rdoc.rb', line 28

def evaluate(scope, locals, &block)
  @output ||= @engine.to_s
end

- (Object) initialize_engine 



17
18
19
20
 
# File 'lib/tilt/rdoc.rb', line 17

def initialize_engine
  require_template_library 'rdoc/markup'
  require_template_library 'rdoc/markup/to_html'
end

- (Object) prepare 



22
23
24
25
26
 
# File 'lib/tilt/rdoc.rb', line 22

def prepare
  markup = RDoc::Markup::ToHtml.new
  @engine = markup.convert(data)
  @output = nil
end