malt 0.3.0 → 0.4.0

data/qed/03_formats/04_markdown.rdoc

@@ -1,66 +0,0 @@
-== Markdown
-
-Malt supports Markdown via either the RDiscount, BlueCloth or Kramdown backends.
-
-Lets say we have a Markdown document called 'test.md' containing ...
-
-  # Example
-
-  This is an example of Markdown rendering.
-
-Markdown documents are recognized by the +.markdown+ or +.md+ file extensions.
-
-  html = Malt.render(:file=>'tmp/test.md')
-
-  html.assert.include?('<h1>Example</h1>')
-
-By default teh RDiscount library is used to render markdown documents, but
-Malt supports BlueCloth and Kramdown as well. These case be used by setting
-the :engine option.
-
-  html = Malt.render(:file=>'tmp/test.md', :engine=>:bluecloth)
-
-And as we can see the document rendered as expected.
-
-  html.assert.include?('<h1>Example</h1>')
-
-And using the Kramdown library,
-
-  html = Malt.render(:file=>'tmp/test.md', :engine=>:kramdown)
-
-We can see the document rendered as well, though notice that Kramdown provides
-some bonus features compared to the other rendering engines.
-
-  html.assert.include?('<h1 id="example">Example</h1>')
-
-Malt supports Markdown via either the RDiscount, BlueCloth or Kramdown backends.
-
-Lets say we have an Markdown document called 'test.md' containing ...
-
-  # Example
-
-  This is an example of Markdown rendering.
-
-We can access the file via the +Malt.file+ method. Markdown documents are
-recognized by the +.markdown+ or +.md+ file extensions.
-
-  mark = Malt.file('tmp/test.md')
-
-We can the convert the document to a Malt Html object via the #to_html method.
-
-  html = mark.to_html
-
-Notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-And that by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example</h1>')
-
-Or we can convert the document directly to HTML via the #html method.
-
-  out = mark.html
-
-  out.assert.include?('<h1>Example</h1>')
-

data/qed/03_formats/05_erb.rdoc

@@ -1,65 +0,0 @@
-== ERB
-
-Malt supports ERB via the ERB and Erubis engines. 
-
-Lets say we have a ERB document called 'test.erb' containing ...
-
-  <h1>Example <%= title %></h1>
-
-  <p>This is an example of ERB template.</p>
-
-We can render erb documents via the +render+ method, as we can any format.
-However, becuase ERB if a template format and not just a markup syntax,
-we need to also provide the +render+ methods with data for interpolation
-into the ERB document. 
-
-  data = { :title=>"Document" }
-
-  html = Malt.render(:file=>'tmp/test.erb', :data=>data)
-
-And as we can see the document rendered as expected.
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-ERB doesn't actually care what format the document is rendered as. The 
-template could have been any text file what so ever, so using the `:format`
-option would have no effect here.
-
-By default the common ERB library is used to render erb documents. By setting
-the :engine option, Erubis can be used instead.
-
-  html = Malt.render(:file=>'tmp/test.erb', :data=>data, :engine=>:erubis)
-
-And as we can see the document rendered as expected.
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-Malt supports template engines as well as formats. 
-
-Lets say we have an ERB document called 'test.erb' containing ...
-
-  <h1>Example <%= title %></h1>
-
-  <p>This is an example of ERB template.</p>
-
-We can render erb documents to any format we wish.
-
-  erb = Malt.file('tmp/test.erb')
-
-  html = erb.to_html(:title=>"Document")
-
-We will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-And that by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example Document</h1>')
-
-Or we can convert the document directly to HTML via the #html method.
-
-  out = erb.html(:title=>"Alternate")
-
-  out.assert.include?('<h1>Example Alternate</h1>')
-
-ERB doesn't actually care what format the document is rendered as.

data/qed/03_formats/06_liquid.rdoc

