kramdown 0.14.2 → 2.3.0

data/lib/kramdown/element.rb

@@ -1,22 +1,9 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
@@ -27,8 +14,19 @@ module Kramdown
   # kramdown only uses this one class for representing all available elements in an element tree
   # (paragraphs, headers, emphasis, ...). The type of element can be set via the #type accessor.
   #
+  # The root of a kramdown element tree has to be an element of type :root. It needs to have certain
+  # option keys set so that conversions work correctly. If only a part of a tree should be
+  # converted, duplicate the root node and assign the #children appropriately, e.g:
+  #
+  #   root = doc.root
+  #   new_root = root.dup
+  #   new_root.children = [root.children[0]]  # assign new array with elements to convert
+  #
   # Following is a description of all supported element types.
   #
+  # Note that the option :location may contain the start line number of an element in the source
+  # document.
+  #
   # == Structural Elements
   #
   # === :root
@@ -47,8 +45,12 @@ module Kramdown
   # :abbrev_defs:: This key may be used to store the mapping of abbreviation to abbreviation
   #                definition.
   #
+  # :abbrev_attr:: This key may be used to store the mapping of abbreviation to abbreviation
+  #                attributes.
+  #
   # :options:: This key may be used to store options that were set during parsing of the document.
   #
+  # :footnote_count:: This key stores the number of actually referenced footnotes of the document.
   #
   # === :blank
   #
@@ -105,6 +107,10 @@ module Kramdown
   #
   # The +value+ field has to contain the content of the code block.
   #
+  # The option :lang specifies a highlighting language with possible HTML style options (e.g.
+  # php?start_inline=1) and should be used instead of a possibly also available language embedded in
+  # a class name of the form 'language-LANG'.
+  #
   #
   # === :ul
   #
@@ -126,7 +132,7 @@ module Kramdown
   #
   # === :li
   #
-  # [Category] None
+  # [Category] Block-level element
   # [Usage context] Inside :ol and :ul elements
   # [Content model] Block-level elements
   #
@@ -147,7 +153,7 @@ module Kramdown
   #
   # === :dt
   #
-  # [Category] None
+  # [Category] Block-level element
   # [Usage context] Before :dt or :dd elements inside a :dl elment
   # [Content model] Span-level elements
   #
@@ -156,7 +162,7 @@ module Kramdown
   #
   # === :dd
   #
-  # [Category] None
+  # [Category] Block-level element
   # [Usage context] After :dt or :dd elements inside a :dl elment
   # [Content model] Block-level elements
   #
@@ -224,7 +230,7 @@ module Kramdown
   #
   # === :td
   #
-  # [Category] None
+  # [Category] Block-level element
   # [Usage context] Inside :tr elements
   # [Content model] As child of :thead/:tr span-level elements, as child of :tbody/:tr and
   #                 :tfoot/:tr block-level elements
@@ -472,6 +478,7 @@ module Kramdown
   #
   # The option :type can be set to an array of strings to define for which converters the raw string
   # is valid.
+  #
   class Element
 
     # A symbol representing the element type. For example, :p or :blockquote.
@@ -484,17 +491,16 @@ module Kramdown
     # The child elements of this element.
     attr_accessor :children
 
-
     # Create a new Element object of type +type+. The optional parameters +value+, +attr+ and
     # +options+ can also be set in this constructor for convenience.
     def initialize(type, value = nil, attr = nil, options = nil)
-      @type, @value, @attr, @options = type, value, (Utils::OrderedHash.new.merge!(attr) if attr), options
+      @type, @value, @attr, @options = type, value, attr, options
       @children = []
     end
 
-    # The attributes of the element. Uses an Utils::OrderedHash to retain the insertion order.
+    # The attributes of the element.
     def attr
-      @attr ||= Utils::OrderedHash.new
+      @attr ||= {}
     end
 
     # The options hash for the element. It is used for storing arbitray options.
@@ -503,13 +509,18 @@ module Kramdown
     end
 
     def inspect #:nodoc:
