kramdown 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6f21a2a725bc5ab410d5402155cb27018d6edec
-  data.tar.gz: eaae19e9a6f514b79947e72fa76b2f6ab8f3a51b
+  metadata.gz: 43bc5045b25aa10da98437d9749b2fcd36fa437d
+  data.tar.gz: d4722f2fed6ffec6ae48323dab8535e56c868352
 SHA512:
-  metadata.gz: 519e94399dbcfa7acb14b77078e39f7db120b6c10da0510e0d7ad6754fb158cf96923f592ad4ec12ff11861eb2dd73585257e9dd6eed27eacb47bebb32c0aaae
-  data.tar.gz: 715a23901826864e7fc25aa93dd3566222931d3d22b5ecdb92db20e0cc4fd454cdae729d01004c18088f8398f9a88d5e2cbea3c05ef2d13bcc79afc34f50185a
+  metadata.gz: b796ad05a36b9618dceb6934e56998cd578051f03c22710e6fb33567b63af5082870ca0e697199e4bd0ac3291b79692e48d93562823ca8ba9723bf57c24e5f88
+  data.tar.gz: 9c62ce1f4c087f3dc3b3e60fe61cdf39f1dfdb82a6974440fe61a289941a2fe35d0fdbf1391a8be2d38b90409c9a3346f37d5a3450307e2e4f8ce496f3110d1e

data/CONTRIBUTERS

@@ -1,8 +1,9 @@
   Count Name
 ======= ====
-    816 Thomas Leitner <t_leitner@gmx.at>
+    827 Thomas Leitner <t_leitner@gmx.at>
       6 Gioele Barabucci <gioele@svario.it>
       4 Ted Pak <powerpak006@gmail.com>
+      4 Shuanglei Tao <tsl0922@gmail.com>
       4 Arne Brasseur <arne@arnebrasseur.net>
       3 Henning Perl <perl@fast-sicher.de>
       3 gettalong <t_leitner@gmx.at>
@@ -10,7 +11,6 @@
       3 Ben Armston <ben.armston@googlemail.com>
       3 Alex Marandon <contact@alexmarandon.com>
       2 Tom Thorogood <me+github@tomthorogood.co.uk>
-      2 Shuanglei Tao <tsl0922@gmail.com>
       2 Parker Moore <parkrmoore@gmail.com>
       2 Nathanael Jones <nathanael.jones@gmail.com>
       2 Max Meyer <dev@fedux.org>
@@ -40,6 +40,7 @@
       1 Joe Fiorini <joe@faithfulgeek.org>
       1 Jens Kraemer <jk@jkraemer.net>
       1 Hector Correa <hector@hectorcorrea.com>
+      1 Florian Klampfer <f.klampfer@gmail.com>
       1 Floreal Morandat florealm@gmail.com <florealm@gmail.com>
       1 Diego Galeota <diegobg123@gmail.com>
       1 Damien Pollet <damien.pollet@gmail.com>

data/README.md

@@ -60,10 +60,10 @@ kramdown Wiki at <https://github.com/gettalong/kramdown/wiki>.
 ## Development
 
 Just clone the git repository as described in **doc/installation.page** and you are good to go. You
-probably want to install `rake` so that you can use the provided rake tasks. Aside from that:
+probably want to install `rake` so that you can use the provided rake tasks.
 
-* The `tidy` binary needs to be installed for the automatically derived tests to work.
-* The `latex` binary needs to be installed for the latex-compilation tests to work.
+If you want to run the tests, the development dependencies are needed as well as some additional
+programs like `tidy` and `latex`. See the `.travis.yml` file for more information.
 
 
 ## License

data/Rakefile

@@ -149,7 +149,8 @@ EOF
   file 'man/man1/kramdown.1' => ['man/man1/kramdown.1.erb'] do
     puts "Generating kramdown man page"
     File.open('man/man1/kramdown.1', 'w+') do |file|
