kramdown 0.13.7 → 0.13.8

data/lib/kramdown/converter/latex.rb

@@ -117,7 +117,7 @@ module Kramdown
       end
 
       def convert_header(el, opts)
-        type = @options[:latex_headers][el.options[:level] - 1]
+        type = @options[:latex_headers][output_header_level(el.options[:level]) - 1]
         if ((id = el.attr['id']) ||
             (@options[:auto_ids] && (id = generate_id(el.options[:raw_text])))) && in_toc?(el)
           "\\#{type}{#{inner(el, opts)}}\\hypertarget{#{id}}{}\\label{#{id}}\n\n"

data/lib/kramdown/document.rb

@@ -19,6 +19,35 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
 #
+# = kramdown
+#
+# kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and
+# supporting several common extensions.
+#
+# The kramdown library is mainly written to support the kramdown-to-HTML conversion chain. However,
+# due to its flexibility it supports other input and output formats as well. Here is a list of the
+# supported formats:
+#
+# * input formats: kramdown (a Markdown superset), Markdown, HTML
+# * output formats: HTML, kramdown, LaTeX (and therefore PDF)
+#
+# All the documentation on the available input and output formats is available at
+# http://kramdown.rubyforge.org.
+#
+# == Usage
+#
+# kramdown has a basic *Cloth API, so using kramdown is as easy as
+#
+#     require 'kramdown'
+#
+#     Kramdown::Document.new(text).to_html
+#
+# For detailed information have a look at the Kramdown::Document class.
+#
+# == License
+#
+# GPLv3 - see the COPYING file.
+
 
 require 'kramdown/compatibility'
 

data/lib/kramdown/options.rb

@@ -241,6 +241,16 @@ footnote.
 
 Default: 1
 Used by: HTML converter
+EOF
+
+    define(:enable_coderay, Boolean, true, <<EOF)
+Use coderay for syntax highlighting
+
+If this option is `true`, coderay is used by the HTML converter for
+syntax highlighting the content of code spans and code blocks.
+
+Default: true
+Used by: HTML converter
 EOF
 
     define(:coderay_wrap, Symbol, :div, <<EOF)
@@ -294,7 +304,7 @@ Used by: HTML converter
 EOF
 
     define(:coderay_default_lang, Symbol, nil, <<EOF)
-Sets the default language for highlighting.
+Sets the default language for highlighting code blocks
 
 If no language is set for a code block, the default language is used
 instead. The value has to be one of the languages supported by coderay
@@ -359,7 +369,7 @@ Defines the LaTeX commands for different header levels
 The commands for the header levels one to six can be specified by
 separating them with commas.
 
-Default: section,subsection,subsubsection,paragraph,subparagraph,subsubparagraph
+Default: section,subsection,subsubsection,paragraph,subparagraph,subparagraph
 Used by: Latex converter
 EOF
       simple_array_validator(val, :latex_headers, 6)
@@ -399,6 +409,17 @@ span HTML tags.
 
 Default: false
 Used by: RemoveHtmlTags converter
+EOF
+
+    define(:header_offset, Integer, 0, <<EOF)
+Sets the output offset for headers
+
+If this option is c (may also be negative) then a header with level n
+will be output as a header with level c+n. If c+n is lower than 1,
+level 1 will be used. If c+n is greater than 6, level 6 will be used.
+
+Default: 0
+Used by: HTML converter, Kramdown converter, Latex converter
 EOF
 
   end

data/lib/kramdown/parser/kramdown/abbreviation.rb

@@ -42,7 +42,8 @@ module Kramdown
       def replace_abbreviations(el, regexps = nil)
         return if @root.options[:abbrev_defs].empty?
         if !regexps