-      "<kd:#{@type}#{@value.nil? ? '' : ' ' + @value.inspect} #{@attr.inspect}#{options.empty? ? '' : ' ' + @options.inspect}#{@children.empty? ? '' : ' ' + @children.inspect}>"
+      "<kd:#{@type}" \
+        "#{value.nil? ? '' : ' value=' + value.inspect}" \
+        "#{attr.empty? ? '' : ' attr=' + attr.inspect}" \
+        "#{options.empty? ? '' : ' options=' + options.inspect}" \
+        "#{children.empty? ? '' : ' children=' + children.inspect}>"
     end
 
     CATEGORY = {} # :nodoc:
-    [:blank, :p, :header, :blockquote, :codeblock, :ul, :ol, :dl, :table, :hr].each {|b| CATEGORY[b] = :block}
+    [:blank, :p, :header, :blockquote, :codeblock, :ul, :ol, :li, :dl, :dt, :dd,
+     :table, :td, :hr].each {|b| CATEGORY[b] = :block }
     [:text, :a, :br, :img, :codespan, :footnote, :em, :strong, :entity, :typographic_sym,
-     :smart_quote, :abbreviation].each {|b| CATEGORY[b] = :span}
+     :smart_quote, :abbreviation].each {|b| CATEGORY[b] = :span }
 
     # Return the category of +el+ which can be :block, :span or +nil+.
     #
@@ -519,6 +530,22 @@ module Kramdown
       CATEGORY[el.type] || el.options[:category]
     end
 
+    # syntactic sugar to simplify calls such as +Kramdown::Element.category(el) == :block+ with
+    # +el.block?+.
+    #
+    # Returns boolean true or false.
+    def block?
+      (CATEGORY[type] || options[:category]) == :block
+    end
+
+    # syntactic sugar to simplify calls such as +Kramdown::Element.category(el) == :span+ with
+    # +el.span?+.
+    #
+    # Returns boolean true or false.
+    def span?
+      (CATEGORY[type] || options[:category]) == :span
+    end
+
   end
 
 end

data/lib/kramdown/error.rb

@@ -1,22 +1,9 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 

data/lib/kramdown/options.rb

@@ -1,22 +1,9 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
@@ -61,8 +48,9 @@ module Kramdown
     # suffices. A block needs to be specified when using type 'Object' and it has to cope with
     # a value given as string and as the opaque type.
     def self.define(name, type, default, desc, &block)
-      raise ArgumentError, "Option name #{name} is already used" if @options.has_key?(name)
-      raise ArgumentError, "Invalid option type #{type} specified" if !ALLOWED_TYPES.include?(type)
+      name = name.to_sym
+      raise ArgumentError, "Option name #{name} is already used" if @options.key?(name)
+      raise ArgumentError, "Invalid option type #{type} specified" unless ALLOWED_TYPES.include?(type)
       raise ArgumentError, "Invalid type for default value" if !(type === default) && !default.nil?
       raise ArgumentError, "Missing validator block" if type == Object && block.nil?
       @options[name] = Definition.new(name, type, default, desc, block)
@@ -75,13 +63,13 @@ module Kramdown
 
     # Return +true+ if an option called +name+ is defined.
     def self.defined?(name)
-      @options.has_key?(name)
+      @options.key?(name.to_sym)
     end
 
     # Return a Hash with the default values for all options.
     def self.defaults
       temp = {}
-      @options.each {|n, o| temp[o.name] = o.default}
+      @options.each {|_n, o| temp[o.name] = o.default }
       temp
     end
 
@@ -89,9 +77,9 @@ module Kramdown
     # names are considered and their value is run through the #parse method.
     def self.merge(hash)
       temp = defaults
-      hash.each do |k,v|
-        next unless @options.has_key?(k)
-        temp[k] = parse(k, v)
+      hash.each do |k, v|
+        k = k.to_sym
+        temp[k] = @options.key?(k) ? parse(k, v) : v
       end
       temp
     end
