Changeset 282

Timestamp:

03/18/2008 10:14:04 (8 months ago)

Author:

jgarber

Message:

Some very basic RDoc comments.

Location:

trunk

Files:

• README (modified) (6 diffs)
• Rakefile (modified) (1 diff)
• ext/redcloth_scan/redcloth_scan.rl (modified) (4 diffs)
• lib/redcloth.rb (modified) (1 diff)

trunk/README

@@ -1 @@
-= RedCloth - Textile and Markdown Hybrid for Ruby
+= RedCloth - Textile parser for Ruby
 
 Homepage::  http://whytheluckystiff.net/ruby/redcloth/
 Author::    why the lucky stiff (http://whytheluckystiff.net/)
-Copyright:: (cc) 2004 why the lucky stiff (and his puppet organizations.)
-License::   BSD
+Copyright:: (c) 2006 why the lucky stiff
 
-(see http://hobix.com/textile/ for a Textile Reference.)
-
-Based on (and also inspired by) both:
-
-PyTextile: http://diveintomark.org/projects/textile/textile.py.txt
-Textism for PHP: http://www.textism.com/tools/textile/
+(See http://hobix.com/textile/ for a Textile reference.)
 
 = RedCloth
 
-RedCloth is a Ruby library for converting Textile and/or Markdown
-into HTML.  You can use either format, intermingled or separately.
-You can also extend RedCloth to honor your own custom text stylings.
-
-RedCloth users are encouraged to use Textile if they are generating
-HTML and to use Markdown if others will be viewing the plain text.
+RedCloth is a Ruby library for converting Textile into HTML.
 
 == What is Textile?
@@ -43 +32 @@
 to the beginning of the paragraph.
 
- h[n].   Header of size [n].
+ h3.     Header 3.
  bq.     Blockquote.
  #       Numeric list.
@@ -73 +62 @@
 
 Optional: text in (parentheses) following the link text, 
-but before the closing quotation mark, will become a Title 
+but before the closing quotation mark, will become a title 
 attribute for the link, visible as a tool tip when a cursor is above it.
 
 Example:
 
- "This is a link (This is a title) ":http://www.textism.com
+ "This is a link (This is a title)":http://www.textism.com
 
 Will become:
@@ -131 +120 @@
 == Adding Tables
 
-In Textile, simple tables can be added by seperating each column by
+In Textile, simple tables can be added by separating each column by
 a pipe.
 
@@ -137 +126 @@
     |And|Another|table|row|
 
-Attributes are defined by style definitions in parentheses.
+Styles are applied with curly braces.
 
-    table(border:1px solid black).
-    (background:#ddd;color:red). |{}| | | |
+    table{border:1px solid black}.
+    {background:#ddd;color:red}. |a|red|row|
 
 == Using RedCloth
@@ -156 +145 @@
  puts doc.to_html
 
-By default, RedCloth uses both Textile and Markdown formatting, with
-Textile formatting taking precedence.  If you want to turn off Markdown
-formatting, to boost speed and limit the processor:
-
- class RedCloth::Textile.new( str )

trunk/Rakefile

@@ -70 +70 @@
     rdoc.main = "README"
     rdoc.title = "RedCloth Documentation"
-    rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/**/*.rb']
+    rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/**/*.rb', 'ext/**/*.c']
 end
 

trunk/ext/redcloth_scan/redcloth_scan.rl

@@ -226 +226 @@
 }
 
+/*
+ * Generates HTML from the Textile contents.
+ *
+ *   r = RedCloth.new( "And then? She *fell*!" )
+ *   r.to_html
+ *     #=>"And then? She <strong>fell</strong>!"
+ */
 static VALUE
 redcloth_to_html(self)
@@ -236 +243 @@
 }
 
+/*
+ * Generates LaTeX from the Textile contents.
+ *
+ *   r = RedCloth.new( "And then? She *fell*!" )
+ *   r.to_latex
+ *     #=>"And then? She \\textbf{fell}!\n\n"
+ */
 static VALUE
 redcloth_to_latex(self)
@@ -258 +272 @@
 void Init_redcloth_scan()
 {
+ /* The RedCloth parser. See the README for Textile syntax. */
   super_RedCloth = rb_define_class("RedCloth", rb_cString);
   rb_define_method(super_RedCloth, "to_html", redcloth_to_html, 0);
@@ -263 +278 @@
   rb_define_method(super_RedCloth, "to", redcloth_to, 1);
   super_ParseError = rb_define_class_under(super_RedCloth, "ParseError", rb_eException);
+  /* RedCloth HTML formatter. */
   super_HTML  = rb_define_module_under(super_RedCloth, "HTML");
+  /* RedCloth LaTeX formatter. */
   super_LATEX = rb_define_module_under(super_RedCloth, "LATEX");
   SYM_html_escape_entities = ID2SYM(rb_intern("html_escape_entities"));

trunk/lib/redcloth.rb

@@ -9 +9 @@
   VERSION = '4.0.0'
   
-  def initialize(input, opts=[])
-    super(input)
+  # Returns a new RedCloth object, based on _string_. The 
+  # _restrictions_ parameter is accepted for backwards
+  # compatibility but is not observed.
+  #
+  #   r = RedCloth.new( "h1. A *bold* man" )
+  #   r.to_html
+  #     #=>"<h1>A <b>bold</b> man</h1>"
+  #
+  def initialize( string, restrictions = [] )
+      super( string )
   end