Module: Sinatra::Helpers::Stream::Templates

### Home Classes Methods

### In Files

- lib/sinatra/base.rb

### Namespace

- MODULE Sinatra::Helpers::Stream::Templates::ContentTyped

### Methods

- ::new
- #builder
- #coffee
- #creole
- #erb
- #erubis
- #find_template
- #haml
- #less
- #liquid
- #markaby
- #markdown
- #nokogiri
- #rabl
- #radius
- #rdoc
- #sass
- #scss
- #slim
- #stylus
- #textile
- #wlang
- #yajl

### Files

- LICENSE

### Class/Module Index

Quicksearch

- Sinatra
- Sinatra::Application
- Sinatra::CommonLogger
- Sinatra::ExtendedRack
- Sinatra::Helpers
- Sinatra::Helpers::Stream
- Sinatra::Helpers::Stream::Application
- Sinatra::Helpers::Stream::Base
- Sinatra::Helpers::Stream::Templates
- Sinatra::Helpers::Stream::Templates::ContentTyped
- Sinatra::Helpers::Stream::Wrapper
- Sinatra::Request
- Sinatra::Request::AcceptEntry
- Sinatra::Response
- Sinatra::ShowExceptions
- Rack
- Rack::Builder

No matching classes.

# Sinatra::Helpers::Stream::Templates

Template rendering methods. Each method takes the name of a template to render as a Symbol and returns a String with the rendered output, as well as an optional hash with additional options.

`template` is either the name or path of the template as symbol (Use `:‘subdir/myview’` for views in subdirectories), or a string that will be rendered.

Possible options are:

    :content_type   The content type to use, same arguments as content_type.
    :layout         If set to something falsy, no layout is rendered, otherwise
                    the specified layout is used (Ignored for `sass` and `less`)
    :layout_engine  Engine to use for rendering the layout.
    :locals         A hash with local variables that should be available
                    in the template
    :scope          If set, template is evaluate with the binding of the given
                    object rather than the application instance.
    :views          Views directory to use.

### Public Class Methods

new() click to toggle source

    # File lib/sinatra/base.rb, line 658
    def initialize
      super
      @default_layout = :layout
    end

### Public Instance Methods

builder(template = nil, options = {}, locals = {}, &block) click to toggle source

    # File lib/sinatra/base.rb, line 697
    def builder(template = nil, options = {}, locals = {}, &block)
      options[:default_content_type] = :xml
      render_ruby(:builder, template, options, locals, &block)
    end

coffee(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 726
    def coffee(template, options = {}, locals = {})
      options.merge! :layout => false, :default_content_type => :js
      render :coffee, template, options, locals
    end

creole(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 740
    def creole(template, options = {}, locals = {})
      render :creole, template, options, locals
    end

erb(template, options = {}, locals = {}, &block) click to toggle source

    # File lib/sinatra/base.rb, line 663
    def erb(template, options = {}, locals = {}, &block)
      render(:erb, template, options, locals, &block)
    end

erubis(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 667
    def erubis(template, options = {}, locals = {})
      warn "Sinatra::Templates#erubis is deprecated and will be removed, use #erb instead.\n"          "If you have Erubis installed, it will be used automatically."
      render :erubis, template, options, locals
    end

find_template(views, name, engine) click to toggle source

Calls the given block for every possible template file in views, named name.ext, where ext is registered on engine.

    # File lib/sinatra/base.rb, line 760
    def find_template(views, name, engine)
      yield ::File.join(views, "#{name}.#{@preferred_extension}")
      Tilt.mappings.each do |ext, engines|
        next unless ext != @preferred_extension and engines.include? engine
        yield ::File.join(views, "#{name}.#{ext}")
      end
    end

haml(template, options = {}, locals = {}, &block) click to toggle source

    # File lib/sinatra/base.rb, line 673
    def haml(template, options = {}, locals = {}, &block)
      render(:haml, template, options, locals, &block)
    end

less(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 687
    def less(template, options = {}, locals = {})
      options.merge! :layout => false, :default_content_type => :css
      render :less, template, options, locals
    end

liquid(template, options = {}, locals = {}, &block) click to toggle source

    # File lib/sinatra/base.rb, line 702
    def liquid(template, options = {}, locals = {}, &block)
      render(:liquid, template, options, locals, &block)
    end

markaby(template = nil, options = {}, locals = {}, &block) click to toggle source

    # File lib/sinatra/base.rb, line 722
    def markaby(template = nil, options = {}, locals = {}, &block)
      render_ruby(:mab, template, options, locals, &block)
    end

markdown(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 706
    def markdown(template, options = {}, locals = {})
      render :markdown, template, options, locals
    end

nokogiri(template = nil, options = {}, locals = {}, &block) click to toggle source

    # File lib/sinatra/base.rb, line 731
    def nokogiri(template = nil, options = {}, locals = {}, &block)
      options[:default_content_type] = :xml
      render_ruby(:nokogiri, template, options, locals, &block)
    end

rabl(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 753
    def rabl(template, options = {}, locals = {})
      Rabl.register!
      render :rabl, template, options, locals
    end

radius(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 718
    def radius(template, options = {}, locals = {})
      render :radius, template, options, locals
    end

rdoc(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 714
    def rdoc(template, options = {}, locals = {})
      render :rdoc, template, options, locals
    end

sass(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 677
    def sass(template, options = {}, locals = {})
      options.merge! :layout => false, :default_content_type => :css
      render :sass, template, options, locals
    end

scss(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 682
    def scss(template, options = {}, locals = {})
      options.merge! :layout => false, :default_content_type => :css
      render :scss, template, options, locals
    end

slim(template, options = {}, locals = {}, &block) click to toggle source

    # File lib/sinatra/base.rb, line 736
    def slim(template, options = {}, locals = {}, &block)
      render(:slim, template, options, locals, &block)
    end

stylus(template, options={}, locals={}) click to toggle source

    # File lib/sinatra/base.rb, line 692
    def stylus(template, options={}, locals={})
      options.merge! :layout => false, :default_content_type => :css
      render :styl, template, options, locals
    end

textile(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 710
    def textile(template, options = {}, locals = {})
      render :textile, template, options, locals
    end

wlang(template, options = {}, locals = {}, &block) click to toggle source

    # File lib/sinatra/base.rb, line 744
    def wlang(template, options = {}, locals = {}, &block)
      render(:wlang, template, options, locals, &block)
    end

yajl(template, options = {}, locals = {}) click to toggle source

    # File lib/sinatra/base.rb, line 748
    def yajl(template, options = {}, locals = {})
      options[:default_content_type] = :json
      render :yajl, template, options, locals
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.