@@ -102,8 +90,9 @@ module Kramdown
     # If +data+ already has the correct type, it is just returned. Otherwise it is converted to a
     # String and then to the correct type.
     def self.parse(name, data)
-      raise ArgumentError, "No option named #{name} defined" if !@options.has_key?(name)
-      if !(@options[name].type === data)
+      name = name.to_sym
+      raise ArgumentError, "No option named #{name} defined" unless @options.key?(name)
+      unless @options[name].type === data
         data = data.to_s
         data = if @options[name].type == String
                  data
@@ -112,9 +101,7 @@ module Kramdown
                elsif @options[name].type == Float
                  Float(data) rescue raise Kramdown::Error, "Invalid float value for option '#{name}': '#{data}'"
                elsif @options[name].type == Symbol
-                 data.strip!
-                 data = data[1..-1] if data[0] == ?:
-                 (data.empty? || data == 'nil' ? nil : data.to_sym)
+                 str_to_sym(data)
                elsif @options[name].type == Boolean
                  data.downcase.strip != 'false' && !data.empty?
                end
@@ -123,6 +110,17 @@ module Kramdown
       data
     end
 
+    # Converts the given String +data+ into a Symbol or +nil+ with the
+    # following provisions:
+    #
+    # - A leading colon is stripped from the string.
+    # - An empty value or a value equal to "nil" results in +nil+.
+    def self.str_to_sym(data)
+      data = data.strip
+      data = data[1..-1] if data[0] == ':'
+      (data.empty? || data == 'nil' ? nil : data.to_sym)
+    end
+
     # ----------------------------
     # :section: Option Validators
     #
@@ -135,19 +133,36 @@ module Kramdown
     # - a comma separated string which is split into an array of values
     # - or an array.
     #
-    # Additionally, the array is checked for the correct size.
-    def self.simple_array_validator(val, name, size)
+    # Optionally, the array is checked for the correct size.
+    def self.simple_array_validator(val, name, size = nil)
       if String === val
         val = val.split(/,/)
       elsif !(Array === val)
         raise Kramdown::Error, "Invalid type #{val.class} for option #{name}"
       end
-      if val.size != size
+      if size && val.size != size
         raise Kramdown::Error, "Option #{name} needs exactly #{size} values"
       end
       val
     end
 
+    # Ensures that the option value +val+ for the option called +name+ is a valid hash. The
+    # parameter +val+ can be
+    #
+    # - a hash in YAML format
+    # - or a Ruby Hash object.
+    def self.simple_hash_validator(val, name)
+      if String === val
+        begin
+          val = YAML.safe_load(val)
+        rescue RuntimeError, ArgumentError, SyntaxError
+          raise Kramdown::Error, "Invalid YAML value for option #{name}"
+        end
+      end
+      raise Kramdown::Error, "Invalid type #{val.class} for option #{name}" unless Hash === val
+      val
+    end
+
     # ----------------------------
     # :section: Option Definitions
     #
@@ -155,109 +170,134 @@ module Kramdown
     # parsers/converters.
     # ----------------------------
 
-    define(:template, String, '', <<EOF)
-The name of an ERB template file that should be used to wrap the output
+    define(:template, String, '', <<~EOF)
+      The name of an ERB template file that should be used to wrap the output
+      or the ERB template itself.
 
-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.
+      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.
 
-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).
+      When resolving the template file, the given template name is used first.
+      If such a file is not found, the converter extension (the same as the
+      converter name) 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). If the file is still not
+      found, the template name is checked if it starts with 'string://' and if
+      it does, this prefix is removed and the rest is used as template
+      content.
 
-kramdown provides a default template named 'document' for each converter.
+      kramdown provides a default template named 'document' for each converter.
 
-Default: ''
-Used by: all converters
-EOF
+      Default: ''
+      Used by: all converters
+    EOF
 