-      file.write(ERB.new(File.read('man/man1/kramdown.1.erb')).result(binding))
+      data = ERB.new(File.read('man/man1/kramdown.1.erb')).result(binding)
+      file.write(Kramdown::Document.new(data).to_man)
     end
   end
 

data/VERSION

@@ -1 +1 @@
-1.12.0
+1.13.0

data/bin/kramdown

@@ -21,8 +21,10 @@ OptionParser.new do |opts|
   opts.separator "Command line options:"
   opts.separator ""
 
-  opts.on("-i", "--input ARG", "Specify the input format: kramdown (default), html, GFM or markdown") {|v| options[:input] = v}
-  opts.on("-o", "--output ARG", Array, "Specify one or more output formats separated by commas: html (default), kramdown, latex, pdf or remove_html_tags") {|v| format = v}
+  opts.on("-i", "--input ARG", "Specify the input format: kramdown (default), " \
+          "html, GFM or markdown") {|v| options[:input] = v}
+  opts.on("-o", "--output ARG", Array, "Specify one or more output formats separated by commas: " \
+          "html (default),", "kramdown, latex, pdf, man or remove_html_tags") {|v| format = v}
 
   opts.on("-v", "--version", "Show the version of kramdown") do
     puts Kramdown::VERSION

data/doc/documentation.template

@@ -9,6 +9,7 @@
 * Converters
   * [HTML](converter/html.html)
   * [LaTeX](converter/latex.html)
+  * [man](converter/man.html)
   * [kramdown](converter/kramdown.html)
   * [RemoveHtmlTags](converter/remove_html_tags.html)
 * Syntax Highlighters

data/doc/index.page

