RedCloth 3.0.4 → 4.0.0

data/doc/REFERENCE

@@ -1,216 +0,0 @@
----
-- 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|"

data/doc/make.rb

@@ -1,359 +0,0 @@
-$:.unshift '../lib'
-require 'yaml'
-require 'redcloth'
-
-class String
-    #
-    # Flexible HTML escaping
-    #
-    def htmlesc!( mode )
-        gsub!( '&', '&' )
-        gsub!( '"', '"' ) if mode != :NoQuotes
-        gsub!( "'", ''' ) if mode == :Quotes
-        gsub!('<', '&lt;')
-        gsub!('>', '&gt;')
-    end
-end
-
-def a_name( phrase )
-    phrase.downcase.
-           gsub( /\W+/, '-' )
-end
-
-file_name = ARGV.shift
-case file_name
-when 'README'
-    puts <<-HTML
-    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-            "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-    <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
-    <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>RedCloth [Textile Humane Web Text for Ruby]</title>
-    <style type="text/css">
-    BODY {
-        margin: 10px 60px 40px 60px;
-        font-family: georgia, serif;
-        font-size: 12pt;
-    }
-    TABLE {
-        padding: 15px;
-        width: 250px;
-    }
-    TH {
-        text-align: left;
-    }
-    TD {
-        border-top: solid 1px #eee;
-    }
-    H4 {
-        border: solid 1px #caa;
-        margin: 10px 15px 5px 10px;
-        padding: 5px;
-        color: white;
-        background-color: #333;
-        font-weight: bold;
-        font-size: 12pt;
-    }
-    P {
-        margin: 10px 15px 5px 15px;
-    }
-    P.example1 {
-        background-color: #FEE;
-        font-weight: bold;
-        font-size: 9pt;
-        padding: 5px;
-    }
-    P.example2 {
-        border: solid 1px #DDD;
-        background-color: #EEE;
-        font-size: 9pt;
-        padding: 5px;
-    }
-    .big {
-        font-size: 15pt;
-    }
-    #big-red {
-        font-size: 15pt;
-        color: red;
-    }
-    #big-red2 {
-        font-size: 15pt;
-        color: red;
-    }
-    #sidebar {
-        float: right;
-        font-family: verdana, arial, sans-serif;
-        font-size: 10pt;
-        border-left: solid 1px #999;
-        margin-left: 10px;
-        width: 200px;
-    }
-    /* VARIATION BUTTON STYLING (v2.0) - SIZABLE SIZE */
-    #css-buttons ul{list-style: none;margin: 0 0 10px 0;padding: 0;}
-    #css-buttons li{border: 1px solid #999; margin: 5px 0 0 20px; width:9.0em;}
-    head:first-child+body #css-buttons li{padding-right:2px;}
-    #css-buttons li a{color: #333; text-decoration: none;}
-
-    .css-button {
-        display:block;
-        font: 0.8em verdana, arial, sans-serif;
-        padding: 2px 0 2px 0px; border: 1px solid white;
-        text-decoration: none; width:100%;
-        background: #ddd;color: #333;
-    }
-
-    .css-button span {
-        font: bold 1.0em verdana, arial, sans-serif;
-        padding: 2px 3px 2px 3px; color: #fff;
-    }  
-
-    /* BUTTON LOGO STYLING */
-    .rss span{background:#f60;}
-    .w3c span {background: #fff; color: #069; font: bold 1.1em helvetica, arial, Sans-Serif;}
-    .w3c2{background: #fc6;color: black !important;}
-    </style>
-    </head>
-    <body>
-    HTML
-    puts RedCloth.new( File.open( file_name ).read ).to_html
-    puts "</body>"
-    puts "</html>"
-when 'QUICK-REFERENCE'
-    YAML::add_private_type( "example" ) do |type, val|
-        esc = val.dup
-        esc.htmlesc!( :NoQuotes )
-        [ :example, esc.gsub( /\n/, '<br />' ),
-          RedCloth.new( val ).to_html ]
-    end
-
-    content = YAML::load( File.open( 'REFERENCE' ) )
-
-    sections = content.collect { |c| c.keys.first }
-    sections.shift
-
-    puts <<-HTML
-    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-            "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-    <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
-    <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Textile Quick Reference</title>
-    <style type="text/css">
-    BODY {
-        margin: 5px;
-    }
-    TABLE {
-        font-family: georgia, serif;
-        font-size: 10pt;
-        padding: 5px;
-        width: 200px;
-    }
-    TH {
-        padding-top: 10px;
-    }
-    TD {
-        border-top: solid 1px #eee;
-    }
-    H1 {
-        font-size: 18pt;
-    }
-    H4 {
-        color: #999;
-        background-color: #fee;
-        border: solid 1px #caa;
-        margin: 10px 15px 5px 10px;
-        padding: 5px;
-    }
-    P {
-        margin: 2px 5px 2px 5px;
-    }
-    TD.example1 PRE {
-        background-color: #FEE;
-        font-family: georgia, serif;
-        font-size: 8pt;
-        padding: 5px;
-        padding: 5px;
-    }
-    TD.example3 {
-        border: solid 1px #DDD;
-        background-color: #EEE;
-        font-size: 8pt;
-        padding: 5px;
-    }
-    .big {
-        font-size: 12pt;
-    }
-    #big-red {
-        font-size: 12pt;
-        color: red;
-    }
-    #big-red2 {
-        font-size: 15pt;
-        color: red;
-    }
-    </style>
-    </head>
-    <body>
-    <table>
-    <tr><th colspan='3'><h1>Textile Quick Reference</h1></th></tr>
-    <tr><th colspan='3'>Sections: #{ sections.collect { |s| "<a href='##{ a_name( s ) }'>#{ s.gsub( /\s/, '&nbsp;' ) }</a>" }.join( ' | ' ) }</th></tr>
-    HTML
-
-    ct = 0
-    content.each do |section|
-        section.each do |header, parags|
-            puts "<tr><th colspan='5'><a name='#{ a_name( header ) }'>#{ header }</a></th></tr>" if ct.nonzero?
-            parags.each do |p|
-                if p.is_a?( Array ) and p[0] == :example
-                    puts "<tr><td class='example1'><pre>#{ p[1] }</pre></td><td>&rarr;</td>" +
-                             "<td class='example2'>#{ p[2] }</td></tr>"
-                end
-            end
-        end
-        ct += 1
-    end
-    puts "</table>"
-    puts "</body>"
-    puts "</html>"
-
-when 'REFERENCE'
-    YAML::add_private_type( "example" ) do |type, val|
-        esc = val.dup
-        esc.htmlesc!( :NoQuotes )
-        [ esc.gsub( /\n/, '<br />' ),
-          RedCloth.new( val ).to_html.
-                   gsub( /;(\w)/, '; \1' ).
-                   htmlesc!( :NoQuotes ).
-                   gsub( /\n/, '<br />' ),
-          RedCloth.new( val ).to_html ]
-    end
-
-    content = YAML::load( File.open( file_name ) )
-
-    sections = content.collect { |c| c.keys.first }
-    sections.shift
-
-    puts <<-HTML
-    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-            "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-    <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
-    <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Textile Reference</title>
-    <style type="text/css">
-    BODY {
-        margin: 10px 30px;
-    }
-    TABLE {
-        font-family: georgia, serif;
-        font-size: 11pt;
-        padding: 15px;
-    }
-    TH {
-        border-bottom: solid 1px black;
-        font-size: 24pt;
-        font-weight: bold;
-        padding-top: 30px;
-    }
-    H1 {
-        font-size: 42pt;
-    }
-    H4 {
-        color: #666;
-        background-color: #fee;
-        border: solid 1px #caa;
-        margin: 10px 0px 5px 0px;
-        padding: 5px;
-    }
-    P {
-        margin: 10px 15px 5px 15px;
-    }
-    TD.sections {
-        background: black;
-        color: white;
-        font-family: georgia, serif;
-        font-weight: bold;
-        font-size: 9pt;
-        padding: 5px;
-    }
-    TD.sections A         { color: #CCEEFF; }
-    TD.sections A:link    { color: #CCEEFF; }
-    TD.sections A:visited { color: #CCEEFF; }
-    TD.sections A:active  { color: #EEEEEE; }
-    TD.sections A:hover   { color: #EEEEEE; }
-
-    TD.example1 PRE {
-        background-color: #B30;
-        color: white;
-        font-family: georgia, serif;
-        font-weight: bold;
-        font-size: 9pt;
-        padding: 5px;
-    }
-    TD.example2 P {
-        border: solid 1px #DDD;
-        background-color: #EEE;
-        font-family: georgia, serif;
-        font-size: 9pt;
-        padding: 5px;
-    }
-    TD.example3 {
-        border: solid 1px #EED;
-        background-color: #FFE;
-        padding: 5px;
-    }
-    .big {
-        font-size: 15pt;
-    }
-    #big-red {
-        font-size: 15pt;
-        color: red
-    }
-    </style>
-    <script type="text/javascript">
-        function quickRedReference() {
-            window.open( 
-                "quick.html",
-                "redRef",
-                "height=600,width=550,channelmode=0,dependent=0," +
-                "directories=0,fullscreen=0,location=0,menubar=0," +
-                "resizable=0,scrollbars=1,status=1,toolbar=0"
-            );
-        }
-    </script>
-    </head>
-    <body>
-    <table>
-    HTML
-
-    ct = 0
-    content.each do |section|
-        section.each do |header, parags|
-            if ct.zero?
-                puts "<tr><th colspan='3'><h1>#{ header }</h1></th></tr>"
-                puts "<tr><td class='sections' colspan='3'>Sections: #{ sections.collect { |s| "<a href='##{ a_name( s ) }'>#{ s.gsub( /\s/, '&nbsp;' ) }</a>" }.join( ' | ' ) }</td></tr>"
-            else
-                puts "<tr><th colspan='3'><a name='#{ a_name( header ) }'><small>#{ ct }.</small></a><br />#{ header }</th></tr>"
-            end
-            parags.each do |p|
-                if p.is_a? Array
-                    puts "<tr><td class='example1' valign='top'><pre>#{ p[0] }</pre></td><td>&rarr;</td>" +
-                             "<td class='example2'><p>#{ p[1] }</p></td></tr><tr><td colspan='2'></td>" +
-                             "<td class='example3'>#{ p[2] }</td></tr>"
-                else
-                    puts "<tr><td class='explain' colspan='3'>"
-                    puts RedCloth.new( p ).to_html
-                    puts "</td></tr>"
-                end
-            end
-            unless ct.zero?
-                puts "<tr><td colspan='5' style='border-bottom: solid 1px #eee;'></td></tr>"
-            end
-        end
-        ct += 1
-    end
-    puts "</table>"
-    puts "</body>"
-    puts "</html>"
-end