-    define(:auto_ids, Boolean, true, <<EOF)
-Use automatic header ID generation
+    define(:auto_ids, Boolean, true, <<~EOF)
+      Use automatic header ID generation
 
-If this option is `true`, ID values for all headers are automatically
-generated if no ID is explicitly specified.
+      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
-EOF
+      Default: true
+      Used by: HTML/Latex converter
+    EOF
 
-    define(:auto_id_prefix, String, '', <<EOF)
-Prefix used for automatically generated heaer IDs
+    define(:auto_id_stripping, Boolean, false, <<~EOF)
+      Strip all formatting from header text for automatic ID generation
 
-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!
+      If this option is `true`, only the text elements of a header are used
+      for generating the ID later (in contrast to just using the raw header
+      text line).
 
-Default: ''
-Used by: HTML/Latex converter
-EOF
+      This option will be removed in version 2.0 because this will be the
+      default then.
 
-    define(:parse_block_html, Boolean, false, <<EOF)
-Process kramdown syntax in block HTML tags
+      Default: false
+      Used by: kramdown parser
+    EOF
 
-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.
+    define(:auto_id_prefix, String, '', <<~EOF)
+      Prefix used for automatically generated header IDs
 
-Default: false
-Used by: kramdown parser
-EOF
+      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!
 
-    define(:parse_span_html, Boolean, true, <<EOF)
-Process kramdown syntax in span HTML tags
+      Default: ''
+      Used by: HTML/Latex converter
+    EOF
 
-If this option is `true`, the kramdown parser processes the content of
-span HTML tags as text containing span-level elements.
+    define(:transliterated_header_ids, Boolean, false, <<~EOF)
+      Transliterate the header text before generating the ID
 
-Default: true
-Used by: kramdown parser
-EOF
+      Only ASCII characters are used in headers IDs. This is not good for
+      languages with many non-ASCII characters. By enabling this option
+      the header text is transliterated to ASCII as good as possible so that
+      the resulting header ID is more useful.
 
-    define(:html_to_native, Boolean, false, <<EOF)
-Convert HTML elements to native elements
+      The stringex library needs to be installed for this feature to work!
 
-If this option is `true`, the parser converts HTML elements to native
-elements. For example, when parsing `<em>hallo</em>` the emphasis tag
-would normally be converted to an `:html` element with tag type `:em`.
-If `html_to_native` is `true`, then the emphasis would be converted to a
-native `:em` element.
+      Default: false
+      Used by: HTML/Latex converter
+    EOF
 
-This is useful for converters that cannot deal with HTML elements.
+    define(:parse_block_html, Boolean, false, <<~EOF)
+      Process kramdown syntax in block HTML tags
 
-Default: false
-Used by: kramdown parser
-EOF
+      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.
 
-    define(:link_defs, Object, {}, <<EOF) do |val|
-Pre-defines link definitions
+      Default: false
+      Used by: kramdown parser
+    EOF
 
-This option can be used to pre-define link definitions. The value needs
-to be a Hash where the keys are the link identifiers and the values are
-two element Arrays with the link URL and the link title.
+    define(:parse_span_html, Boolean, true, <<~EOF)
+      Process kramdown syntax in span HTML tags
 
-If the value is a String, it has to contain a valid YAML hash and the
-hash has to follow the above guidelines.
+      If this option is `true`, the kramdown parser processes the content of
+      span HTML tags as text containing span-level elements.
 
