rdiscount-dsc 1.6.9

data/man/rdiscount.1

@@ -0,0 +1,119 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "RDISCOUNT" "1" "July 2011" "" "RUBY"
+.
+.SH "NAME"
+\fBrdiscount\fR \- humane markup to HTML conversion tool
+.
+.SH "SYNOPSIS"
+[\fBenv\fR RDISCOUNT_EXTENSIONS=\'\fIextension\fR,\.\.\.\'] \fBrdiscount\fR [\fIfile\fR\.\.\.]
+.
+.SH "DESCRIPTION"
+The \fBrdiscount\fR utility reads one or more markdown(7)\-formatted text \fIfile\fRs and writes HTML to standard output\. With no \fIfile\fR, or when \fIfile\fR is \'\-\', \fBrdiscount\fR reads source text from standard input\.
+.
+.P
+The \fBRDISCOUNT_EXTENSIONS\fR environment variable can specify a comma\-separated list of Markdown processing \fIextension\fRs to enable (see \fBEXTENSIONS\fR below)\.
+.
+.SH "EXTENSIONS"
+.
+.TP
+\fBfilter_styles\fR
+Do not output \fB<style>\fR tags\.
+.
+.TP
+\fBfold_lines\fR
+RedCloth compatible line folding (not used)\.
+.
+.TP
+\fBMKD_NOLINKS\fR
+Don\'t do link processing, block \fB<a>\fR tags
+.
+.TP
+\fBMKD_NOIMAGE\fR
+Don\'t do image processing, block \fB<img>\fR
+.
+.TP
+\fBMKD_NOPANTS\fR
+Don\'t run smartypants()
+.
+.TP
+\fBMKD_NOHTML\fR
+Don\'t allow raw html through AT ALL
+.
+.TP
+\fBMKD_STRICT\fR
+Disable SUPERSCRIPT, RELAXED_EMPHASIS
+.
+.TP
+\fBMKD_TAGTEXT\fR
+Process text inside an html tag; no \fB<em>\fR, no \fB<bold>\fR, no html or [] expansion
+.
+.TP
+\fBMKD_NO_EXT\fR
+Don\'t allow pseudo\-protocols
+.
+.TP
+\fBMKD_CDATA\fR
+Generate code for xml ![CDATA[\.\.\.]]
+.
+.TP
+\fBMKD_NOSUPERSCRIPT\fR
+No A
+.
+.TP
+\fBMKD_NORELAXED\fR
+Emphasis happens everywhere
+.
+.TP
+\fBMKD_NOTABLES\fR
+Don\'t process PHP Markdown Extra tables\.
+.
+.TP
+\fBMKD_NOSTRIKETHROUGH\fR
+Forbid
+.
+.TP
+\fBMKD_TOC\fR
+Do table\-of\-contents processing
+.
+.TP
+\fBMKD_1_COMPAT\fR
+Compatability with MarkdownTest_1\.0
+.
+.TP
+\fBMKD_AUTOLINK\fR
+Make http://foo\.com a link even without \fB<>\fRs
+.
+.TP
+\fBMKD_SAFELINK\fR
+Paranoid check for link protocol
+.
+.TP
+\fBMKD_NOHEADER\fR
+Don\'t process document headers
+.
+.TP
+\fBMKD_TABSTOP\fR
+Expand tabs to 4 spaces
+.
+.TP
+\fBMKD_NODIVQUOTE\fR
+Forbid >%class% blocks
+.
+.TP
+\fBMKD_NOALPHALIST\fR
+Forbid alphabetic lists
+.
+.TP
+\fBMKD_NODLIST\fR
+Forbid definition lists
+.
+.SH "RETURN VALUES"
+The \fBrdiscount\fR utility exits 0 on success, and > 0 if an error occurs\.
+.
+.SH "SEE ALSO"
+markdown(7), env(1)
+.
+.SH "AUTHOR"
+Ryan Tomayko \fIhttp://tomayko\.com/about\fR

data/man/rdiscount.1.ronn

@@ -0,0 +1,98 @@
+rdiscount(1) -- humane markup to HTML conversion tool
+=====================================================
+
+## SYNOPSIS
+
+[`env` RDISCOUNT_EXTENSIONS='<extension>,...'] `rdiscount` [<file>...]
+
+## DESCRIPTION
+
+The `rdiscount` utility reads one or more markdown(7)-formatted text <file>s and
+writes HTML to standard output. With no <file>, or when <file> is '-',
+`rdiscount` reads source text from standard input.
+
+The `RDISCOUNT_EXTENSIONS` environment variable can specify a comma-separated
+list of Markdown processing <extension>s to enable (see **EXTENSIONS** below).
+
+## EXTENSIONS
+
+* `filter_styles`:
+   Do not output `<style>` tags.
+
+* `fold_lines`:
+   RedCloth compatible line folding (not used).
+
+* `MKD_NOLINKS`:
+   Don't do link processing, block `<a>` tags
+
+* `MKD_NOIMAGE`:
+   Don't do image processing, block `<img>`
+
+* `MKD_NOPANTS`:
+   Don't run smartypants()
+
+* `MKD_NOHTML`:
+   Don't allow raw html through AT ALL
+
+* `MKD_STRICT`:
+   Disable SUPERSCRIPT, RELAXED_EMPHASIS
+
+* `MKD_TAGTEXT`:
+   Process text inside an html tag; no `<em>`, no `<bold>`, no html or [] expansion
+
+* `MKD_NO_EXT`:
+   Don't allow pseudo-protocols
+
+* `MKD_CDATA`:
+   Generate code for xml ![CDATA[...]]
+
+* `MKD_NOSUPERSCRIPT`:
+   No A^B
+
+* `MKD_NORELAXED`:
+   Emphasis happens everywhere
+
+* `MKD_NOTABLES`:
+   Don't process PHP Markdown Extra tables.
+
+* `MKD_NOSTRIKETHROUGH`:
+   Forbid ~~strikethrough~~
+
+* `MKD_TOC`:
+   Do table-of-contents processing
+
+* `MKD_1_COMPAT`:
+   Compatability with MarkdownTest_1.0
+
+* `MKD_AUTOLINK`:
+   Make http://foo.com a link even without `<>`s
+
+* `MKD_SAFELINK`:
+   Paranoid check for link protocol
+
+* `MKD_NOHEADER`:
+   Don't process document headers
+
+* `MKD_TABSTOP`:
+   Expand tabs to 4 spaces
+
+* `MKD_NODIVQUOTE`:
+   Forbid >%class% blocks
+
+* `MKD_NOALPHALIST`:
+   Forbid alphabetic lists
+
+* `MKD_NODLIST`:
+   Forbid definition lists
+
+## RETURN VALUES
+
+The `rdiscount` utility exits 0 on success, and > 0 if an error occurs.
+
+## SEE ALSO
+
+markdown(7), env(1)
+
+## AUTHOR
+
+Ryan Tomayko <http://tomayko.com/about>

data/rdiscount-dsc.gemspec

@@ -0,0 +1,57 @@
+Gem::Specification.new do |s|
+  s.name = 'rdiscount-dsc'
+  s.version = '1.6.9'
+  s.summary = "Fast Implementation of Gruber's Markdown in C"
+  s.date = '2011-01-25'
+  s.email = 'rtomayko@gmail.com'
+  s.homepage = 'http://github.com/rtomayko/rdiscount'
+  s.authors = ["Ryan Tomayko", "David Loren Parsons", "Andrew White"]
+  # = MANIFEST =
+  s.files = %w[
+    BUILDING
+    COPYING
+    README.markdown
+    Rakefile
+    bin/rdiscount
+    discount
+    ext/Csio.c
+    ext/amalloc.h
+    ext/basename.c
+    ext/config.h
+    ext/css.c
+    ext/cstring.h
+    ext/docheader.c
+    ext/dumptree.c
+    ext/emmatch.c
+    ext/extconf.rb
+    ext/generate.c
+    ext/html5.c
+    ext/markdown.c
+    ext/markdown.h
+    ext/mkdio.c
+    ext/mkdio.h
+    ext/rdiscount.c
+    ext/resource.c
+    ext/tags.c
+    ext/tags.h
+    ext/toc.c
+    ext/xml.c
+    lib/markdown.rb
+    lib/rdiscount.rb
+    man/markdown.7
+    man/rdiscount.1
+    man/rdiscount.1.ronn
+    rdiscount-dsc.gemspec
+    test/benchmark.rb
+    test/benchmark.txt
+    test/markdown_test.rb
+    test/rdiscount_test.rb
+  ]
+  # = MANIFEST =
+  s.test_files = ["test/markdown_test.rb", "test/rdiscount_test.rb"]
+  s.extra_rdoc_files = ["COPYING"]
+  s.extensions = ["ext/extconf.rb"]
+  s.executables = ["rdiscount"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = 'wink'
+end

data/test/benchmark.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+
+iterations = 100
+test_file = "#{File.dirname(__FILE__)}/benchmark.txt"
+implementations = %w[BlueCloth RDiscount Maruku PEGMarkdown]
+
+# Attempt to require each implementation and remove any that are not
+# installed.
+implementations.reject! do |class_name|
+  begin
+    module_path =
+      if class_name == 'PEGMarkdown'
+        'peg_markdown'
+      else
+        class_name.downcase
+      end
+    require module_path
+    false
+  rescue LoadError => boom
+    module_path.tr! '_', '-'
+    puts "#{class_name} excluded. Try: gem install #{module_path}"
+    true
+  end
+end
+
+# Grab actual class objects.
+implementations.map! { |class_name| Object.const_get(class_name) }
+
+# The actual benchmark.
+def benchmark(implementation, text, iterations)
+  start = Time.now
+  iterations.times do |i|
+    implementation.new(text).to_html
+  end
+  Time.now - start
+end
+
+# Read test file
+test_data = File.read(test_file)
+
+# Prime the pump
+puts "Spinning up ..."
+implementations.each { |impl| benchmark(impl, test_data, 1) }
+
+# Run benchmarks; gather results.
+puts "Running benchmarks ..."
+results =
+  implementations.inject([]) do |r,impl|
+    GC.start
+    r << [ impl, benchmark(impl, test_data, iterations) ]
+  end
+
+puts "Results for #{iterations} iterations:"
+results.each do |impl,time|
+  printf "  %10s %09.06fs total time, %09.06fs average\n", "#{impl}:", time, time / iterations
+end

data/test/benchmark.txt

@@ -0,0 +1,306 @@
+Markdown: Basics
+================
+
+<ul id="ProjectSubmenu">
+    <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>
+    <li><a class="selected" title="Markdown Basics">Basics</a></li>
+    <li><a href="/projects/markdown/syntax" title="Markdown Syntax Documentation">Syntax</a></li>
+    <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>
+    <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>
+</ul>
+
+
+Getting the Gist of Markdown's Formatting Syntax
+------------------------------------------------
+
+This page offers a brief overview of what it's like to use Markdown.
+The [syntax page] [s] provides complete, detailed documentation for
+every feature, but Markdown should be very easy to pick up simply by
+looking at a few examples of it in action. The examples on this page
+are written in a before/after style, showing example syntax and the
+HTML output produced by Markdown.
+
+It's also helpful to simply try Markdown out; the [Dingus] [d] is a
+web application that allows you type your own Markdown-formatted text
+and translate it to XHTML.
+
+**Note:** This document is itself written using Markdown; you
+can [see the source for it by adding '.text' to the URL] [src].
+
+  [s]: /projects/markdown/syntax  "Markdown Syntax"
+  [d]: /projects/markdown/dingus  "Markdown Dingus"
+  [src]: /projects/markdown/basics.text
+
+
+## Paragraphs, Headers, Blockquotes ##
+
+A paragraph is simply one or more consecutive lines of text, separated
+by one or more blank lines. (A blank line is any line that looks like a
+blank line -- a line containing nothing spaces or tabs is considered
+blank.) Normal paragraphs should not be intended with spaces or tabs.
+
+Markdown offers two styles of headers: *Setext* and *atx*.
+Setext-style headers for `<h1>` and `<h2>` are created by
+"underlining" with equal signs (`=`) and hyphens (`-`), respectively.
+To create an atx-style header, you put 1-6 hash marks (`#`) at the
+beginning of the line -- the number of hashes equals the resulting
+HTML header level.
+
+Blockquotes are indicated using email-style '`>`' angle brackets.
+
+Markdown:
+
+    A First Level Header
+    ====================
+    
+    A Second Level Header
+    ---------------------
+
+    Now is the time for all good men to come to
+    the aid of their country. This is just a
+    regular paragraph.
+
+    The quick brown fox jumped over the lazy
+    dog's back.
+    
+    ### Header 3
+
+    > This is a blockquote.
+    > 
+    > This is the second paragraph in the blockquote.
+    >
+    > ## This is an H2 in a blockquote
+
+
+Output:
+
+    <h1>A First Level Header</h1>
+    
+    <h2>A Second Level Header</h2>
+    
+    <p>Now is the time for all good men to come to
+    the aid of their country. This is just a
+    regular paragraph.</p>
+    
+    <p>The quick brown fox jumped over the lazy
+    dog's back.</p>
+    
+    <h3>Header 3</h3>
+    
+    <blockquote>
+        <p>This is a blockquote.</p>
+        
+        <p>This is the second paragraph in the blockquote.</p>
+        
+        <h2>This is an H2 in a blockquote</h2>
+    </blockquote>
+
+
+
+### Phrase Emphasis ###
+
+Markdown uses asterisks and underscores to indicate spans of emphasis.
+
+Markdown:
+
+    Some of these words *are emphasized*.
+    Some of these words _are emphasized also_.
+    
+    Use two asterisks for **strong emphasis**.
+    Or, if you prefer, __use two underscores instead__.
+
+Output:
+
+    <p>Some of these words <em>are emphasized</em>.
+    Some of these words <em>are emphasized also</em>.</p>
+    
+    <p>Use two asterisks for <strong>strong emphasis</strong>.
+    Or, if you prefer, <strong>use two underscores instead</strong>.</p>
+   
+
+
+## Lists ##
+
+Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`,
+`+`, and `-`) as list markers. These three markers are
+interchangable; this:
+
+    *   Candy.
+    *   Gum.
+    *   Booze.
+
+this:
+
+    +   Candy.
+    +   Gum.
+    +   Booze.
+
+and this:
+
+    -   Candy.
+    -   Gum.
+    -   Booze.
+
+all produce the same output:
+
+    <ul>
+    <li>Candy.</li>
+    <li>Gum.</li>
+    <li>Booze.</li>
+    </ul>
+
+Ordered (numbered) lists use regular numbers, followed by periods, as
+list markers:
+
+    1.  Red
+    2.  Green
+    3.  Blue
+
+Output:
+
+    <ol>
+    <li>Red</li>
+    <li>Green</li>
+    <li>Blue</li>
+    </ol>
+
+If you put blank lines between items, you'll get `<p>` tags for the
+list item text. You can create multi-paragraph list items by indenting
+the paragraphs by 4 spaces or 1 tab:
+
+    *   A list item.
+    
+        With multiple paragraphs.
+
+    *   Another item in the list.
+
+Output:
+
+    <ul>
+    <li><p>A list item.</p>
+    <p>With multiple paragraphs.</p></li>
+    <li><p>Another item in the list.</p></li>
+    </ul>
+    
+
+
+### Links ###
+
+Markdown supports two styles for creating links: *inline* and
+*reference*. With both styles, you use square brackets to delimit the
+text you want to turn into a link.
+
+Inline-style links use parentheses immediately after the link text.
+For example:
+
+    This is an [example link](http://example.com/).
+
+Output:
+
+    <p>This is an <a href="http://example.com/">
+    example link</a>.</p>
+
+Optionally, you may include a title attribute in the parentheses:
+
+    This is an [example link](http://example.com/ "With a Title").
+
+Output:
+
+    <p>This is an <a href="http://example.com/" title="With a Title">
+    example link</a>.</p>
+
+Reference-style links allow you to refer to your links by names, which
+you define elsewhere in your document:
+
+    I get 10 times more traffic from [Google][1] than from
+    [Yahoo][2] or [MSN][3].
+
+    [1]: http://google.com/        "Google"
+    [2]: http://search.yahoo.com/  "Yahoo Search"
+    [3]: http://search.msn.com/    "MSN Search"
+
+Output:
+
+    <p>I get 10 times more traffic from <a href="http://google.com/"
+    title="Google">Google</a> than from <a href="http://search.yahoo.com/"
+    title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"
+    title="MSN Search">MSN</a>.</p>
+
+The title attribute is optional. Link names may contain letters,
+numbers and spaces, but are *not* case sensitive:
+
+    I start my morning with a cup of coffee and
+    [The New York Times][NY Times].
+
+    [ny times]: http://www.nytimes.com/
+
+Output:
+
+    <p>I start my morning with a cup of coffee and
+    <a href="http://www.nytimes.com/">The New York Times</a>.</p>
+
+
+### Images ###
+
+Image syntax is very much like link syntax.
+
+Inline (titles are optional):
+
+    ![alt text](/path/to/img.jpg "Title")
+
+Reference-style:
+
+    ![alt text][id]
+
+    [id]: /path/to/img.jpg "Title"
+
+Both of the above examples produce the same output:
+
+    <img src="/path/to/img.jpg" alt="alt text" title="Title" />
+
+
+
+### Code ###
+
+In a regular paragraph, you can create code span by wrapping text in
+backtick quotes. Any ampersands (`&`) and angle brackets (`<` or
+`>`) will automatically be translated into HTML entities. This makes
+it easy to use Markdown to write about HTML example code:
+
+    I strongly recommend against using any `<blink>` tags.
+
+    I wish SmartyPants used named entities like `&mdash;`
+    instead of decimal-encoded entites like `&#8212;`.
+
+Output:
+
+    <p>I strongly recommend against using any
+    <code>&lt;blink&gt;</code> tags.</p>
+    
+    <p>I wish SmartyPants used named entities like
+    <code>&amp;mdash;</code> instead of decimal-encoded
+    entites like <code>&amp;#8212;</code>.</p>
+
+
+To specify an entire block of pre-formatted code, indent every line of
+the block by 4 spaces or 1 tab. Just like with code spans, `&`, `<`,
+and `>` characters will be escaped automatically.
+
+Markdown:
+
+    If you want your page to validate under XHTML 1.0 Strict,
+    you've got to put paragraph tags in your blockquotes:
+
+        <blockquote>
+            <p>For example.</p>
+        </blockquote>
+
+Output:
+
+    <p>If you want your page to validate under XHTML 1.0 Strict,
+    you've got to put paragraph tags in your blockquotes:</p>
+    
+    <pre><code>&lt;blockquote&gt;
+        &lt;p&gt;For example.&lt;/p&gt;
+    &lt;/blockquote&gt;
+    </code></pre>