@@ -1,54 +0,0 @@
-== Liquid
-
-Lets say we have a Liquid document called 'test.liquid' containing:
-
-  <h1>Example {{ title }}</h1>
-
-  <p>This is an example of a Liquid template.</p>
-
-We can render liquid documents via the +render+ method, as we can any format.
-However, becuase Liquid is a template format and not just a markup syntax,
-we need to also provide the +render+ function with data for interpolation
-into the liquid document. 
-
-  data = { :title=>"Document" }
-
-  html = Malt.render(:file=>'tmp/test.liquid', :data=>data)
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-Liquid doesn't actually care what format the document is rendered as, since it
-is purely a template engine that can be applied to any other format.
-Lets say we have a Liquid document called 'test.liquid' containing ...
-
-  <h1>Example {{ title }}</h1>
-
-  <p>This is an example of a Liquid template.</p>
-
-We can render erb documents to any format we wish.
-
-  liq = Malt.file('tmp/test.liquid')
-
-  html = liq.to_html(:title=>"Document")
-
-We will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-We will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-Then by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example Document</h1>')
-
-Or we can convert the document directly to HTML via the #html method.
-
-  out = liq.html(:title=>"Alternate")
-
-  out.assert.include?('<h1>Example Alternate</h1>')
-
-Liquid doesn't actually care what format the document is rendered as, since it
-is purely a template engine that can be applied to any format.
-

data/qed/03_formats/07_haml.rdoc

@@ -1,44 +0,0 @@
-== Haml
-
-Lets say we have a Haml document called 'test.haml' containing:
-
-  %h1== Example #{title}
-  %p This is an example of a Haml template.
-
-We can render Haml documents via the +render+ method, as we can any format.
-While it might not appear as such on first glance, Haml is actually a template
-format and not just a markup language, so we need to also provide the +render+
-function with data for interpolation into the Haml document. 
-
-  data = { :title=>"Document" }
-
-  html = Malt.render(:file=>'tmp/test.haml', :data=>data)
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-We can get a hold of the Haml document via the Malt.file function.
-
-  haml = Malt.file('tmp/test.haml')
-
-  haml.class.assert == Malt::Format::Haml
-
-We can convert Haml documents to html very easily.
-
-  data = {:title => "Document"}
-
-  html = haml.to_html(data)
-
-First we will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-And that by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example Document</h1>')
-
-Or we can convert the Haml document directly to HTML via the #html method.
-
-  out = haml.html(data)
-
-  out.assert.include?('<h1>Example Document</h1>')
-

data/qed/03_formats/08_ragtag.rdoc

@@ -1,19 +0,0 @@
-== RagTag
-
-Lets say we have a Rtals document called 'test.rt' containing:
-
-  <html>
-  <body>
-    <h1>Example <span replace="title">DUMMY</span></h1>
-    <p>This is an example of a RagTag template.</p>
-  </body>
-  </html>
-
-We can render Rtal documents via the +render+ method, as we can any format.
-
-  data = { :title=>"Document" }
-
-  html = Malt.render(:file=>'tmp/test.rt', :data=>data)
-
-  html.assert.include?('<h1>Example Document</h1>')
-

data/qed/03_formats/09_radius.rdoc

@@ -1,43 +0,0 @@
-== Radius
-
-Lets say we have a Radius document called 'test.radius' containing:
-
-  <h1>Example <r:title /></h1>
-  <p>This is an example of a Radius template.</p>
-
-We can render Radius documents via the +render+ method, as we can any format.
-
-  data = {:title=>"Document"}
-
-  html = Malt.render(:file=>'tmp/test.radius', :data=>data, :tag_prefix=>'r')
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-We can get a hold of the Radius document via the Malt.file function.
-
-  radi = Malt.file('tmp/test.radius', :tag_prefix=>'r')
-
-  radi.class.assert == Malt::Format::Radius
-
-Notice here we have passed an option to the file constructor. This option
-is passed on the underlying Radius.new method. Now we can convert Radius
-documents to HTML documents via #to_html.
-
-  data = {:title => "Document"}
-
-  html = radi.to_html(data)
-
-First we will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-And that by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example Document</h1>')
-
-Or we can convert the Radius document directly to HTML via the #html method.
-
-  out = radi.html(data)
-
-  out.assert.include?('<h1>Example Document</h1>')
-

data/qed/03_formats/11_tenjin.rdoc