-Default: {}
-Used by: kramdown parser
-EOF
-      if String === val
-        begin
-          val = YAML.load(val)
-        rescue RuntimeError, ArgumentError, SyntaxError
-          raise Kramdown::Error, "Invalid YAML value for option link_defs"
-        end
-      end
-      raise Kramdown::Error, "Invalid type #{val.class} for option #{name}" if !(Hash === val)
-      val.each do |k,v|
-        if !(Array === v) || v.size > 2 || v.size < 1
+      Default: true
+      Used by: kramdown parser
+    EOF
+
+    define(:html_to_native, Boolean, false, <<~EOF)
+      Convert HTML elements to native elements
+
+      If this option is `true`, the parser converts HTML elements to native
+      elements. For example, when parsing `<em>hallo</em>` the emphasis tag
+      would normally be converted to an `:html` element with tag type `:em`.
+      If `html_to_native` is `true`, then the emphasis would be converted to a
+      native `:em` element.
+
+      This is useful for converters that cannot deal with HTML elements.
+
+      Default: false
+      Used by: kramdown parser
+    EOF
+
+    define(:link_defs, Object, {}, <<~EOF) do |val|
+      Pre-defines link definitions
+
+      This option can be used to pre-define link definitions. The value needs
+      to be a Hash where the keys are the link identifiers and the values are
+      two element Arrays with the link URL and the link title.
+
+      If the value is a String, it has to contain a valid YAML hash and the
+      hash has to follow the above guidelines.
+
+      Default: {}
+      Used by: kramdown parser
+    EOF
+      val = simple_hash_validator(val, :link_defs)
+      val.each do |_k, v|
+        if !(Array === v) || v.size > 2 || v.empty?
           raise Kramdown::Error, "Invalid structure for hash value of option #{name}"
         end
         v << nil if v.size == 1
@@ -265,194 +305,299 @@ EOF
       val
     end
 
-    define(:footnote_nr, Integer, 1, <<EOF)
-The number of the first footnote
+    define(:footnote_nr, Integer, 1, <<~EOF)
+      The number of the first footnote
 
-This option can be used to specify the number that is used for the first
-footnote.
+      This option can be used to specify the number that is used for the first
+      footnote.
 
-Default: 1
-Used by: HTML converter
-EOF
+      Default: 1
+      Used by: HTML converter
+    EOF
 
-    define(:enable_coderay, Boolean, true, <<EOF)
-Use coderay for syntax highlighting
+    define(:entity_output, Symbol, :as_char, <<~EOF)
+      Defines how entities are output
 
-If this option is `true`, coderay is used by the HTML converter for
-syntax highlighting the content of code spans and code blocks.
+      The possible values are :as_input (entities are output in the same
+      form as found in the input), :numeric (entities are output in numeric
+      form), :symbolic (entities are output in symbolic form if possible) or
+      :as_char (entities are output as characters if possible, only available
+      on Ruby 1.9).
 
-Default: true
-Used by: HTML converter
-EOF
+      Default: :as_char
+      Used by: HTML converter, kramdown converter
+    EOF
 
-    define(:coderay_wrap, Symbol, :div, <<EOF)
-Defines how the highlighted code should be wrapped
+    TOC_LEVELS_RANGE = (1..6).freeze
+    TOC_LEVELS_ARRAY = TOC_LEVELS_RANGE.to_a.freeze
+    private_constant :TOC_LEVELS_RANGE, :TOC_LEVELS_ARRAY
 
-The possible values are :span, :div or nil.
+    define(:toc_levels, Object, TOC_LEVELS_ARRAY, <<~EOF) do |val|
+      Defines the levels that are used for the table of contents
 
-Default: :div
-Used by: HTML converter
-EOF
+      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.
 
-    define(:coderay_line_numbers, Symbol, :inline, <<EOF)
-Defines how and if line numbers should be shown
+      Default: 1..6
+      Used by: HTML/Latex converter
+    EOF
+      case val
+      when String
+        if val =~ /^(\d)\.\.(\d)$/
+          val = Range.new($1.to_i, $2.to_i).to_a
+        elsif val =~ /^\d(?:,\d)*$/
+          val = val.split(/,/).map(&:to_i).uniq
+        else
+          raise Kramdown::Error, "Invalid syntax for option toc_levels"
+        end
+      when Array
+        unless val.eql?(TOC_LEVELS_ARRAY)
+          val = val.map(&:to_i).uniq
+        end
+      when Range
+        if val.eql?(TOC_LEVELS_RANGE)
+          val = TOC_LEVELS_ARRAY
+        else
+          val = val.map(&:to_i).uniq
+        end
+      else
+        raise Kramdown::Error, "Invalid type #{val.class} for option toc_levels"
+      end
+      if val.any? {|i| !TOC_LEVELS_RANGE.cover?(i) }
+        raise Kramdown::Error, "Level numbers for option toc_levels have to be integers from 1 to 6"
+      end
+      val
+    end
 
