module Kramdown::Utils::Html
Provides convenience methods for HTML related tasks.
Note that this module has to be mixed into a class that has a @root (containing an element of type :root) and an @options (containing an options hash) instance variable so that some of the methods can work correctly.
Constants
- REDUNDANT_LINE_BREAK_REGEX
Public Instance Methods
Convert the entity e
to a string. The optional parameter original
may contain the original representation of the entity.
This method uses the option entity_output
to determine the output form for the entity.
# File lib/kramdown/utils/html.rb 26 def entity_to_str(e, original = nil) 27 entity_output = @options[:entity_output] 28 29 if entity_output == :as_char && 30 (c = e.char.encode(@root.options[:encoding]) rescue nil) && 31 ((c = e.char) == '"' || !ESCAPE_MAP.key?(c)) 32 c 33 elsif (entity_output == :as_input || entity_output == :as_char) && original 34 original 35 elsif (entity_output == :symbolic || ESCAPE_MAP.key?(e.char)) && !e.name.nil? 36 "&#{e.name};" 37 else # default to :numeric 38 "&##{e.code_point};" 39 end 40 end
Escape the special HTML characters in the string str
. The parameter type
specifies what is escaped: :all - all special HTML characters except the quotation mark as well as entities, :text - all special HTML characters except the quotation mark but no entities and :attribute - all special HTML characters including the quotation mark but no entities.
# File lib/kramdown/utils/html.rb 68 def escape_html(str, type = :all) 69 str.gsub(ESCAPE_RE_FROM_TYPE[type]) {|m| ESCAPE_MAP[m] || m } 70 end
# File lib/kramdown/utils/html.rb 73 def fix_cjk_line_break(str) 74 while str.gsub!(REDUNDANT_LINE_BREAK_REGEX, '\1\2') 75 end 76 str 77 end
Return the HTML representation of the attributes attr
.
# File lib/kramdown/utils/html.rb 43 def html_attributes(attr) 44 return '' if attr.empty? 45 46 attr.map do |k, v| 47 v.nil? || (k == 'id' && v.strip.empty?) ? '' : " #{k}=\"#{escape_html(v.to_s, :attribute)}\"" 48 end.join('') 49 end