README

Path: README
Last Update: Fri Dec 17 11:53:52 JST 2004

amrita2 - a html/xhtml template library for Ruby

Summary

Amrita2 is a a html/xhtml template library for Ruby. It makes html documents from a template and a model data.

Key feature

  • The template for amrita2 is a pure html/xhtml document without no special tag like <?…?> or <% .. %>
  • The template can be written by designers using almost any HTML Editor.
  • Need no change on Ruby code to change the view of dynamic part (not only static part) of the template
  • The model data may be standard Ruby data, Hash, Array, String… or an instance of a classes you made.
  • The output is controlled by data not by logic. So It’s easy to write, test, debug code. (Good for eXtreamPrograming)
  • HTML template can be compiled into Ruby code before execution.

Amrita2 mixes a template and model data up to a html document naturally matching the id attribute of HTML element to model data.

template:

   <table border="1">
     <tr><th>name</th><th>author</th></tr>
     <tr id="table1">
       <td id="name"><td id="author">
     </tr>
   </table>

data:

   data = {
      :table1=>[
         { :name=>"Ruby", :author=>"matz" },
         { :name=>"perl", :author=>"Larry Wall" },
         { :name=>"python", :author=>"Guido van Rossum" },
      ]
   }

template + data = output:

  <table>
    <tr>
    <th>name</th>
    <th>author</th>
    </tr>
    <tr>
    <td>Ruby</td>
    <td>matz</td>
    </tr>
    <tr>
    <td>perl</td>
    .......

Installation

Documents and sample

docs/QuickStart
Quick start guide

Credits

License

Amrita2 is Copyright © 2004 Taku Nakajima. It is free software, and may be redistributed under the terms specified in the README file of the Ruby distribution.

If you want to use Amrita2 in other license form, I will give you a BSD-like special license for only specified person and specified purpose. Please mail me about it in JAPANESE for detail.

ToDos and plans

Other stuff

Author:Taku Nakajima <tnakajima@brain-tokyo.jp>
Requires:Ruby 1.8.2 or later
License:Copyright © 2004 Taku Nakajima Released under Ruby’s License

[Validate]