-The possible values are :table, :inline or nil. If this option is
-nil, no line numbers are shown.
+    define(:line_width, Integer, 72, <<~EOF)
+      Defines the line width to be used when outputting a document
 
-Default: :inline
-Used by: HTML converter
-EOF
+      Default: 72
+      Used by: kramdown converter
+    EOF
 
-    define(:coderay_line_number_start, Integer, 1, <<EOF)
-The start value for the line numbers
+    define(:latex_headers, Object, %w[section subsection subsubsection paragraph subparagraph subparagraph], <<~EOF) do |val|
+      Defines the LaTeX commands for different header levels
 
-Default: 1
-Used by: HTML converter
-EOF
+      The commands for the header levels one to six can be specified by
+      separating them with commas.
 
-    define(:coderay_tab_width, Integer, 8, <<EOF)
-The tab width used in highlighted code
+      Default: section,subsection,subsubsection,paragraph,subparagraph,subparagraph
+      Used by: Latex converter
+    EOF
+      simple_array_validator(val, :latex_headers, 6)
+    end
 
-Used by: HTML converter
-EOF
+    SMART_QUOTES_ENTITIES = %w[lsquo rsquo ldquo rdquo].freeze
+    SMART_QUOTES_STR = SMART_QUOTES_ENTITIES.join(',').freeze
+    private_constant :SMART_QUOTES_ENTITIES, :SMART_QUOTES_STR
 
-    define(:coderay_bold_every, Integer, 10, <<EOF)
-Defines how often a line number should be made bold
+    define(:smart_quotes, Object, SMART_QUOTES_ENTITIES, <<~EOF) do |val|
+      Defines the HTML entity names or code points for smart quote output
 
-Default: 10
-Used by: HTML converter
-EOF
+      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.
 
-    define(:coderay_css, Symbol, :style, <<EOF)
-Defines how the highlighted code gets styled
+      Default: lsquo,rsquo,ldquo,rdquo
+      Used by: HTML/Latex converter
+    EOF
+      if val == SMART_QUOTES_STR || val == SMART_QUOTES_ENTITIES
+        SMART_QUOTES_ENTITIES
+      else
+        val = simple_array_validator(val, :smart_quotes, 4)
+        val.map! {|v| Integer(v) rescue v }
+        val
+      end
+    end
 
-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).
+    define(:typographic_symbols, Object, {}, <<~EOF) do |val|
+      Defines a mapping from typographical symbol to output characters
+
+      Typographical symbols are normally output using their equivalent Unicode
+      codepoint. However, sometimes one wants to change the output, mostly to
+      fallback to a sequence of ASCII characters.
+
+      This option allows this by specifying a mapping from typographical
+      symbol to its output string. For example, the mapping {hellip: ...} would
+      output the standard ASCII representation of an ellipsis.
+
+      The available typographical symbol names are:
+
+      * hellip: ellipsis
+      * mdash: em-dash
+      * ndash: en-dash
+      * laquo: left guillemet
+      * raquo: right guillemet
+      * laquo_space: left guillemet followed by a space
+      * raquo_space: right guillemet preceeded by a space
+
+      Default: {}
+      Used by: HTML/Latex converter
+    EOF
+      val = simple_hash_validator(val, :typographic_symbols)
+      val.keys.each do |k|
+        val[k.kind_of?(String) ? str_to_sym(k) : k] = val.delete(k).to_s
+      end
+      val
+    end
 
-Default: style
-Used by: HTML converter
-EOF
+    define(:remove_block_html_tags, Boolean, true, <<~EOF)
+      Remove block HTML tags
 
