]> git.wincent.com - wikitext.git/commitdiff
doc: initial updates for forthcoming 2.0 release
authorWincent Colaiuta <win@wincent.com>
Fri, 11 Jun 2010 16:49:39 +0000 (18:49 +0200)
committerWincent Colaiuta <win@wincent.com>
Fri, 11 Jun 2010 16:49:39 +0000 (18:49 +0200)
Signed-off-by: Wincent Colaiuta <win@wincent.com>
README.rdoc
doc/RELEASE-NOTES

index 647436c9ef12530feed86deb34b0e3a1fa27571e..dd5f9b50eb7a507d459d8ddb0a099a93ded6bbee 100644 (file)
@@ -34,7 +34,7 @@ of design goals flowed on from this:
   printable ASCII in a compatible fashion
 * _attractive_: the emitted HTML source should be consistent and attractive
 * <em>valid output</em>: regardless of the input, the translator should
-  always produce valid XHTML output
+  always produce valid HTML5 output
 * <em>well-tested</em>: the translator should have a comprehensive test
   suite to ensure that its behaviour is not only correct but also stable
   over time
@@ -134,6 +134,9 @@ backtick (`) as a shorthand. These two are equivalent:
   <tt>fixed</tt>
   `fixed`
 
+As of version 2.0, this markup is actually translated to +code+ tags
+in the output because the +tt+ tag was removed from the HTML5 standard.
+
 If you need to insert a literal backtick in your text you use a +nowiki+
 span:
 
@@ -324,7 +327,10 @@ in your <tt>config/environment.rb</tt>:
 
 Add a line like the following to your Gemfile:
 
-  gem 'wikitext'
+  gem 'wikitext', '>= 2.0'
+
+Note that while older versions of Wikitext do work with Rails 3 to some degree,
+for full compatibility Wikitext version 2.0 or higher should be used.
 
 At the time of writing, it appears that Rails 3 and Bundler do not
 automatically call the <tt>rails/init.rb</tt> file any more, so it is necessary
index 532810a9fba0e81a78669647f9c60961dc7ea519..5b2fa981bd01713e3e96087966515d0294542877 100644 (file)
@@ -6,6 +6,12 @@ require any user or developer action are generally not included
 in these release notes. For a full listing of all changes see
 the source code repository at: http://git.wincent.com.
 
+= Changes in 2.0
+
+* compatibility with the Rails 3 template handler API
+* +code+ tags are now emitted instead of +tt+ tags for compliance
+  with the HTML5 specification
+
 = Changes in 1.12
 
 * the String#w and String#to_wikitext methods mark their returned