w2tags 0.9.3

data/doc/HAML.rdoc

@@ -0,0 +1,310 @@
+== W2TAGS mimics HAML command
+
+w2tags mimics HAML command, these are my decission to make it easy for
+users that already use HAML templating engines, but not all command implemented.
+
+To new users on HAML, I think is not hard to understand of the HAML command, 
+I'll explain basic of W2TAGS HAML like command on w2tags.
+
+Rule of W2TAGS HAML like command are:
+
+* begin with token ( /[ \t]*TOKEN/ ) of command
+* indentations to make tag have a block of children-tag, or children-tag are
+  element of tag with more spaces than parent tag.
+* Auto closing will be added (from previouse tag) if indentations less spaces.
+* Tags-Formating (%) have character that will represent an ID(#), CLASS(.),
+  Attribute({}), Ruby Code(=), and Ruby String(==) or I call it Key-Variable.
+
+List of HAML command. This list are the HAML command that token begin with:
+  
+  %  Tag formating 
+  #  div formating with attribute id
+  .  div formating with attribute class
+  \  line text / no parsing
+  -  translate to Ruby code
+  =  translate to Ruby code
+  == translate to Ruby String
+  -# block remark / comment not include on result 
+  -! block not parse
+
+For details implementation, you must see on each explanation of these command below.
+
+=== %  Tag Formating
+
+==== Basic syntax ( %TAG )
+
+  %ul
+    %li List
+    %li New
+    
+result:
+
+  <ul>
+    <li>List</li>
+    <li>New</li>
+  </ul>
+    
+==== Tag with ID ( %TAG#ID )
+
+  %ul#menu
+    
+result:
+
+  <ul id="menu">
+  </ul>
+    
+==== Tag with CLASS ( %TAG.CLASS )
+
+  %ul.main_side
+    
+result:
+
+  <ul class="main_side">
+  </ul>
+    
+==== Tag with ID CLASS ( %TAG#ID.CLASS )
+
+  %ul#menu.main_side
+    
+result:
+
+  <ul id="menu" class="main_side">
+  </ul>
+    
+==== Tag with Attributes
+  
+this implementations is difference, on w2tags you type (inside "{}") it 
+just like regular attribute must be type.
+
+  %li.hot{line="1"} List
+    
+result:
+
+  <li line="1" class="hot">List</li>
+
+==== Tag with Shortcut to Ruby code (=)
+
+  %div= @value
+    
+result:
+
+  <div><%= @value %></div>
+  
+==== Tag with Shortcut to Ruby String (==)
+
+  %div== #{@value}
+    
+result:
+
+  <div><%= "#{@value}" %></div>
+  
+==== Rule of Combination
+
+Combination of ID, CLASS, Attribute, and "Ruby", just follow from left to the right order, 
+you can have all of this or you can ommit some of this, you can check example below:
+
+Source:
+
+  %div#menu.content.light/
+  %div#id.class1.class2{row="1"}/
+  %div#id.class1/
+  %div#id.class2/
+  %div#id{row="1"}/
+  %div#id/
+  %div.class1.class2{row="1"}/
+  %div.class2.class1{row="1"}/
+  %div.class1{row="1"}/
+  %div.class2{row="1"}/
+  %div.class1/
+  %div.class2/
+  %div{row="1"}/
+  
+Same as:
+  
+  #menu.content.light/
+  #id.class1.class2{row="1"}/
+  #id.class1/
+  #id.class2/
+  #id{row="1"}/
+  #id/
+  .class1.class2{row="1"}/
+  .class2.class1{row="1"}/
+  .class1{row="1"}/
+  .class2{row="1"}/
+  .class1/
+  .class2/
+  %div{row="1"}/
+
+Result:
+
+  <div id="menu" class="content light"/>
+  <div id="id" class="class1 class2" row="1"/>
+  <div id="id" class="class1"/>
+  <div id="id" class="class2"/>
+  <div id="id" row="1"/>
+  <div id="id"/>
+  <div class="class1 class2" row="1"/>
+  <div class="class2 class1" row="1"/>
+  <div class="class1" row="1"/>
+  <div class="class2" row="1"/>
+  <div class="class1"/>
+  <div class="class2"/>
+  <div row="1"/>
+  
+Source:
+
+  %div#menu.content.light= Harsojo
+  %div#id.class1.class2{row="1"}= Harsojo
+  %div#id.class1= Harsojo
+  %div#id.class2= Harsojo
+  %div#id{row="1"}= Harsojo
+  %div#id= Harsojo
+  %div.class1.class2{row="1"}= Harsojo
+  %div.class2.class1{row="1"}= Harsojo
+  %div.class1{row="1"}= Harsojo
+  %div.class2{row="1"}= Harsojo
+  %div.class1= Harsojo
+  %div.class2= Harsojo
+  %div{row="1"}= Harsojo
+    
+result:
+
+  <div id="menu" class="content light"><%= Harsojo %></div>
+  <div id="id" class="class1 class2" row="1"><%= Harsojo %></div>
+  <div id="id" class="class1"><%= Harsojo %></div>
+  <div id="id" class="class2"><%= Harsojo %></div>
+  <div id="id" row="1"><%= Harsojo %></div>
+  <div id="id"><%= Harsojo %></div>
+  <div class="class1 class2" row="1"><%= Harsojo %></div>
+  <div class="class2 class1" row="1"><%= Harsojo %></div>
+  <div class="class1" row="1"><%= Harsojo %></div>
+  <div class="class2" row="1"><%= Harsojo %></div>
+  <div class="class1"><%= Harsojo %></div>
+  <div class="class2"><%= Harsojo %></div>
+  <div row="1"><%= Harsojo %></div>
+
+Source:
+
+  %div#menu.content.light== Harsojo
+  %div#id.class1.class2{row="1"}== Harsojo
+  %div#id.class1== Harsojo
+  %div#id.class2== Harsojo
+  %div#id{row="1"}== Harsojo
+  %div#id== Harsojo
+  %div.class1.class2{row="1"}== Harsojo
+  %div.class2.class1{row="1"}== Harsojo
+  %div.class1{row="1"}== Harsojo
+  %div.class2{row="1"}== Harsojo
+  %div.class1== Harsojo
+  %div.class2== Harsojo
+  %div{row="1"}== Harsojo
+    
+result:
+
+  <div id="menu" class="content light"><%= "Harsojo" %></div>
+  <div id="id" class="class1 class2" row="1"><%= "Harsojo" %></div>
+  <div id="id" class="class1"><%= "Harsojo" %></div>
+  <div id="id" class="class2"><%= "Harsojo" %></div>
+  <div id="id" row="1"><%= "Harsojo" %></div>
+  <div id="id"><%= "Harsojo" %></div>
+  <div class="class1 class2" row="1"><%= "Harsojo" %></div>
+  <div class="class2 class1" row="1"><%= "Harsojo" %></div>
+  <div class="class1" row="1"><%= "Harsojo" %></div>
+  <div class="class2" row="1"><%= "Harsojo" %></div>
+  <div class="class1"><%= "Harsojo" %></div>
+  <div class="class2"><%= "Harsojo" %></div>
+  <div row="1"><%= "Harsojo" %></div>
+
+=== # or . Shortcut for DIV Tag
+As you can see on the example above, alot of command begin with "%div" and it spoted
+as duplicated and need to refactor :(, luckly you can ommit that tag ("%div"), 
+to just write id or class as a HAML command.
+ 
+==== # div formating with attribute id
+
+  #main
+    %ul#menu.main_side
+      %li.hot{line="1"} List
+      %li.hot{line="2"} New
+    
+result:
+
+  <div id="main">
+    <ul id="menu" class="main_side">
+      <li line="1" class="hot">List</li>
+      <li line="2" class="hot">New</li>
+    </ul>
+  </div>
+
+==== . div formating with attribute class
+
+  .content
+    %ul#menu.main_side
+      %li.hot{line="1"} List
+      %li.hot{line="2"} New
+      
+result:
+
+  <div class="content">
+    <ul id="menu" class="main_side">
+      <li line="1" class="hot">List</li>
+      <li line="2" class="hot">New</li>
+    </ul>
+  </div>
+
+==== Other Sample for Shortcut of DIV
+
+  #menu.content.light/
+  #id.class1.class2{row="1"}/
+  #id.class1/
+  #id.class2/
+  #id{row="1"}/
+  #id/
+  .class1.class2{row="1"}/
+  .class2.class1{row="1"}/
+  .class1{row="1"}/
+  .class2{row="1"}/
+  .class1/
+  .class2/
+    
+result:
+
+  <div id="menu" class="content light"/>
+  <div id="id" class="class1 class2" row="1"/>
+  <div id="id" class="class1"/>
+  <div id="id" class="class2"/>
+  <div id="id" row="1"/>
+  <div id="id"/>
+  <div class="class1 class2" row="1"/>
+  <div class="class2 class1" row="1"/>
+  <div class="class1" row="1"/>
+  <div class="class2" row="1"/>
+  <div class="class1"/>
+  <div class="class2"/>
+
+=== \  line text / no parsing
+
+when line text begin with \, \ will be ommited and the rest of line will become
+a plain text no parsing to this line.
+
+=== -  translate to Ruby code
+
+this is a shortcut that after "-", it put inside of "<% %>"
+
+=== =  translate to Ruby code
+
+this is a shortcut that after "=", it put inside of "<%= %>"
+
+==== == translate to Ruby String
+
+this is a shortcut that after "=", it put inside of "<%=\" \"%>"
+
+=== -# block remark / comment not include on result 
+ 
+line inside block of indentation (children of) will become a remark / comment
+the result does not have this block 
+
+=== -! block not parse
+ 
+line inside block of indentation (children-tag) will not be parse, this is usefull
+for some block no need to parse ex: javascript.

data/doc/HOT.rdoc

@@ -0,0 +1,137 @@
+== HOT Files
+   by Widi Harsojo, wharsojo.wordpress.com
+
+code generate by w2tags are so useable because of the rule translation combine 
+with HOT files, in this section I'll explain some of the feature inside it, so
+you will understand how HOT file is working.
+
+== PARAMETERS VARIABLE (MAX:9)
+
+$*, $0 - $9. When you invoke HOT command like this "-all_params one;two;three;four"
+you are invoking HOT command with 4 parameters ($0,$1,$2,$3), and the translation will
+be done like sample below:
+
+  >>_all_params
+  <div>$*</div>
+  -magic $*
+  $1
+  $0
+
+  >>_magic
+  <magic>$0</magic>
+
+$* meaning: this variable will be fill-in after all parameters got  fill-in, as example 
+we supply 4 parameters and parameters fill in to variable only two ($0 = "one", $1 = "two")
+the rest will go to variable $* = "three;four"
+
+  !hot!test
+  -all_params one;two;three;four
+  
+  <div>three;four</div>
+  <magic>three</magic>
+  <magic>four</magic>
+  two
+  one
+
+remember passing paramter to HOT doesn't mean that variable must start from
+zero, its only a guide that you can have multiple params to pass in correct order
+see sample after change the HOT but the result still the same
+
+  >>_all_params
+  <div>$*</div>
+  -magic $*
+  $4
+  $3
+
+  >>_magic
+  <magic>$4</magic>
+
+== PARAMETERS VARIABLE translate to RUBY CODE ( =$0 )
+
+some time it need a block of ruby code / ruby string code inside attribute of tag
+but it must be simple and easy to remember the command and this is how the implementation 
+
+  >>_form
+  %form{action="=$0"}
+
+  -form edit
+
+  <form action="<%= edit %>">
+  </form> 
+  
+== PARAMETERS VARIABLE translate to RUBY STRING CODE ( ==$0 )
+
+  >>_form2
+  %form{action="==$0"}
+
+  -form edit/1
+
+  <form action="<%= "edit/1" %>">
+  </form> 
+  
+== PARAMETERS VARIABLE INTERPOLATION
+
+you can do interpolation on variable
+
+  >>_all_params
+  <div>$*</div>
+  -magic $*
+  $4
+  $3
+
+  >>_magic
+  <magic> $4.upcase.reverse~ </magic>
+
+  !hot!test
+  -all_params one;two;three;four
+  
+  <div>three;four</div>
+  <magic> EERHT </magic>
+  <magic> RUOF </magic>
+  two
+  one
+
+== PARAMETERS VARIABLE DEFAULT OR COMBINE WITH
+
+default mean that is params not supply it will use the default
+
+combine mean that is params not supply it will empty params var inside "~ ~$0" 
+but if it supply, param var will be replace and remove char "~" 
+
+  test.hot
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  >>_all_default
+  -default_var $*
+  -inside_var $*
+
+  >>_default_var
+  %div{ key="~1~$1" } title 1
+  %div{ key="~2~$2" } title 2
+  %div{ key="~3~$3" } title 3
+
+  >>_inside_var
+  %div{ ~att="$1"~} title 1
+  %div{ ~att="$2"~} title 2
+  %div{ ~att="$3"~} title 3
+
+  params.w2erb
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  !hot!test
+  -all_default one;two
+  
+  params.erb
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  <div key="one">title 1</div>
+  <div key="two">title 2</div>
+  <div key="3">title 3</div>
+  <div att="one">title 1</div>
+  <div att="two">title 2</div>
+  <div>title 3</div>
+
+== VARIABLE SET IN SOURCE BUT USE ONLY on HOT
+
+* &myvar=value_of_var
+* @myvar=one;two;three
+
+on @myvar, it can set multiple time and it will have uniq value
+to reset the value, use value with prefix with ";"