RedCloth 3.0.3 → 3.0.4

data/bin/redcloth

@@ -1,3 +1,3 @@
-#!/usr/local/bin/ruby18
+#!/usr/bin/ruby18
 require 'redcloth'
 puts RedCloth.new( ARGF.read ).to_html

data/doc/CHANGELOG

@@ -0,0 +1,160 @@
+--- %YAML:1.0
+- version: 3.0.4
+  date: 2005-02-18
+  changes:
+    - The caps class doesn't swallow spaces.
+    - Horizontal rules required to be on an empty line.
+    - Hard breaks don't screw with Markdown headers any longer.
+    - Fixed error triggered by complex lists.
+    - Inline markups need to be butted up against enclosing text, no spaces.
+    - Fixed problem with intermingled single and double quotes.
+    - Brought back lite_mode.
+
+- version: 3.0.3
+  date: 2005-02-06
+  changes:
+    - Stack overflow regexp on code inlines obliterated.
+    - Citations scaled back.
+    - Toggle span tags on CAPS with :no_span_tags accessor.
+
+- version: 3.0.2
+  date: 2005-02-02
+  changes:
+    - Stack overflow Regexps replaced.
+    - All code blocks protected from formatting.
+    - Hard breaks working.
+    - Filter HTML now uses detailed cleaner.
+
+- version: 3.0.1
+  date: 2004-11-15
+  changes:
+    - Using `float' rather than `text-align' to align image blocks.
+    - Shelving more HTML attributes to prevent them from clashing with Textile glyphs.
+    - Simplifying the block regexp.
+
+- version: 3.0
+  date: 2004-10-26
+  changes:
+    - Broke up the Textile engine into smaller parts, recoded central block parser.
+    - Added preliminary support for Markdown.
+    - Added support for custom Textile prefixes.
+    - RedCloth now generates XHTML fragments.
+    - Complete HTML documents should now work, RedCloth ignores complex HTML.
+      
+- version: 2.0.12
+  date: 2004-08-09
+  changes:
+    - Escaping tighter for <pre> tags that share a single line.
+    - No more String#htmlesc!.  Moved to RedCloth#htmlesc.
+    - Pruned out the code that was handling multibyte.
+
+- version: 2.0.11
+  date: 2004-06-01
+  changes:
+    - Fixed the new 2.0-style aliased links.
+    - Lines starting with div opening or closing tags aren't given paragraph tags.
+    - Escaped some sample markup that was being translated by RDoc.
+    - Subtle changes to the quick tags to help them interact with surrounding HTML better.
+    - Ensure angle brackets inside code quick tags get escaped.
+    - New patch and test by F. Ros to fix <pre> tags with class settings.
+    - Commented out encode_entities and fix_entities, they do nothing now.  Thanks, Denis.
+    - Scaled back QTAGS a back to avoid mixing up hyphens and dels.  Thanks, Denis.
+    - Work on the references to ensure they are generating at least XHTML 1.0 Transitional.
+
+- version: 2.0.10
+  date: 2004-05-26
+  changes:
+    - Table and list problems.  Rewrote the <pre> handling code.. again.
+
+- version: 2.0.9
+  date: 2004-05-26
+  changes:
+    - Improved RDoc.  Ri documentation is auto-installed now!
+    - Links were consuming closing HTML tags.  (See latest test in tests/links.yml.)
+    - Further speed patch from Denis.  Good good.
+    - Patch by F. Ros to fix <pre> tags with class settings.
+
+- version: 2.0.8
+  date: 2004-05-22
+  changes:
+    - First scan of the glyphs() method only scans for pre|notextile|code, the
+      deeper passes scan for all HTML.  Now inlines work around HTML tags!
+      (What a pain!)
+    - Moved tables and blocks into glyphs to keep them shielded from the parser
+      if they are in <pre> tags.
+    - Patch by Denis Mertz to speed up RedCloth by compiling the various RegExps
+      only once.  Thanks, David!
+
+- version: 2.0.7
+  date: 2004-04-21
+  changes:
+    - New REFERENCE and QUICK-REFERENCE.  See http://hobix.com/textile/.
+    - Lists rewritten to accomplish better line folding.
+    - Better, greedier links.
+    - Additional link and list tests.
+
+- version: 2.0.6
+  date: 2004-04-16
+  changes:
+    - Bold and strong tags were mixed up.  '*' is now strong.  '**' is bold.
+      They were swapped until now.
+    - Horizontal alignments were pretty buggy.  Combining alignments with
+      indents was totally broken.
+    - Fixed table problem.  Now glyphs are handled between tables and blocks.
+    - Nested <pre> and <code> tags are now escaped.  Much better handling of
+      HTML inside <pre> tags.  Really: quite nice.
+    - Patch from Florian Gross to fix an html filtration inconsistency.
+
+- version: 2.0.5
+  date: 2004-04-14
+  changes: 
+    - Added safe mode (patch courtesy of Florian Gross).
+    - Added line folding (suggested by Jim Menard).
+    - Fixing notextile tags to work multi-line.
+    - Ambiguity with em-dash and block opener.
+    - Footnote bug. (Thanks, Jim Menard!)
+
+- version: 2.0.4
+  date: 2004-04-08
+  changes:
+    - Scaled back aggresiveness of the inline matching to aid the em-dash.
+    - Scaled back footnotes to stay out of array indices.
+
+- version: 2.0.3
+  date: 2004-04-02
+  changes:
+    - Handling of pre, code, notextile was all wrong.  Also, got rid of the goofed up
+      split then collect.  Now using gsub! and recursion to handle inlines and glyphs.
+    - Better acronym support.
+    - Suppression of Regexp warnings.
+    - Single- and double-quoted string wierdness.  Thanks, Bret Pettichord.
+
+- version: 2.0.2
+  date: 2004-03-08
+  changes:
+    - Fixed broken lists, broken tables.
+    - code/pre tags now escape properly, glyphs are working, spans are working when surrounded by html tags.
+    - Fixed classes and ids. 
+    - Restricted notextile tags to a single line.
+
+- version: 2.0.1
+  date: 2004-02-10
+  changes:
+    - Unmatched closing slash on regexps in ruby 1.6.8.
+    - Fixes to bulleted lists.
+
+- version: 2.0
+  date: 2004-02-06
+  changes:
+    - Complete rewrite of RedCloth, against beta2 from textism.com.
+
+- version: 0.41
+  date: 2003-06-20
+  changes:
+    - Newlines were outputing as escaped.
+
+- version: 0.4
+  date: 2003-06-20
+  changes:
+    - Initial public release.
+    - Integration of YAML-based PyTextile tests.

