kramdown 0.7.0 → 0.8.0

data/README

@@ -6,6 +6,7 @@ supporting several common extensions.
 The syntax definition can be found in doc/syntax.page, a quick reference in doc/quickref.page. All
 the documentation is available online at http://kramdown.rubyforge.org.
 
+
 # Usage
 
 kramdown has a basic *Cloth API, so using kramdown is as easy as
@@ -15,6 +16,15 @@ kramdown has a basic *Cloth API, so using kramdown is as easy as
     Kramdown::Document.new(text).to_html
 
 
+# Development
+
+Just clone the git repository as described in doc/installation.page you are good to go. You probably
+want to install `rake` so that you can use the provided rake tasks. Aside from that:
+
+* The `tidy` binary needs to be installed for the html-to-html tests to work.
+* The `latex` binary needs to be installed for the latex-compilation tests to work.
+
+
 # License
 
 See the COPYING file.

data/Rakefile

@@ -14,9 +14,11 @@ begin
 rescue LoadError
 end
 
-require 'rdoc/task'
-require 'rdoc/rdoc'
-
+begin
+  require 'rdoc/task'
+  require 'rdoc/rdoc'
+rescue LoadError
+end
 
 begin
   require 'rubyforge'
@@ -69,20 +71,22 @@ if defined? Webgen
       config['contentprocessor.tags.map']['kdlink'] = 'KDLink'
     end
   end
-
-  task :doc => :htmldoc
 end
 
-rd = Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'htmldoc/rdoc'
-  rdoc.title = 'kramdown'
-  rdoc.main = 'Kramdown'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('lib/**/*.rb')
+if defined? Rake::RDocTask
+  rd = Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'htmldoc/rdoc'
+    rdoc.title = 'kramdown'
+    rdoc.main = 'Kramdown'
+    rdoc.options << '--line-numbers'
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
 end
 
-desc "Build the whole user documentation"
-task :doc => :rdoc
+if defined?(Webgen) && defined?(Rake::RDocTask)
+  desc "Build the whole user documentation"
+  task :doc => [:rdoc, 'htmldoc']
+end
 
 tt = Rake::TestTask.new do |test|
   test.warning = true
@@ -109,7 +113,7 @@ EOF
                             'Rakefile',
                             'setup.rb',
                             'COPYING', 'GPL', 'README', 'AUTHORS',
-                            'VERSION', 'ChangeLog',
+                            'VERSION', 'ChangeLog', 'CONTRIBUTERS',
                             'bin/*',
                             'benchmark/*',
                             'lib/**/*.rb',
@@ -131,6 +135,14 @@ EOF
     `git log --name-only > ChangeLog`
   end
 
+  CLOBBER << 'CONTRIBUTERS'
+  file 'CONTRIBUTERS' do
+    puts "Generating CONTRIBUTERS file"
+    `echo "  Count Name" > CONTRIBUTERS`
+    `echo "======= ====" >> CONTRIBUTERS`
+    `git log | grep ^Author: | sed 's/^Author: //' | sort | uniq -c | sort -nr >> CONTRIBUTERS`
+  end
+
   CLOBBER << "man/man1/kramdown.1"
   file 'man/man1/kramdown.1' => ['man/man1/kramdown.1.erb'] do
     puts "Generating kramdown man page"
@@ -181,8 +193,10 @@ EOF
 
   end
 
-  desc 'Release Kramdown version ' + Kramdown::VERSION
-  task :release => [:clobber, :package, :publish_files, :publish_website, :post_news]
+  if defined?(RubyForge) && defined?(Webgen) && defined?(Gem) && defined?(Rake::RDocTask)
+    desc 'Release Kramdown version ' + Kramdown::VERSION
+    task :release => [:clobber, :package, :publish_files, :publish_website, :post_news]
+  end
 
   if defined? RubyForge
     desc "Upload the release to Rubyforge"
@@ -232,8 +246,8 @@ EOF
     end
   end
 
+  CODING_LINE = "# -*- coding: utf-8 -*-\n"
   COPYRIGHT=<<EOF
-# -*- coding: utf-8 -*-
 #
 #--
 # Copyright (C) 2009-2010 Thomas Leitner <t_leitner@gmx.at>
@@ -256,15 +270,18 @@ EOF
 #
 EOF
 