-          regexps = [Regexp.union(*@root.options[:abbrev_defs].keys.map {|k| /#{Regexp.escape(k)}/})]
+          sorted_abbrevs = @root.options[:abbrev_defs].keys.sort {|a,b| b.length <=> a.length}
+          regexps = [Regexp.union(*sorted_abbrevs.map {|k| /#{Regexp.escape(k)}/})]
           regexps << /(?=(?:\W|^)#{regexps.first}(?!\w))/ # regexp should only match on word boundaries
         end
         el.children.map! do |child|

data/lib/kramdown/version.rb

@@ -23,6 +23,6 @@
 module Kramdown
 
   # The kramdown version.
-  VERSION = '0.13.7'
+  VERSION = '0.13.8'
 
 end

data/man/man1/kramdown.1

@@ -35,66 +35,78 @@ Show the help.
 .SH KRAMDOWN OPTIONS
 
 .TP
-.B \-\-[no\-]remove-span-html-tags
+.B \-\-template ARG
 
-Remove span HTML tags
+The name of an ERB template file that should be used to wrap the output
 
-If this option is `true`, the RemoveHtmlTags converter removes
-span HTML tags.
+This is used to wrap the output in an environment so that the output can
+be used as a stand-alone document. For example, an HTML template would
+provide the needed header and body tags so that the whole output is a
+valid HTML file. If no template is specified, the output will be just
+the converted text.
 
-Default: false
-Used by: RemoveHtmlTags converter
+When resolving the template file, the given template name is used first.
+If such a file is not found, the converter extension is appended. If the
+file still cannot be found, the templates name is interpreted as a
+template name that is provided by kramdown (without the converter
+extension).
+
+kramdown provides a default template named 'document' for each converter.
+
+Default: ''
+Used by: all converters
 
 
 .TP
-.B \-\-coderay-tab-width ARG
+.B \-\-[no\-]auto-ids
 
-The tab width used in highlighted code
+Use automatic header ID generation
 
-Used by: HTML converter
+If this option is `true`, ID values for all headers are automatically
+generated if no ID is explicitly specified.
+
+Default: true
+Used by: HTML/Latex converter
 
 
 .TP
-.B \-\-toc-levels ARG
+.B \-\-auto-id-prefix ARG
 
-Defines the levels that are used for the table of contents
+Prefix used for automatically generated heaer IDs
 
-The individual levels can be specified by separating them with commas
-(e.g. 1,2,3) or by using the range syntax (e.g. 1..3). Only the
-specified levels are used for the table of contents.
+This option can be used to set a prefix for the automatically generated
+header IDs so that there is no conflict when rendering multiple kramdown
+documents into one output file separately. The prefix should only
+contain characters that are valid in an ID!
 
-Default: 1..6
+Default: ''
 Used by: HTML/Latex converter
 
 
 .TP
-.B \-\-[no\-]parse-span-html
+.B \-\-[no\-]parse-block-html
 
-Process kramdown syntax in span HTML tags
+Process kramdown syntax in block HTML tags
 
 If this option is `true`, the kramdown parser processes the content of
-span HTML tags as text containing span-level elements.
+block HTML tags as text containing block-level elements. Since this is
+not wanted normally, the default is `false`. It is normally better to
+selectively enable kramdown processing via the markdown attribute.
 
-Default: true
+Default: false
 Used by: kramdown parser
 
 
 .TP
-.B \-\-coderay-bold-every ARG
-
-Defines how often a line number should be made bold
-
-Default: 10
-Used by: HTML converter
-
+.B \-\-[no\-]parse-span-html
 
-.TP
-.B \-\-line-width ARG
+Process kramdown syntax in span HTML tags
 
-Defines the line width to be used when outputting a document
+If this option is `true`, the kramdown parser processes the content of
+span HTML tags as text containing span-level elements.
 
-Default: 72
-Used by: kramdown converter
+Default: true
+Used by: kramdown parser
 
 
 .TP
@@ -115,112 +127,101 @@ Used by: kramdown parser
 
 
 .TP
-.B \-\-coderay-css ARG
+.B \-\-footnote-nr ARG
 
-Defines how the highlighted code gets styled
+The number of the first footnote
 
-Possible values are :class (CSS classes are applied to the code
-elements, one must supply the needed CSS file) or :style (default CSS
-styles are directly applied to the code elements).
+This option can be used to specify the number that is used for the first
+footnote.
 
-Default: style
+Default: 1
 Used by: HTML converter
 
 
 .TP
-.B \-\-latex-headers ARG
+.B \-\-[no\-]enable-coderay
 
-Defines the LaTeX commands for different header levels
+Use coderay for syntax highlighting
 
-The commands for the header levels one to six can be specified by
-separating them with commas.
+If this option is `true`, coderay is used by the HTML converter for
+syntax highlighting the content of code spans and code blocks.
 
-Default: section,subsection,subsubsection,paragraph,subparagraph,subsubparagraph
-Used by: Latex converter
+Default: true
+Used by: HTML converter
 
 
 .TP
-.B \-\-footnote-nr ARG
+.B \-\-coderay-wrap ARG
 
-The number of the first footnote
+Defines how the highlighted code should be wrapped
 
-This option can be used to specify the number that is used for the first
-footnote.
+The possible values are :span, :div or nil.
 
-Default: 1
+Default: :div
 Used by: HTML converter
 
 
 .TP
-.B \-\-template ARG
+.B \-\-coderay-line-numbers ARG
 
-The name of an ERB template file that should be used to wrap the output
+Defines how and if line numbers should be shown
 
-This is used to wrap the output in an environment so that the output can
-be used as a stand-alone document. For example, an HTML template would
-provide the needed header and body tags so that the whole output is a
-valid HTML file. If no template is specified, the output will be just
-the converted text.
+The possible values are :table, :inline or nil. If this option is
+nil, no line numbers are shown.
 
-When resolving the template file, the given template name is used first.
-If such a file is not found, the converter extension is appended. If the
-file still cannot be found, the templates name is interpreted as a
-template name that is provided by kramdown (without the converter
-extension).
+Default: :inline
+Used by: HTML converter
 
-kramdown provides a default template named 'document' for each converter.
 
-Default: ''
-Used by: all converters
+.TP
+.B \-\-coderay-line-number-start ARG
 
+The start value for the line numbers
 
-.TP
-.B \-\-coderay-default-lang ARG
+Default: 1
+Used by: HTML converter
 
-Sets the default language for highlighting.
 
-If no language is set for a code block, the default language is used
-instead. The value has to be one of the languages supported by coderay
-or nil if no default language should be used.
+.TP
+.B \-\-coderay-tab-width ARG
+
+The tab width used in highlighted code
 
-Default: nil
 Used by: HTML converter
 
 
 .TP
-.B \-\-coderay-line-numbers ARG
-
-Defines how and if line numbers should be shown
+.B \-\-coderay-bold-every ARG
 
-The possible values are :table, :inline or nil. If this option is
-nil, no line numbers are shown.
+Defines how often a line number should be made bold
 
-Default: :inline
+Default: 10
 Used by: HTML converter
 
 
 .TP
-.B \-\-smart-quotes ARG
+.B \-\-coderay-css ARG
 
-Defines the HTML entity names or code points for smart quote output
+Defines how the highlighted code gets styled
 
-The entities identified by entity name or code point that should be
-used for, in order, a left single quote, a right single quote, a left
-double and a right double quote are specified by separating them with
-commas.
+Possible values are :class (CSS classes are applied to the code
+elements, one must supply the needed CSS file) or :style (default CSS
+styles are directly applied to the code elements).
 
-Default: lsquo,rsquo,ldquo,rdquo
-Used by: HTML/Latex converter
+Default: style
+Used by: HTML converter
 
 
 .TP
-.B \-\-coderay-wrap ARG
+.B \-\-coderay-default-lang ARG
 
-Defines how the highlighted code should be wrapped
+Sets the default language for highlighting code blocks
 
-The possible values are :span, :div or nil.
+If no language is set for a code block, the default language is used
+instead. The value has to be one of the languages supported by coderay
+or nil if no default language should be used.
 
-Default: :div
+Default: nil
 Used by: HTML converter
 
 
@@ -240,64 +241,88 @@ Used by: HTML converter, kramdown converter
 
 
 .TP
-.B \-\-auto-id-prefix ARG
+.B \-\-toc-levels ARG
 
-Prefix used for automatically generated heaer IDs
+Defines the levels that are used for the table of contents
 
-This option can be used to set a prefix for the automatically generated
-header IDs so that there is no conflict when rendering multiple kramdown
-documents into one output file separately. The prefix should only
-contain characters that are valid in an ID!
+The individual levels can be specified by separating them with commas
+(e.g. 1,2,3) or by using the range syntax (e.g. 1..3). Only the
+specified levels are used for the table of contents.
 
-Default: ''
+Default: 1..6
 Used by: HTML/Latex converter
 
 
 .TP
-.B \-\-[no\-]remove-block-html-tags
+.B \-\-line-width ARG
 
-Remove block HTML tags
+Defines the line width to be used when outputting a document
 
-If this option is `true`, the RemoveHtmlTags converter removes
-block HTML tags.
+Default: 72
+Used by: kramdown converter
 
-Default: true
-Used by: RemoveHtmlTags converter
+
+.TP
+.B \-\-latex-headers ARG
+
+Defines the LaTeX commands for different header levels
+
+The commands for the header levels one to six can be specified by
+separating them with commas.
+
+Default: section,subsection,subsubsection,paragraph,subparagraph,subparagraph
+Used by: Latex converter
 
 
 .TP
-.B \-\-coderay-line-number-start ARG
+.B \-\-smart-quotes ARG
 
-The start value for the line numbers
+Defines the HTML entity names or code points for smart quote output
 
-Default: 1
-Used by: HTML converter
+The entities identified by entity name or code point that should be
+used for, in order, a left single quote, a right single quote, a left
+double and a right double quote are specified by separating them with
+commas.
+
+Default: lsquo,rsquo,ldquo,rdquo
+Used by: HTML/Latex converter
 
 
 .TP
-.B \-\-[no\-]auto-ids
+.B \-\-[no\-]remove-block-html-tags
 
-Use automatic header ID generation
+Remove block HTML tags
 
-If this option is `true`, ID values for all headers are automatically
-generated if no ID is explicitly specified.
+If this option is `true`, the RemoveHtmlTags converter removes
+block HTML tags.
 
 Default: true
-Used by: HTML/Latex converter
+Used by: RemoveHtmlTags converter
 
 
 .TP
-.B \-\-[no\-]parse-block-html
+.B \-\-[no\-]remove-span-html-tags
 
-Process kramdown syntax in block HTML tags
+Remove span HTML tags
 
-If this option is `true`, the kramdown parser processes the content of
-block HTML tags as text containing block-level elements. Since this is
-not wanted normally, the default is `false`. It is normally better to
-selectively enable kramdown processing via the markdown attribute.
+If this option is `true`, the RemoveHtmlTags converter removes
+span HTML tags.
 
 Default: false
-Used by: kramdown parser
+Used by: RemoveHtmlTags converter
+
+
+.TP
+.B \-\-header-offset ARG
+
+Sets the output offset for headers
+
+If this option is c (may also be negative) then a header with level n
+will be output as a header with level c+n. If c+n is lower than 1,
+level 1 will be used. If c+n is greater than 6, level 6 will be used.
+
+Default: 0
+Used by: HTML converter, Kramdown converter, Latex converter
 
 
 .SH EXIT STATUS