data/doc/COPYING

@@ -0,0 +1,25 @@
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, 
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name Textile nor the names of its contributors may be used to
+  endorse or promote products derived from this software without specific
+  prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/doc/README

@@ -0,0 +1,106 @@
+p=. !redcloth3-title.png!
+
+<div id="sidebar">
+
+h4. Get RedCloth 3
+
+p(example1). *Stable version:* "3.0.3":http://rubyforge.org/frs/download.php/2896/RedCloth-3.0.3.tar.gz
+
+Take a complete tour of Textile at "A Textile Reference":http://hobix.com/textile/.
+
+For fast syntax checking, try the "Quick Reference":http://hobix.com/textile/quick.html.
+
+p(example1). Upgrade with "RubyGems":http://rubygems.rubyforge.org/!  Try: 
+@gem install RedCloth@.
+
+See the "project page":http://rubyforge.org/projects/redcloth/ for bug reporting, old releases and CVS instructions.  "Documentation":http://redcloth.rubyforge.org/rdoc/ is also hosted at RubyForge.
+
+h4. RedCloth Links
+
+"Instiki":http://www.instiki.org is the greatest Wiki ever!  Uses RedCloth for its markup!
+
+"Hobix":http://hobix.com is a lovely little blogging package which uses RedCloth for blog entries.
+
+<div id="css-buttons">
+
+* "(css-button w3c)%W3C% xhtml 1.0(Valid XHTML 1.0!)":http://validator.w3.org/check?uri=referer
+* "(css-button w3c w3c2)%W3C% valid css(Valid CSS!)":http://jigsaw.w3.org/css-validator/check/referer
+
+</div>
+
+</div>
+
+RedCloth is a module for using Textile in Ruby.  Textile is a text format.  A very simple text format.  Another stab at making readable text that can be converted to HTML.
+
+h2. What is Textile?
+
+Textile is a simple markup language.
+
+table{width:400px}.
+|_. textile|_. to|_. html|
+| <notextile>_a phrase_</notextile> |->|_a phrase_|
+| <notextile>*a phrase*</notextile> |->|*a phrase*|
+| <notextile>_*a phrase*_</notextile> |->|_*a phrase*_|
+| <notextile>"Google":http://google.com</notextile> |->|"Google":http://google.com|
+
+No need to use verbose HTML to build your docs, your blogs, your pages.  Textile gives you readable text while you're writing and beautiful text for your readers.  And if you need to break out into HTML, Textile will allow you to do so.
+
+Textile also handles some subtleties of formatting which will enhance your document's readability:
+
+* Single- and double-quotes around words or phrases are converted to curly quotations, much easier on
+  the eye.  "Observe!"
+
+* Double hyphens are replaced with an em-dash.  Observe -- very nice!
+
+* Single hyphens are replaced with en-dashes. Observe - so cute!
+
+* Triplets of periods become an ellipsis.  Observe...
+
+* The letter 'x' becomes a dimension sign when used alone.  Observe: 2 x 2.
+
+* Conversion of <notextile>(TM)</notextile> to (TM), <notextile>(R)</notextile> to (R), <notextile>(C)</notextile> to (C).
+
+For more on Textile's language, hop over to "A Textile Reference":http://hobix.com/textile/.
+
+h2. Using RedCloth
+
+The RedCloth class is an extension of Ruby's String class. Use it like you would a String:
+
+<pre>
+  >> r = RedCloth.new "*strong text* and _emphasized text_"
+  => "*strong text* and _emphasized text_"
+  >> r.gsub!( 'text', 'words' )
+  => "*strong words* and _emphasized words_"
+</pre>
+
+To generate HTML from your RedCloth object, use the @RedCloth#to_html@ method:
+
+<pre>
+  >> r.to_html
+  => "<p><strong>strong words</strong> and <em>emphasized words</em></p>"
+</pre>
+
+
+h2. Installing RedCloth
+
+To install RedCloth via RubyGems:
+
+<pre>
+  gem install RedCloth
+</pre>
+
+Or "download RedCloth":http://rubyforge.org/frs/download.php/2896/RedCloth-3.0.3.tar.gz and simply run the install.rb like so:
+
+<pre>
+  ruby install.rb config
+  ruby install.rb setup
+  sudo ruby install.rb install
+</pre>
+
+
+h2. Acknowledgements
+
+Textile is (c) 2003 Dean Allen.  All rights reserved. You can read more "here":http://www.textism.com/tools/textile/.
+
+RedCloth is also based on PyTextile, which is: Copyright (c) 2003, "Mark Pilgrim":http://diveintomark.org/.  All rights reserved.  You can read more about PyTextile "here":http://dealmeida.net/projects/textile.
+