-  desc "Insert copyright notice"
-  task :insert_copyright do
+  desc "Insert/Update copyright notice"
+  task :update_copyright do
     inserted = false
     Dir["lib/**/*.rb"].each do |file|
-      if !File.read(file).start_with?(COPYRIGHT)
+      if !File.read(file).start_with?(CODING_LINE + COPYRIGHT)
         inserted = true
         puts "Updating file #{file}"
-        data = COPYRIGHT + "\n" + File.read(file)
-        File.open(file, 'w+') {|f| f.puts(data)}
+        old = File.read(file)
+        if !(result = old.gsub!(/\A#{Regexp.escape(CODING_LINE)}#\n#--.*?\n#\+\+\n#\n/m, CODING_LINE + COPYRIGHT))
+          old.gsub!(/\A(#{Regexp.escape(CODING_LINE)})?/, CODING_LINE + COPYRIGHT + "\n")
+        end
+        File.open(file, 'w+') {|f| f.puts(old)}
       end
     end
     puts "Look through the above mentioned files and correct all problems" if inserted
@@ -302,7 +319,7 @@ if defined? Webgen
     include Webgen::Tag::Base
 
     def call(tag, body, context)
-      result = ::Kramdown::Document.new(body).to_html
+      result = ::Kramdown::Document.new(body, :auto_ids => false).to_html
       before = "<pre class='kdexample-before'>#{body}<code>\n</code></pre>"
       after = "<pre class='kdexample-after-source'>#{CGI::escapeHTML(result)}<code>\n</code></pre>"
       afterhtml = "<div class='kdexample-after-live'>#{result}</div>"

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/data/kramdown/document.html

@@ -4,6 +4,6 @@
     <meta name="generator" content="kramdown <%= Kramdown::VERSION %>" />
   </head>
   <body>
-  <%= body %>
+  <%= @body %>
   </body>
 </html>

data/data/kramdown/document.latex

@@ -1,5 +1,5 @@
 <%
-ENCODING_MAP = {
+encmap = {
   'UTF-8' => 'utf8x',
   'US-ASCII' => 'ascii',
   'ISO-8859-1' => 'latin1',
@@ -17,10 +17,11 @@ ENCODING_MAP = {
   'CP1250' => 'cp120',
   'CP1252' => 'cp1252',
   'CP1257' => 'cp1257'
-} %>
+}
+%>
 \documentclass{scrartcl}
 <% if RUBY_VERSION >= '1.9' %>
-\usepackage[<%= ENCODING_MAP[body.encoding.name] %>]{inputenc}
+\usepackage[<%= encmap[@body.encoding.name] %>]{inputenc}
 <% else %>
 \usepackage[mathletters]{ucs}
 \usepackage[utf8x]{inputenc}
@@ -28,11 +29,15 @@ ENCODING_MAP = {
 \usepackage[T1]{fontenc}
 \usepackage{listings}
 \usepackage{hyperref}
-<% doc.conversion_infos[:packages].each {|pkg| %>\usepackage{<%= pkg %>}
+<% @doc.conversion_infos[:packages].each {|pkg| %>\usepackage{<%= pkg %>}
 <% } %>
 
+<% if @doc.conversion_infos[:packages].include?('fancyvrb') %>
+\VerbatimFootnotes
+<% end %>
+
 \hypersetup{colorlinks=true,urlcolor=blue}
 
 \begin{document}
-<%= body %>
+<%= @body %>
 \end{document}

data/doc/default.less.css

@@ -153,6 +153,55 @@ body, table, code {
     background-image: -moz-linear-gradient(top, #eee, #fff 100, #fff);
     background-image: -webkit-gradient(linear, 0 0, 0 200, from(#eee), to(#fff));
 
+    a {
+        color: @link-color;
+        background-color: inherit;
+        text-decoration: underline;
+    }
+
+    a:hover, a:link {
+        color: #0B4775;
+    }
+
+    #sidebar {
+        float: right;
+        width: 30%;
+        min-width: 100px;
+        margin: 0 0 10px 10px;
+        color: black;
+        font-size: 92%;
+        background-color: #eee;
+
+        #sidebar-content {
+            padding: 5px 10px;
+            opacity: 1;
+        }
+
+        p {
+            margin: 0px;
+            padding: 5px 0px;
+        }
+
+        ul {
+            list-style: square;
+            margin: 5px 0px 5px 15px;
+            padding: 3px;
+
+            ul {
+                margin: 0px 0px 0px 5px;
+            }
+        }
+
+        a {
+            padding: 1px;
+            text-decoration: none;
+        }
+
+        h1 {
+            font: bold 150% Perpetua, Baskerville, "Big Caslon", "Palatino Linotype", Palatino, "URW Palladio L", "Nimbus Roman No9 L", serif;
+        }
+    }
+
     #main {
 
         margin-top: 20px;
@@ -197,16 +246,6 @@ body, table, code {
             padding: 2px;
         }
 
-        a {
-            color: @link-color;
-            background-color: inherit;
-            text-decoration: underline;
-        }
-
-        a:hover, a:link {
-            color: #0B4775;
-        }
-
         *:target::after {
             content: " ☜";
             font-size: 120%;
@@ -390,6 +429,8 @@ body, table, code {
             float: right;
             background-color: #ffffee;
             border: 2px solid #e6e8e9;
+            margin-left: 10px;
+            margin-right: 10px;
             margin-bottom: 3px;
         }
 
@@ -400,6 +441,7 @@ body, table, code {
             background-color: #eeffee;
             border: 2px solid #e6e8e9;
             margin: 0px 10px;
+            padding: 5px;
         }
 
         div.kdsyntaxlink {

data/doc/default.template

@@ -34,6 +34,10 @@
 
     <div id="container">
 
+      <div id="sidebar"><div id="sidebar-content">
+        <webgen:block name="sidebar" node="first" notfound="ignore" />
+      </div></div>
+
       <div id="main">
         <webgen:block name="content" />
         <div class="clear"></div>

data/doc/documentation.page

@@ -0,0 +1,72 @@
+---
+title: Documentation
+in_menu: true
+sort_info: 7
+---
+## Overview
+
+kramdown is first and foremost a library for converting text written in a superset of Markdown to
+HTML. However, due to its modular architecture it is able to support additional input and output
+formats. The following input and output formats are currently supported:
+
+* Input: [kramdown](parser/kramdown.html) (a superset of Markdown), [html](parser/html.html)
+* Output: [HTML](converter/html.html), [LaTeX](converter/latex.html)
+
+
+## Usage
+
+{:ruby: lang='ruby'}
+
+The kramdown package provides two ways for using it:
+
+* **As a library**
+
+  kramdown uses basically the same API as [RedCloth], [BlueCloth] and [Maruku]:
+
+      require 'kramdown'
+
+      puts Kramdown::Document.new(text).to_html
+  {:ruby}
+
+  The second parameter to the `new` call is an options hash for (de)activating certain features. For
+  example, to disable automatic header ID generation, you can do the following:
+
+      puts Kramdown::Document.new(text, :auto_ids => false).to_html
+  {:ruby}
+
+  The default parser used is `kramdown`, however, you can select a different one with the `:input`
+  option:
+
+      puts Kramdown::Document.new(text, :input => 'html').to_latex
+  {:ruby}
+
+  You can also reuse the created document object to produce multiple outputs:
+
+      doc = Kramdown::Document.new(text, :input => 'html')
+      puts doc.to_html
+      puts doc.to_latex
+  {:ruby}
+
+  More information on how to use or extend kramdown can be found in the [API
+  documentation](rdoc/index.html)!
+
+* **As an application**
+
+  Together with the library files a binary called `kramdown` is shipped which can be used to convert
+  text in any supported format (currently only kramdown syntax) to any supported output format (e.g.
+  HTML or LaTeX). It either reads from the files specified as the command line arguments or from the
+  standard input. For example:
+
+      kramdown path/to/kramdown/doc/syntax.page
+
+  The input and output formats as well as all available kramdown options are supported through
+  command line switches.
+
+
+## Tests
+
+kramdown uses various test suites to verify the correct working of the parsers and converters. For
+more information, have a look at the [tests document](tests.html).
+
+
+{include_file: doc/links.markdown}

data/doc/index.page

@@ -5,44 +5,11 @@ sort_info: 1
 ---
 ## Overview
 
-kramdown is first and foremost a library for converting text written in a superset of Markdown to
-HTML. However, due to its modular architecture it is able to support additional input and output
-formats. The following input and output formats are currently supported:
-
-* Input: [kramdown](parser/kramdown.html) (a superset of Markdown)
-* Output: [HTML](converter/html.html), [LaTeX](converter/latex.html)
-
-
-## Usage
-
-The kramdown package provides two ways for using it:
-
-* **As a library**
-
-  kramdown uses basically the same API as [RedCloth], [BlueCloth] and [Maruku]:
-
-      require 'kramdown'
-
-      Kramdown::Document.new(text).to_html
-  {: lang='ruby'}
-
-  The second parameter to the `new` call is an options hash for (de)activating certain features. For
-  more information have a look at the [API documentation](rdoc/index.html).
-
-* **As an application**
-
-  Together with the library files a binary called `kramdown` is shipped which can be used to convert
-  text in any supported format (currently only kramdown syntax) to any supported output format (e.g.
-  HTML or LaTeX). It either reads from the files specified as the command line arguments or from the
-  standard input. For example:
-
-      kramdown path/to/kramdown/doc/syntax.page
-
-
-## Tests
-
-kramdown uses various test suites to verify the correct working of the parsers and converters. For
-more information, have a look at the [tests document](tests.html).
+If you want to get started with kramdown, have a look at the [installation page](installation.html)
+to see how you can install it on your system. Then look through the
+[documentation](documentation.html) for finding information about how to actually use kramdown and
+what parsers/converters it supports. The [syntax](syntax.html) provides a detailed description of
+the superset of Markdown which kramdown supports.
 
 
 ## Bugs, Forums, Mailing Lists
@@ -84,11 +51,11 @@ Markdown implementations because kramdown borrowed many ideas from existing pack
 completely written in Ruby, supports standard Markdown (with some minor modifications) and various
 extensions that have been made popular by the [PHP Markdown Extra] package and [Maruku].
 
-It is probably the fastest pure-Ruby Markdown converter available (February 2010), being about 4.5x
-faster than [Maruku] and about 10x faster than [BlueFeather].
+It is probably the fastest pure-Ruby Markdown converter available (June 2010), being about 4x faster
+than [Maruku] and about 9x faster than [BlueFeather].
 
 <p class="a-center">
-The latest version of kramdown is <b>0.7.0</b> and it was released on <b>2010-05-07</b>.
+The latest version of kramdown is <b>0.8.0</b> and it was released on <b>2010-06-08</b>.
 </p>
 
 [PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/

data/doc/installation.page

@@ -10,8 +10,8 @@ sort_info: 5
 kramdown should work on any platform which supports Ruby. It has been successfully tested on the
 following platforms:
 
-* Linux with Ruby 1.8.5, 1.8.6, 1.8.7, 1.9.1
-* Mac OSX with Ruby 1.8.5, 1.8.6, 1.8.7, 1.9.1, 1.9.2-preview1 and jruby 1.4.0.
+* Linux with Ruby 1.8.5, 1.8.6, 1.8.7, 1.9.1, 1.9.2-preview1 and jruby 1.5.0.
+* Mac OSX with Ruby 1.8.5, 1.8.6, 1.8.7, 1.9.1, 1.9.2-preview1 and jruby 1.5.0.
 
 See the platform specific installation notes for more information!
 
@@ -20,9 +20,9 @@ See the platform specific installation notes for more information!
 
 ### Linux
 
-There are a variety of Linux distributions out there with different package management systems. So we
-will focus on instructions for Ubuntu 9.04 here (which should probably also work for any recent
-Debian based distribution).
+There are a variety of Linux distributions out there with different package management systems. So
+we will focus on instructions for Ubuntu 9.04 here (which should probably also work for any newer
+Ubuntu version or any recent Debian based distribution).
 
 After running the following commands, kramdown is installed and ready to use:
 
@@ -30,7 +30,7 @@ After running the following commands, kramdown is installed and ready to use:
     sudo gem1.8 install kramdown
 
 > You will also need to add `export PATH=$PATH:/var/lib/gems/1.8/bin` to your `~/.bashrc` because
-> this is the binary path the executable files get installed.
+> this is the binary path the executable files get installed to.
 
 
 ### Mac OS X