@@ -1,47 +0,0 @@
-== Tenjin
-
-While Tenjin is generally intended to be used to render HTML documents, it is
-a general purpose template format that can be used for any type of document.
-For these uses, the Tenjin file extension is '.tenjin'.
-
-Lets say we have a Tenjin document called 'test.tenjin' containing:
-
-  Hello #{@name}!
-
-We can render the document via #render.
-
-  data = { :name=>'World', :items=>['A','B','C'] }
-
-  @text = Malt.render(:file=>'tmp/test.tenjin', :data=>data)
-
-And we can verify that @text is:
-
-  Hello World!
-
-We can get a OOP interface tothe Tenjin document via the Malt.file function.
-
-  tenjin = Malt.file('tmp/test.tenjin')
-
-  tenjin.class.assert == Malt::Format::Tenjin
-
-Since Tenjin is aa general pupose template foramt, we can convert Tenjin
-documents to any format we wish. For instance we can convert our example
-to a Text documents via #to_txt.
-
-  data = { :name=>'World', :items=>['<AAA>', 'B&B', '"CCC"'] }
-
-  text = tenjin.to_txt(data)
-
-First we will notice that the output is an instance of `Malt::Format::Text`.
-
-  text.class.assert == Malt::Format::Text
-
-And that by calling #to_s we can get the rendered Text document.
-
-  text.to_s.assert.include?('Hello World!')
-
-Or we can convert the Tenjin document directly to text via the #txt method.
-
-  out = tenjin.txt(data)
-
-  out.assert.include?('Hello World!')

data/qed/03_formats/12_rbhtml.rdoc

@@ -1,55 +0,0 @@
-== RBHTML
-
-Tenjin is a general purpose template language with support for multiple
-languages including Ruby. The variation of Tenjin for Ruby, called rbTenjin,
-defines a document format with an extension of `.rbhtml`.
-
-Lets say we have a Tenjin document called 'test.rbhtml' containing:
-
-  Hello #{@name}!
-  <ul>
-  <?rb for item in @items ?>
-   <li>${item}</li>
-  <?rb end ?>
-  </ul>
-
-We can render the document via #render.
-
-  data = { :name=>'World', :items=>['<AAA>', 'B&B', '"CCC"'] }
-
-  @html = Malt.render(:file=>'tmp/test.rbhtml', :data=>data)
-
-And we can verify that @html is:
-
-  Hello World!
-  <ul>
-   <li>&lt;AAA&gt;</li>
-   <li>B&amp;B</li>
-   <li>&quot;CCC&quot;</li>
-  </ul>
-
-We can get a hold of the RBHTML document via the Malt.file function.
-
-  rbhtml = Malt.file('tmp/test.rbhtml')
-
-  rbhtml.class.assert == Malt::Format::RBHTML
-
-We can convert RBHTML documents to HTML documents via #to_html.
-
-  data = { :name=>'World', :items=>['<AAA>', 'B&B', '"CCC"'] }
-
-  html = rbhtml.to_html(data)
-
-First we will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-And that by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('Hello World!')
-
-Or we can convert the RBHTML document directly to HTML via the #html method.
-
-  out = rbhtml.html(data)
-
-  out.assert.include?('Hello World!')

data/qed/03_formats/13_sass.rdoc

@@ -1,55 +0,0 @@
-== Sass
-
-Lets say we have a Sass document called 'test.sass' containing:
-
-  $blue: #3bbfce
-  $margin: 16px
-
-  .content-navigation
-    border-color: $blue
-    color: darken($blue, 9%)
-
-  .border
-    padding: $margin / 2
-    margin: $margin / 2
-    border-color: $blue
-
-We can render the Sass document via #render.
-
-  @css = Malt.render(:file=>'tmp/test.sass')
-
-And we can verify that @css is the expected CSS:
-
-  .content-navigation {
-    border-color: #3bbfce;
-    color: #2ca2af; }
-
-  .border {
-    padding: 8px;
-    margin: 8px;
-    border-color: #3bbfce; }
-
-We can also get a hold of the Sass document via the Malt.file function.
-
-  sass = Malt.file('tmp/test.sass')
-
-  sass.class.assert == Malt::Format::Sass
-
-We can convert the Sass document to a CSS document via the #to_css method.
-
-  css = sass.to_css
-
-We can see that the output is an instance of Malt::Format::HTML.
-
-  css.class.assert == Malt::Format::CSS
-
-And that by calling #to_s we can get the rendered CSS document.
-
-  css.to_s.assert.include?('border-color: #3bbfce;')
-
-Or we can convert the Sass document directly to CSS via the #css method.
-
-  out = sass.css
-
-  out.assert.include?('border-color: #3bbfce;')
-