data/doc/REFERENCE

@@ -0,0 +1,216 @@
+---
+- A Textile Reference:
+  - Textile is a simple text markup.  Simple symbols mark words' emphasis.  Blocks of text
+    can be easily tagged as headers, quotes, or lists.  A Textile document can then be
+    converted to HTML(Hypertext Markup Language) for viewing on the web.
+  - You can try Textile out on the "Textile home page":http://www.textism.com/tools/textile/.
+    Textile is also available as "RedCloth":http://whytheluckystiff.net/ruby/redcloth/ for
+    Ruby or "PyTextile":http://dealmeida.net/projects/textile for Python.
+  - Also refer to the "*Quick Reference*":javascript:quickRedReference(); for this guide.
+  - h4. Reading the Examples
+  - In each section below, examples are provided to clearly illustrate.  In each example,
+    the Textile example is followed by the raw HTML it is translated into, followed by how
+    the HTML appears in the browser.
+  - 
+    - Textile example
+    - Converted to HTML
+    - Browser-view
+- Writing in Textile:
+  - Textile looks for paragraphs in your text.  Paragraphs are separated by one blank line.
+    Every paragraph is translated as an HTML paragraph.
+  - !!example "A single paragraph.\n\nFollowed by another."
+  - h4. Using HTML in Textile
+  - You can certainly use HTML tags inside your Textile documents.  HTML will only be escaped
+    if it's found in a @pre@ or @code@ block.
+  - !!example "I am <b>very</b> serious.\n\n<pre>\n  I am <b>very</b> serious.\n</pre>"
+  - h4. Line Breaks
+  - Line breaks are ignored.
+  - !!example "I spoke.\nAnd none replied."
+  - Line breaks can be converted to HTML breaks by setting @hard_breaks@.
+  - h4. Entities
+  - Single- and double-quotes around words or phrases are converted to curly quotations, much easier on the eye.
+  - !!example '"Observe!"'
+  - Double hyphens are replaced with an em-dash.
+  - !!example Observe -- very nice!
+  - Single hyphens are replaced with en-dashes.
+  - !!example Observe - tiny and brief.
+  - Triplets of periods become an ellipsis.
+  - !!example Observe...
+  - The letter 'x' becomes a dimension sign when used alone.
+  - !!example 'Observe: 2 x 2.'
+  - Conversion of trademark and copyright symbols.
+  - !!example 'one(TM), two(R), three(C).'
+- Quick Block Modifiers:
+  - Blocks of text default to being treated as paragraphs.  But modifers can be affixed
+    to the beginning of a block to change its treatment.
+  - h4. Headers
+  - To make an entire paragraph into a Header, place "h<em>n</em>." at 
+    its beginning, where _n_ is a number from 1-6.
+  - !!example h1. Header 1
+  - !!example h2. Header 2
+  - !!example h3. Header 3
+  - h4. Block Quotes
+  - To make an entire paragraph into a block quotation, place
+    "bq." before it.
+  - !!example "An old text\n\nbq. A block quotation.\n\nAny old text"
+  - h4. Footnotes
+  - Numeric references within text to footnotes appear between square brackets.
+  - !!example This is covered elsewhere[1].
+  - To create the footnote that corresponds to its reference within the text, begin a new paragraph with fn and the 
+    footnote's number, followed by a dot and a space.
+  - !!example fn1. Down here, in fact.
+- Quick Phrase Modifiers:
+  - h4. Structural Emphasis
+  - Emphasis to text is added by surrounding a phrase with underscores.  In HTML, this often
+    appears as <em>italics</em>.
+  - !!example I _believe_ every word.
+  - Strength can be give to text by surrounding with asterisks.  In HTML, this strength appears
+    as <strong>bold</strong>.
+  - !!example And then? She *fell*!
+  - Both italics and bold can be forced by doubling the underscores or asterisks.
+  - !!example "I __know__.\nI **really** __know__."
+  - Use double question marks to indicate _citation_.  The title of a book, for instance.
+  - !!example "??Cat's Cradle?? by Vonnegut"
+  - Code phrases can be surrounded by at-symbols.
+  - !!example "Convert with @r.to_html@"
+  - To indicate a passage which has been deleted, surround the passage with hypens.
+  - !!example "I'm -sure- not sure."
+  - Pluses around a passage indicate its insertion.
+  - !!example "You are a +pleasant+ child."
+  - To superscript a phrase, surround with carets.
+  - !!example "a^2^ + b^2^ = c^2^"
+  - To subscript, surround with tildes.
+  - !!example "log~2~x"
+  - h4. HTML-Specific
+  - Lastly, if you find yourself needing to customize the style of a passage, use percent symbols
+    to translate the passage as an HTML span.
+  - !!example I'm %unaware% of most soft drinks.
+  - This way, you can apply style settings, as described in the next section to arbitrary phrases.
+  - !!example "I'm %{color:red}unaware%\nof most soft drinks."
+- Attributes:
+  - Tailoring Textile to suit your needs is quite easy.  Attributes allow you to provide CSS(Cascading
+    Style Sheets) information about any phrase.
+  - h4. Block Attributes
+  - A block can be tagged with a CSS class by circling the class in parentheses and
+    placing it just before the period which marks the block.
+  - !!example p(example1). An example
+  - An element ID can be given by prefixing the ID with a pound symbol and using it in place of
+    the class.
+  - !!example p(#big-red). Red here
+  - Class and ID can be combined by placing the class first.
+  - !!example p(example1#big-red2). Red here
+  - Style settings can be provided directly by surrounding them in curly braces.
+  - !!example p{color:blue;margin:30px}. Spacey blue
+  - Language designations can be given between angel brackets.
+  - !!example p[fr]. rouge
+  - h4. Phrase Attributes
+  - All block attributes can be applied to phrases as well by placing them just inside the
+    opening modifier.
+  - !!example "I seriously *{color:red}blushed*\nwhen I _(big)sprouted_ that\ncorn stalk from my\n%[es]cabeza%."
+  - h4. Block Alignments
+  - Text inside blocks can be aligned in four basic ways.
+  - !!example p<. align left
+  - !!example p>. align right
+  - !!example p=. centered
+  - !!example p<>. justified
+  - Indentation can also be specified by provide a single left paren for every 1em to the left.  A single right
+    paren for every 1em to the right.
+  - !!example p(. left ident 1em
+  - !!example p((. left ident 2em
+  - !!example p))). right ident 3em
+  - h4. Combining Alignments
+  - Identation may be coupled with alignment.
+  - !!example "h2()>. Bingo."
+  - And, furthermore, coupled with language settings and CSS styles.
+  - !!example "h3()>[no]{color:red}. Bingo"
+  - h4. HTML in Textile
+  - Textile is designed for quickening the simple markups.  For more complex formatting, you are encouraged
+    to break out into HTML.
+  - For example, long code blocks belong between @pre@ and @code@ tags.  Please also indent your code inside
+    the tags to be sure that all Textile processors out there will ignore the contents.
+  - !!example |
+      <pre>
+      <code>
+        a.gsub!( /</, '' )
+      </code>
+      </pre>
+  - You may also choose to surround sections with @div@ tags to separate your document into sections.
+    "Instiki":http://www.instiki.org/ uses this technique to float a sidebar to the right.
+  - !!example |
+      <div style="float:right;">
+      
+      h3. Sidebar
+
+      "Hobix":http://hobix.com/
+      "Ruby":http://ruby-lang.org/
+
+      </div>
+      
+      The main text of the
+      page goes here and will 
+      stay to the left of the 
+      sidebar.
+
+- Lists:
+  - h4. Numeric Lists
+  - To make a numbered list, place each item in its own paragraph, preceded by "#".
+  - !!example "# A first item\n# A second item\n# A third"
+  - These lists may be nested by increasing the number of pound symbols preceding child entries.
+  - !!example "# Fuel could be:\n## Coal\n## Gasoline\n## Electricity\n# Humans need only:\n## Water\n## Protein"
+  - h4. Bulleted Lists
+  - Bulleted lists use an asterisk in place of the pound.
+  - !!example "* A first item\n* A second item\n* A third"
+  - These lists may be nested in like manner.
+  - !!example "* Fuel could be:\n** Coal\n** Gasoline\n** Electricity\n* Humans need only:\n** Water\n** Protein"
+- External References:
+  - h4. Hypertext Links
+  - Basic links are comprised of a phrase which is linked to a URL(Universal Resource Locator).  Place the
+    descriptive phrase in quotation marks.  Follow it immediately by a colon and the URL.
+  - !!example I searched "Google":http://google.com.
+  - Notice, the link won't include any trailing punctuation.
+  - h4. Link Aliases
+  - If you are using the same link several times in your document, or you'd just like to be a tad more
+    organized, you can use a link alias.  Place the URL anywhere in your document, beginning with its
+    alias in square brackets.  Then, use the alias in place of the URL, using the link format above.
+  - !!example |
+      I am crazy about "Hobix":hobix
+      and "it's":hobix "all":hobix I ever
+      "link to":hobix!
+
+      [hobix]http://hobix.com
+  - h4. Embedded Images
+  - You can embed an image in your Textile document by surrounding its URL with exclamation marks.
+  - !!example "!http://hobix.com/sample.jpg!" 
+  - URLs may be relative.
+  - A title for the image can also be provided in parens, just before the closing exclamation.
+  - !!example "!openwindow1.gif(Bunny.)!"
+  - The title also acts as *alt* text should the image not be found.
+  - Links can be attached to images with a colon.
+  - !!example "!openwindow1.gif!:http://hobix.com/"
+  - h4. Image Alignments
+  - Alignments can be applied as well to images.
+  - !!example "!>obake.gif!\n\nAnd others sat all round the small\nmachine and paid it to sing to them."
+  - h4. Acronyms
+  - Definitions for acronyms can be provided by following an acronym with its definition in parens.
+  - !!example We use CSS(Cascading Style Sheets).
+- Tables:
+  - Simple tables can be built by separating fields with pipe characters
+  - !!example "| name | age | sex |\n| joan | 24 | f |\n| archie | 29 | m |\n| bella | 45 | f |"
+  - Specify header cells by marking them with an underscore and period.
+  - !!example "|_. name |_. age |_. sex |\n| joan | 24 | f |\n| archie | 29 | m |\n| bella | 45 | f |"
+  - h4. Cell Attributes
+  - The period used above marks the end of a cell's attributes.  Other attributes can be applied as well.
+  - !!example "|_. attribute list |\n|<. align left |\n|>. align right|\n|=. center |\n|<>. justify |\n|^. valign top |\n|~. bottom |"
+  - You can also specify colspans with a backslash, followed by the cell width.
+  - !!example "|\\2. spans two cols |\n| col 1 | col 2 |"
+  - Rowspan is specified by a forward slash, followed by the row height.
+  - !!example "|/3. spans 3 rows | a |\n| b |\n| c |"
+  - All block attributes can be applied to table cells as well.
+  - !!example "|{background:#ddd}. Grey cell|"
+  - h4. Table and Row Attributes
+  - Table-wide attributes can be applied before the first row of the table.  On its own line, followed by
+    a period.
+  - !!example "table{border:1px solid black}.\n|This|is|a|row|\n|This|is|a|row|"
+  - Attributes can be applied to a single row by supplying the attribute before the row starts, using a
+    @table@ modifier and following it by a period.
+  - !!example "|This|is|a|row|\n{background:#ddd}. |This|is|grey|row|"