@@ -97,8 +97,8 @@ extensions that have been made popular by the [PHP Markdown Extra] package and [
 It is probably the fastest pure-Ruby Markdown converter available (September 2014), being about 3x
 faster than [Maruku] and about 4.5x faster than [BlueFeather].
 
-Version **1.12.0**{:itemprop="softwareVersion"} released on
-**2016-08-15**{:itemprop="datePublished"}, [more news](news.html)
+Version **1.13.0**{:itemprop="softwareVersion"} released on
+**2016-11-20**{:itemprop="datePublished"}, [more news](news.html)
 {: style="text-align: center; font-size: 80%"}
 
 </div>

data/doc/syntax.page

@@ -787,10 +787,10 @@ There are four different line types that can be used in a table:
 
 * *Separator lines* are used to split the table body into multiple body parts.
 
-  A separator line is any line that contains only pipes, dashes, pluses, colons and spaces and which
-  contains at least one dash and one pipe character. The pipe and plus characters can be used to
-  visually separate columns although this is not needed. Multiple separator lines after another are
-  treated as one separator line.
+  A separator line is any line that contains only pipes, dashes, pluses, colons and spaces/tabs and
+  which contains at least one dash and one pipe character. The pipe and plus characters can be used
+  to visually separate columns although this is not needed. Multiple separator lines after another
+  are treated as one separator line.
 
   Here are some example separator lines:
 
@@ -806,9 +806,9 @@ There are four different line types that can be used in a table:
   alignments. All table rows above the header separator line are considered to be header rows.
 
   The header separator line can be specially formatted to contain column alignment definitions: An
-  alignment definition consists of an optional space followed by an optional colon, one or more
-  dashes, an optional colon and another optional space. The colons of an alignment definition are
-  used to set the alignment of a column: if there are no colons, the column uses the default
+  alignment definition consists of an optional space/tab followed by an optional colon, one or more
+  dashes, an optional colon and another optional space/tab. The colons of an alignment definition
+  are used to set the alignment of a column: if there are no colons, the column uses the default
   alignment, if there is a colon only before the dashes, the column is left aligned, if there are
   colons before and after the dashes, the column is center aligned and if there is only a colon
   after the dashes, the column is right aligned. Each alignment definition sets the alignment for

data/lib/kramdown/converter.rb

@@ -27,6 +27,7 @@ module Kramdown
     autoload :RemoveHtmlTags, 'kramdown/converter/remove_html_tags'
     autoload :Pdf, 'kramdown/converter/pdf'
     autoload :HashAST, 'kramdown/converter/hash_ast'
+    autoload :Man, 'kramdown/converter/man'
 
     extend ::Kramdown::Utils::Configurable
 

data/lib/kramdown/converter/man.rb

@@ -0,0 +1,303 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+require 'kramdown/converter'
+
+module Kramdown
+
+  module Converter
+
+    # Converts a Kramdown::Document to a manpage in groff format. See man(7), groff_man(7) and
+    # man-pages(7) for information regarding the output.
+    class Man < Base
+
+      def convert(el, opts = {:indent => 0, :result => ''}) #:nodoc:
+        send("convert_#{el.type}", el, opts)
+      end
+
+      private
+
+      def inner(el, opts, use = :all)
+        arr = el.children.reject {|e| e.type == :blank}
+        arr.each_with_index do |inner_el, index|
+          next if use == :rest && index == 0
+          break if use == :first && index > 0
+          options = opts.dup
+          options[:parent] = el
+          options[:index] = index
+          options[:prev] = (index == 0 ? nil : arr[index - 1])
+          options[:next] = (index == arr.length - 1 ? nil : arr[index + 1])
+          convert(inner_el, options)
+        end
+      end
+
+      def convert_root(el, opts)
+        @title_done = false
+        opts[:result] = ".\\\" generated by kramdown\n"
+        inner(el, opts)
+        opts[:result]
+      end
+
+      def convert_blank(*)
+      end
+      alias :convert_hr :convert_blank
+      alias :convert_xml_pi :convert_blank
+
+      def convert_p(el, opts)
+        if (opts[:index] != 0 && opts[:prev].type != :header) ||
+            (opts[:parent].type == :blockquote && opts[:index] == 0)
+          opts[:result] << macro("P")
+        end
+        inner(el, opts)
+        newline(opts[:result])
+      end
+
+      def convert_header(el, opts)
+        return unless opts[:parent].type == :root
+        case el.options[:level]
+        when 1
+          unless @title_done
+            @title_done = true
+            data = el.options[:raw_text].scan(/([^(]+)\s*\((\d\w*)\)(?:\s*-+\s*(.*))?/).first ||
+              el.options[:raw_text].scan(/([^\s]+)\s*(?:-*\s+)?()(.*)/).first
+            return unless data && data[0]
+            name = data[0]
+            section = (data[1].to_s.empty? ? el.attr['data-section'] || '7' : data[1])
+            description = (data[2].to_s.empty? ? nil : " - #{data[2]}")
+            date = el.attr['data-date'] ? quote(el.attr['data-date']) : nil
+            extra = (el.attr['data-extra'] ? quote(escape(el.attr['data-extra'].to_s)) : nil)
+            opts[:result] << macro("TH", quote(escape(name.upcase)), quote(section), date, extra)
+            if description
+              opts[:result] << macro("SH", "NAME") << escape("#{name}#{description}") << "\n"
+            end
+          end
+        when 2
+          opts[:result] << macro("SH", quote(escape(el.options[:raw_text])))
+        when 3
+          opts[:result] << macro("SS", quote(escape(el.options[:raw_text])))
+        else
+          warning("Header levels greater than three are not supported")
+        end
+      end
+
+      def convert_codeblock(el, opts)
+        opts[:result] << macro("sp") << macro("RS", 4) << macro("EX")
+        opts[:result] << newline(escape(el.value, true))
+        opts[:result] << macro("EE") << macro("RE")
+      end
+
+      def convert_blockquote(el, opts)
+        opts[:result] << macro("RS")
+        inner(el, opts)
+        opts[:result] << macro("RE")
+      end
+
+      def convert_ul(el, opts)
+        compact = (el.attr['class'] =~ /\bcompact\b/)
+        opts[:result] << macro("sp") << macro("PD", 0) if compact
+        inner(el, opts)
+        opts[:result] << macro("PD") if compact
+      end
+      alias :convert_dl :convert_ul
+      alias :convert_ol :convert_ul
+
+      def convert_li(el, opts)
+        sym = (opts[:parent].type == :ul ? '\(bu' : "#{opts[:index] + 1}.")
+        opts[:result] << macro("IP", sym, 4)
+        inner(el, opts, :first)
+        if el.children.size > 1
+          opts[:result] << macro("RS")
+          inner(el, opts, :rest)
+          opts[:result] << macro("RE")
+        end
+      end
+
+      def convert_dt(el, opts)
+        opts[:result] << macro(opts[:prev] && opts[:prev].type == :dt ? "TQ" : "TP")
+        inner(el, opts)
+        opts[:result] << "\n"
+      end
+
+      def convert_dd(el, opts)
+        inner(el, opts, :first)
+        if el.children.size > 1
+          opts[:result] << macro("RS")
+          inner(el, opts, :rest)
+          opts[:result] << macro("RE")
+        end
+        opts[:result] << macro("sp") if opts[:next] && opts[:next].type == :dd
+      end
+
+      TABLE_CELL_ALIGNMENT = {:left => 'l', :center => 'c', :right => 'r', :default => 'l'}
+
+      def convert_table(el, opts)
+        opts[:alignment] = el.options[:alignment].map {|a| TABLE_CELL_ALIGNMENT[a]}
+        table_options = ["box"]
+        table_options << "center" if el.attr['class'] =~ /\bcenter\b/
+        opts[:result] << macro("TS") << "#{table_options.join(" ")} ;\n"
+        inner(el, opts)
+        opts[:result] << macro("TE") << macro("sp")
+      end
+
+      def convert_thead(el, opts)
+        opts[:result] << opts[:alignment].map {|a| "#{a}b"}.join(' ') << " .\n"
+        inner(el, opts)
+        opts[:result] << "=\n"
+      end
+
+      def convert_tbody(el, opts)
+        opts[:result] << ".T&\n" if opts[:index] != 0
+        opts[:result] << opts[:alignment].join(' ') << " .\n"
+        inner(el, opts)
+        opts[:result] << (opts[:next].type == :tfoot ? "=\n" : "_\n") if opts[:next]
+      end
+
+      def convert_tfoot(el, opts)
+        inner(el, opts)
+      end
+
+      def convert_tr(el, opts)
+        inner(el, opts)
+        opts[:result] << "\n"
+      end
+
+      def convert_td(el, opts)
+        result = opts[:result]
+        opts[:result] = ''
+        inner(el, opts)
+        if opts[:result] =~ /\n/
+          warning("Table cells using links are not supported")
+          result << "\t"
+        else
+          result << opts[:result] << "\t"
+        end
+      end
+
+      def convert_html_element(*)
+        warning("HTML elements are not supported")
+      end
+
+      def convert_xml_comment(el, opts)
+        newline(opts[:result]) << ".\"#{escape(el.value, true).rstrip.gsub(/\n/, "\n.\"")}\n"
+      end
+      alias :convert_comment :convert_xml_comment
+
+
+      def convert_a(el, opts)
+        if el.children.size == 1 && el.children[0].type == :text &&
+            el.attr['href'] == el.children[0].value
+          newline(opts[:result]) << macro("UR", escape(el.attr['href'])) << macro("UE")
+        elsif el.attr['href'].start_with?('mailto:')
+          newline(opts[:result]) << macro("MT", escape(el.attr['href'].sub(/^mailto:/, ''))) <<
+            macro("UE")
+        else
+          newline(opts[:result]) << macro("UR", escape(el.attr['href']))
+          inner(el, opts)
+          newline(opts[:result]) << macro("UE")
+        end
+      end
+
+      def convert_img(el, opts)
+        warning("Images are not supported")
+      end
+
+      def convert_em(el, opts)
+        opts[:result] << '\fI'
+        inner(el, opts)
+        opts[:result] << '\fP'
+      end
+
+      def convert_strong(el, opts)
+        opts[:result] << '\fB'
+        inner(el, opts)
+        opts[:result] << '\fP'
+      end
+
+      def convert_codespan(el, opts)
+        opts[:result] << "\\fB#{escape(el.value)}\\fP"
+      end
+
+      def convert_br(el, opts)
+        newline(opts[:result]) << macro("br")
+      end
+
+      def convert_abbreviation(el, opts)
+        opts[:result] << escape(el.value)
+      end
+
+      def convert_math(el, opts)
+        if el.options[:category] == :block
+          convert_codeblock(el, opts)
+        else
+          convert_codespan(el, opts)
+        end
+      end
+
+      def convert_footnote(*)
+        warning("Footnotes are not supported")
+      end
+
+      def convert_raw(*)
+        warning("Raw content is not supported")
+      end
+
+
+
+      def convert_text(el, opts)
+        text = escape(el.value)
+        text.lstrip! if opts[:result][-1] == ?\n
+        opts[:result] << text
+      end
+
+      def convert_entity(el, opts)
+        opts[:result] << unicode_char(el.value.code_point)
+      end
+
+      def convert_smart_quote(el, opts)
+        opts[:result] << unicode_char(::Kramdown::Utils::Entities.entity(el.value.to_s).code_point)
+      end
+
+      TYPOGRAPHIC_SYMS_MAP = {
+        :mdash => '\(em', :ndash => '\(em', :hellip => '\.\.\.',
+        :laquo_space => '\[Fo]', :raquo_space => '\[Fc]', :laquo => '\[Fo]', :raquo => '\[Fc]'
+      }
+
+      def convert_typographic_sym(el, opts)
+        opts[:result] << TYPOGRAPHIC_SYMS_MAP[el.value]
+      end
+
+      def macro(name, *args)
+        ".#{[name, *args].compact.join(' ')}\n"
+      end
+
+      def newline(text)
+        text << "\n" unless text[-1] == ?\n
+        text
+      end
+
+      def quote(text)
+        "\"#{text.gsub(/"/, '\\"')}\""
+      end
+
+      def escape(text, preserve_whitespace = false)
+        text = (preserve_whitespace ? text.dup : text.gsub(/\s+/, ' '))
+        text.gsub!('\\', "\\e")
+        text.gsub!(/^\./, '\\\\&.')
+        text.gsub!(/[.'-]/) {|m| "\\#{m}"}
+        text
+      end
+
+      def unicode_char(codepoint)
+        "\\[u#{codepoint.to_s(16).rjust(4, '0')}]"
+      end
+
+    end
+
+  end
+end

data/lib/kramdown/converter/math_engine/mathjax.rb

@@ -36,10 +36,20 @@ module Kramdown::Converter::MathEngine
 
       preview = (preview == true ? converter.escape_html(el.value) : preview.to_s)
 
+      preview_as_code = converter.options[:math_engine_opts][:preview_as_code]
+
       if el.options[:category] == :block
-        converter.format_as_block_html('div', {'class' => 'MathJax_Preview'}, preview, opts[:indent])
+        if preview_as_code
+          converter.format_as_block_html('pre', {'class' => 'MathJax_Preview'},
+                                         converter.format_as_span_html('code', {}, preview),
+                                         opts[:indent])
+        else
+          converter.format_as_block_html('div', {'class' => 'MathJax_Preview'}, preview,
+                                         opts[:indent])
+        end
       else
-        converter.format_as_span_html('span', {'class' => 'MathJax_Preview'}, preview)
+        converter.format_as_span_html(preview_as_code ? 'code' : 'span',
+                                      {'class' => 'MathJax_Preview'}, preview)
       end
     end