-    define(:coderay_default_lang, Symbol, nil, <<EOF)
-Sets the default language for highlighting code blocks
+      If this option is `true`, the RemoveHtmlTags converter removes
+      block HTML tags.
 
-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: true
+      Used by: RemoveHtmlTags converter
+    EOF
 
-Default: nil
-Used by: HTML converter
-EOF
+    define(:remove_span_html_tags, Boolean, false, <<~EOF)
+      Remove span HTML tags
 
-    define(:entity_output, Symbol, :as_char, <<EOF)
-Defines how entities are output
+      If this option is `true`, the RemoveHtmlTags converter removes
+      span HTML tags.
 
-The possible values are :as_input (entities are output in the same
-form as found in the input), :numeric (entities are output in numeric
-form), :symbolic (entities are output in symbolic form if possible) or
-:as_char (entities are output as characters if possible, only available
-on Ruby 1.9).
+      Default: false
+      Used by: RemoveHtmlTags converter
+    EOF
 
-Default: :as_char
-Used by: HTML converter, kramdown converter
-EOF
+    define(:header_offset, Integer, 0, <<~EOF)
+      Sets the output offset for headers
 
-    define(:toc_levels, Object, (1..6).to_a, <<EOF) do |val|
-Defines the levels that are used for the table of contents
+      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.
 
-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: 0
+      Used by: HTML converter, Kramdown converter, Latex converter
+    EOF
 
-Default: 1..6
-Used by: HTML/Latex converter
-EOF
-      if String === val
-        if val =~ /^(\d)\.\.(\d)$/
-          val = Range.new($1.to_i, $2.to_i).to_a
-        elsif val =~ /^\d(?:,\d)*$/
-          val = val.split(/,/).map {|s| s.to_i}.uniq
-        else
-          raise Kramdown::Error, "Invalid syntax for option toc_levels"
-        end
-      elsif Array === val
-        val = val.map {|s| s.to_i}.uniq
-      else
-        raise Kramdown::Error, "Invalid type #{val.class} for option toc_levels"
-      end
-      if val.any? {|i| !(1..6).include?(i)}
-        raise Kramdown::Error, "Level numbers for option toc_levels have to be integers from 1 to 6"
+    define(:syntax_highlighter, Symbol, :rouge, <<~EOF)
+      Set the syntax highlighter
+
+      Specifies the syntax highlighter that should be used for highlighting
+      code blocks and spans. If this option is set to +nil+, no syntax
+      highlighting is done.
+
+      Options for the syntax highlighter can be set with the
+      syntax_highlighter_opts configuration option.
+
+      Default: rouge
+      Used by: HTML/Latex converter
+    EOF
+
+    define(:syntax_highlighter_opts, Object, {}, <<~EOF) do |val|
+      Set the syntax highlighter options
+
+      Specifies options for the syntax highlighter set via the
+      syntax_highlighter configuration option.
+
+      The value needs to be a hash with key-value pairs that are understood by
+      the used syntax highlighter.
+
+      Default: {}
+      Used by: HTML/Latex converter
+    EOF
+      val = simple_hash_validator(val, :syntax_highlighter_opts)
+      val.keys.each do |k|
+        val[k.kind_of?(String) ? str_to_sym(k) : k] = val.delete(k)
       end
       val
     end
 
-    define(:line_width, Integer, 72, <<EOF)
-Defines the line width to be used when outputting a document
+    define(:math_engine, Symbol, :mathjax, <<~EOF)
+      Set the math engine
 
-Default: 72
-Used by: kramdown converter
-EOF
+      Specifies the math engine that should be used for converting math
+      blocks/spans. If this option is set to +nil+, no math engine is used and
+      the math blocks/spans are output as is.
 
-    define(:latex_headers, Object, %w{section subsection subsubsection paragraph subparagraph subparagraph}, <<EOF) do |val|
-Defines the LaTeX commands for different header levels
+      Options for the selected math engine can be set with the
+      math_engine_opts configuration option.
 
