]> git.wincent.com - wikitext.git/commitdiff
Update documentation for 1.11 release
authorWincent Colaiuta <win@wincent.com>
Sun, 25 Apr 2010 19:54:12 +0000 (21:54 +0200)
committerWincent Colaiuta <win@wincent.com>
Sun, 25 Apr 2010 20:10:20 +0000 (22:10 +0200)
Signed-off-by: Wincent Colaiuta <win@wincent.com>
README.rdoc
doc/RELEASE-NOTES

index 6d9f485453e7ab256200fae3195cf37c746d0743..647436c9ef12530feed86deb34b0e3a1fa27571e 100644 (file)
@@ -1,4 +1,4 @@
-The wikitext extension is a fast wikitext-to-HTML translator written
+The Wikitext extension is a fast wikitext-to-HTML translator written
 in C and packaged as a Ruby extension.
 
 Usage is straightforward:
@@ -235,7 +235,7 @@ the two styles (HTML markup and wikitext markup).
 +pre+ blocks may also contain a custom +lang+ attribute for the purposes
 of marking up a block for syntax-highlighting (note that the highlighting
 itself would be provided by JavaScript in the browser and is not actually
-part of the wikitext extension). For example:
+part of the Wikitext extension). For example:
 
   <pre lang="ruby">puts @person.name</pre>
 
@@ -298,6 +298,42 @@ Would become:
 
   <img src="/foo.png" alt="/foo.png" />
 
+= Rails support
+
+The Wikitext extension provides a template handler so that templates named
+following the <tt>template_name.html.wikitext</tt> format will automatically be
+translated from wikitext markup into HTML when rendered.
+
+Likewise, a +to_wikitext+ method (aliased as +w+) is added to the +String+
+class (and also +NilClass+, for convenience) so that content can be easily
+translated.
+
+Finally, a Wikitext::Parser#shared_parser method is added to provide
+convenient access to a shared singleton instance of the parser so as to
+avoid repeatedly instantiating and setting up new parser instances as part
+of every request.
+
+== Rails 2.3
+
+The plug-in can be activated with an appropriate <tt>config.gem</tt> statement
+in your <tt>config/environment.rb</tt>:
+
+  config.gem 'wikitext'
+
+== Rails 3.0
+
+Add a line like the following to your Gemfile:
+
+  gem 'wikitext'
+
+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
+to explicitly activate the Rails support (the template handler, +to_wikitext+
+and +w+ methods, and +shared_parser+ instance) by adding a line like this
+to a file under <tt>config/initializers</tt>:
+
+  require 'wikitext/rails'
+
 = Links
 
 * RubyForge project page: http://rubyforge.org/projects/wikitext
@@ -307,7 +343,7 @@ Would become:
 
 = License
 
-Copyright 2007-2009 Wincent Colaiuta. All rights reserved.
+Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
@@ -332,7 +368,7 @@ POSSIBILITY OF SUCH DAMAGE.
 
 = Feedback
 
-Please let me know if you're using the wikitext extension in your project.
+Please let me know if you're using the Wikitext extension in your project.
 If you have any bug reports or feature requests please open a ticket in
 the issue tracker at https://wincent.com/issues.
 
index e70b9dc48b9e21f7b3c210b801990d203479ac2a..fd8b32ae32e9ae5a38f1b1d05fbbbe71e66ad700 100644 (file)
@@ -6,6 +6,16 @@ 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 1.11
+
+* extract Gem specification into separate file for compatibility
+  with Bundler's "install from Git repository" functionality
+* updates for compatibility with Rails 3
+
+= Changes in 1.10.1
+
+* fix builds on 64-bit Darwin platforms
+
 = Changes in 1.10
 
 * a +wikitext+ executable is now included for processing wikitext
@@ -15,7 +25,7 @@ the source code repository at: http://git.wincent.com.
 
 = Changes in 1.9
 
-* NilClass#w method now accepts and optional parameters hash
+* NilClass#w method now accepts an optional parameters hash
 * new +link_proc+ option to Wikitext::Parser#parse allows you to
   dynamically apply a custom CSS class based on the link target;
   this can be used, for example, to provide "red links" for