class Srx::Format::BaseFormat
Interface definition for format support
Public Instance Methods
end_formatting?(markup)
click to toggle source
@abstract @param markup [String] @return [Boolean]
# File lib/srx/format/base_format.rb, line 26 def end_formatting?(markup) raise(NotImplementedError) end
extract_markups(str)
click to toggle source
@abstract @param str [String] @return [Array(String,Array<Array(Integer,String)>)] two items: 1) input
+str+ with markups removed, and 2) a list of markups, i.e. +[pos, string]+ pairs
# File lib/srx/format/base_format.rb, line 12 def extract_markups(str) raise(NotImplementedError) end
isolated_formatting?(markup)
click to toggle source
@abstract @param markup [String] @return [Boolean]
# File lib/srx/format/base_format.rb, line 33 def isolated_formatting?(markup) raise(NotImplementedError) end
start_formatting?(markup)
click to toggle source
@abstract @param markup [String] @return [Boolean]
# File lib/srx/format/base_format.rb, line 19 def start_formatting?(markup) raise(NotImplementedError) end