-The commands for the header levels one to six can be specified by
-separating them with commas.
+      Default: mathjax
+      Used by: HTML converter
+    EOF
 
-Default: section,subsection,subsubsection,paragraph,subparagraph,subparagraph
-Used by: Latex converter
-EOF
-      simple_array_validator(val, :latex_headers, 6)
-    end
+    define(:math_engine_opts, Object, {}, <<~EOF) do |val|
+      Set the math engine options
 
-    define(:smart_quotes, Object, %w{lsquo rsquo ldquo rdquo}, <<EOF) do |val|
-Defines the HTML entity names or code points for smart quote output
+      Specifies options for the math engine set via the math_engine
+      configuration option.
 
-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.
+      The value needs to be a hash with key-value pairs that are understood by
+      the used math engine.
 
-Default: lsquo,rsquo,ldquo,rdquo
-Used by: HTML/Latex converter
-EOF
-      val = simple_array_validator(val, :smart_quotes, 4)
-      val.map! {|v| Integer(v) rescue v}
+      Default: {}
+      Used by: HTML converter
+    EOF
+      val = simple_hash_validator(val, :math_engine_opts)
+      val.keys.each do |k|
+        val[k.kind_of?(String) ? str_to_sym(k) : k] = val.delete(k)
+      end
       val
     end
 
-    define(:remove_block_html_tags, Boolean, true, <<EOF)
-Remove block HTML tags
+    define(:footnote_backlink, String, '&#8617;', <<~EOF)
+      Defines the text that should be used for the footnote backlinks
+
+      The footnote backlink is just text, so any special HTML characters will
+      be escaped.
+
+      If the footnote backlint text is an empty string, no footnote backlinks
+      will be generated.
 
-If this option is `true`, the RemoveHtmlTags converter removes
-block HTML tags.
+      Default: '&8617;'
+      Used by: HTML converter
+    EOF
 
-Default: true
-Used by: RemoveHtmlTags converter
-EOF
+    define(:footnote_backlink_inline, Boolean, false, <<~EOF)
+      Specifies whether the footnote backlink should always be inline
 
-    define(:remove_span_html_tags, Boolean, false, <<EOF)
-Remove span HTML tags
+      With the default of false the footnote backlink is placed at the end of
+      the last paragraph if there is one, or an extra paragraph with only the
+      footnote backlink is created.
 
-If this option is `true`, the RemoveHtmlTags converter removes
-span HTML tags.
+      Setting this option to true tries to place the footnote backlink in the
+      last, possibly nested paragraph or header. If this fails (e.g. in the
+      case of a table), an extra paragraph with only the footnote backlink is
+      created.
 
-Default: false
-Used by: RemoveHtmlTags converter
-EOF
+      Default: false
+      Used by: HTML converter
+    EOF
 
-    define(:header_offset, Integer, 0, <<EOF)
-Sets the output offset for headers
+    define(:footnote_prefix, String, '', <<~EOF)
+      Prefix used for footnote IDs
 
-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.
+      This option can be used to set a prefix for footnote IDs. This is useful
+      when rendering multiple documents into the same output file to avoid
+      duplicate IDs. The prefix should only contain characters that are valid
+      in an ID!
 
-Default: 0
-Used by: HTML converter, Kramdown converter, Latex converter
-EOF
+      Default: ''
+      Used by: HTML
+    EOF
+
+    define(:remove_line_breaks_for_cjk, Boolean, false, <<~EOF)
+      Specifies whether line breaks should be removed between CJK characters
+
+      Default: false
+      Used by: HTML converter
+    EOF
+
+    define(:forbidden_inline_options, Object, %w[template], <<~EOF) do |val|
+      Defines the options that may not be set using the {::options} extension
+
+      Default: template
+      Used by: HTML converter
+    EOF
+      val.map! {|item| item.kind_of?(String) ? str_to_sym(item) : item }
+      simple_array_validator(val, :forbidden_inline_options)
+    end
 
   end