class Asciidoctor::Block
> “This is a <test>”
block.content
block = Asciidoctor::Block.new(parent, :paragraph, :source => ‘This is a <test>’)
Examples
Public: Methods for managing blocks of Asciidoc content in a section.¶ ↑
def content
block.content
:source => '_This_ is what happens when you
block = Asciidoctor::Block.new(doc, :paragraph,
doc = Asciidoctor::Document.new
Examples
children appropriate to content model that this block supports.
Public: Get the converted result of the child blocks by converting the
def content case @content_model when :compound super when :simple apply_subs(@lines * EOL, @subs) when :verbatim, :raw #((apply_subs @lines.join(EOL), @subs).sub StripLineWiseRx, '\1') # QUESTION could we use strip here instead of popping empty lines? # maybe apply_subs can know how to strip whitespace? result = apply_subs @lines, @subs if result.size < 2 result[0] else result.shift while (first = result[0]) && first.rstrip.empty? result.pop while (last = result[-1]) && last.rstrip.empty? result * EOL end else warn %(Unknown content model '#{@content_model}' for block: #{to_s}) unless @content_model == :empty nil end end
def initialize parent, context, opts = {}
--
override the default subs using the `:default_subs` option.
default subs for a block, pass the option `:subs => :default`. You can
default substitutions based on this block's context). If you want to use the
block (which are resolved from the `subs` attribute, if specified, or the
the `lock_in_subs` method to resolve and assign the substitutions to this
IMPORTANT: If you don't specify the `:subs` option, you must explicitly call
* :source a String or Array of raw source for this Block. (default: nil)
* :attributes a Hash of attributes (key/value pairs) to assign to this Block. (default: {})
how the lines should be processed (:simple, :verbatim, :raw, :empty). (default: :simple)
* :content_model indicates whether blocks can be nested in this Block (:compound), otherwise
opts - a Hash of options to customize block initialization: (default: {})
context - The Symbol context name for the type of content (e.g., :paragraph).
parent - The parent AbstractBlock with a compound content model to which this Block will be appended.
Public: Initialize an Asciidoctor::Block object.
def initialize parent, context, opts = {} super @content_model = opts[:content_model] || DEFAULT_CONTENT_MODEL[context] if opts.key? :subs # FIXME feels funky; we have to be defensive to get lock_in_subs to honor override # FIXME does not resolve substitution groups inside Array (e.g., [:normal]) if (subs = opts[:subs]) # e.g., :subs => :defult # subs attribute is honored; falls back to opts[:default_subs], then built-in defaults based on context if subs == :default @default_subs = opts[:default_subs] # e.g., :subs => [:quotes] # subs attribute is not honored elsif ::Array === subs @default_subs = subs.dup @attributes.delete 'subs' # e.g., :subs => :normal or :subs => 'normal' # subs attribute is not honored else @default_subs = nil # interpolation is the fastest way to dup subs as a string @attributes['subs'] = %(#{subs}) end # resolve the subs eagerly only if subs option is specified lock_in_subs # e.g., :subs => nil else @subs = [] # prevent subs from being resolved @default_subs = [] @attributes.delete 'subs' end # defer subs resolution; subs attribute is honored else @subs = [] # QUESTION should we honor :default_subs option (i.e., @default_subs = opts[:default_subs])? @default_subs = nil end if (raw_source = opts[:source]).nil_or_empty? @lines = [] elsif ::String === raw_source @lines = Helpers.normalize_lines_from_string raw_source else @lines = raw_source.dup end end
def source
Returns the a String containing the lines joined together or nil if there
Public: Returns the preprocessed source of this block
def source @lines * EOL end
def to_s
def to_s content_summary = @content_model == :compound ? %(blocks: #{@blocks.size}) : %(lines: #{@lines.size}) %(#<#{self.class}@#{object_id} {context: #{@context.inspect}, content_model: #{@content_model.inspect}, style: #{@style.inspect}, #{content_summary}}>) end