In Files

Parent

Object

Class/Module Index [+]

Quicksearch

HikiDoc

Public Class Methods

new(output, options = {}) click to toggle source 
# File lib/hikidoc.rb, line 56
def initialize(output, options = {})
  @output = output
  @options = default_options.merge(options)
  @header_re = nil
  @level = options[:level] || 1
  @plugin_syntax = options[:plugin_syntax] || method(:valid_plugin_syntax?)
end
to_html(src, options = {}) click to toggle source 
# File lib/hikidoc.rb, line 48
def HikiDoc.to_html(src, options = {})
  new(HTMLOutput.new(">"), options).compile(src)
end
to_xhtml(src, options = {}) click to toggle source 
# File lib/hikidoc.rb, line 52
def HikiDoc.to_xhtml(src, options = {})
  new(HTMLOutput.new(" />"), options).compile(src)
end

Public Instance Methods

compile(src) click to toggle source 
# File lib/hikidoc.rb, line 64
def compile(src)
  @output.reset
  escape_plugin_blocks(src) {|escaped|
    compile_blocks escaped
    @output.finish
  }
end
to_html() click to toggle source

for backward compatibility

# File lib/hikidoc.rb, line 73
def to_html
  $stderr.puts("warning: HikiDoc#to_html is deprecated. Please use HikiDoc.to_html or HikiDoc.to_xhtml instead.")
  self.class.to_html(@output, @options)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.