Class: Asciidoctor::AbstractBlock

Inherits:

AbstractNode

• Object
• AbstractNode
• Asciidoctor::AbstractBlock

Defined in:

lib/asciidoctor/abstract_block.rb

Direct Known Subclasses

Block, Document, List, ListItem, Section, Table, Table::Cell

Constant Summary

Constants included from Substitutors

Substitutors::CAN, Substitutors::CGI, Substitutors::DEL, Substitutors::ESC_R_SB, Substitutors::HighlightedPassSlotRx, Substitutors::PASS_END, Substitutors::PASS_START, Substitutors::PLUS, Substitutors::PassSlotRx, Substitutors::QuotedTextSniffRx, Substitutors::RS, Substitutors::R_SB, Substitutors::SUB_GROUPS, Substitutors::SUB_HINTS, Substitutors::SUB_OPTIONS, Substitutors::SpecialCharsRx, Substitutors::SpecialCharsTr

Instance Attribute Summary

• #blocks ⇒ Object readonly

  Get the Array of AbstractBlock child blocks for this block.

• #caption ⇒ String

  Gets the caption for this block.

• #content_model ⇒ Object

  Describes the type of content this block accepts and how it should be converted.

• #level ⇒ Object

  Set the Integer level of this Section or the level of the Section to which this AbstractBlock belongs.

• #numeral ⇒ Object

  Get/Set the String numeral of this block (if section, relative to parent, otherwise absolute).

• #source_location ⇒ Object

  Gets/Sets the location in the AsciiDoc source where this block begins.

• #style ⇒ Object

  Get/Set the String style (block type qualifier) for this block.

• #subs ⇒ Object readonly

  Substitutions to be applied to content in this block.

Attributes inherited from AbstractNode

#attributes, #context, #document, #id, #node_name, #parent

Instance Method Summary

• #<<(block) ⇒ The (also: #append)

  Append a content block to this block's list of blocks.

• #alt ⇒ String

  Returns the converted alt text for this block image.

• #assign_caption(value, caption_context = @context) ⇒ void

  Generate and assign caption to block if not already assigned.

• #block? ⇒ Boolean
• #blocks? ⇒ A

  Determine whether this Block contains block content.

• #captioned_title ⇒ Object

  Convenience method that returns the interpreted title of the Block with the caption prepended.

• #content ⇒ Object

  Get the converted result of the child blocks by converting the children appropriate to content model that this block supports.

• #context=(context) ⇒ Object

  Update the context of this block.

• #convert ⇒ Object (also: #render)

  Get the converted String content for this Block.

• #file ⇒ Object

  Get the source file where this block started.

• #find_by(selector = {}, &block) ⇒ An (also: #query)

  Walk the document tree and find all block-level nodes that match the specified selector (context, style, id, role, and/or custom filter).

• #initialize(parent, context, opts = {}) ⇒ AbstractBlock constructor

  A new instance of AbstractBlock.

• #inline? ⇒ Boolean
• #lineno ⇒ Object

  Get the source line number where this block started.

• #list_marker_keyword(list_type = nil) ⇒ String

  Retrieve the list marker keyword for the specified list type.

• #next_adjacent_block ⇒ Object

  Move to the next adjacent block in document order.

• #number ⇒ Object deprecated Deprecated.

  Do not use this in new code, and replace it when updating old code.

• #number=(val) ⇒ Object deprecated Deprecated.

  Do not use this in new code, and replace it when updating old code.

• #remove_sub(sub) ⇒ void

  Remove a substitution from this block.

• #sections ⇒ Array

  Get the Array of child Section objects.

• #sections? ⇒ Boolean

  Check whether this block has any child Section objects.

• #sub?(name) ⇒ A

  A convenience method that checks whether the specified substitution is enabled for this block.

• #title ⇒ Object

  Get the String title of this Block with title substitutions applied.

• #title=(val) ⇒ Object

  Set the String block title.

• #title? ⇒ Boolean

  A convenience method that checks whether the title of this block is defined.

• #xreftext(xrefstyle = nil) ⇒ String

  Generate cross reference text (xreftext) that can be used to refer to this block.

Methods inherited from AbstractNode

#add_role, #attr, #attr?, #converter, #enabled_options, #generate_data_uri, #generate_data_uri_from_uri, #has_role?, #icon_uri, #image_uri, #is_uri?, #media_uri, #normalize_asset_path, #normalize_system_path, #normalize_web_path, #option?, #read_asset, #read_contents, #reftext, #reftext?, #remove_attr, #remove_role, #role, #role=, #role?, #roles, #set_attr, #set_option, #update_attributes

Methods included from Substitutors

#apply_header_subs, #apply_normal_subs, #apply_reftext_subs, #apply_subs, #expand_subs, #extract_passthroughs, #highlight_source, #resolve_block_subs, #resolve_lines_to_highlight, #resolve_pass_subs, #resolve_subs, #restore_passthroughs, #sub_attributes, #sub_callouts, #sub_macros, #sub_post_replacements, #sub_quotes, #sub_replacements, #sub_source, #sub_specialchars

Methods included from Logging

#logger, #message_with_context

Constructor Details

#initialize(parent, context, opts = {}) ⇒ AbstractBlock

Returns a new instance of AbstractBlock.

# File 'lib/asciidoctor/abstract_block.rb', line 36

def initialize parent, context, opts = {}
  super
  @content_model = :compound
  @blocks = []
  @subs = []
  @id = @title = @caption = @numeral = @style = @default_subs = @source_location = nil
  if context == :document || context == :section
    @level = @next_section_index = 0
    @next_section_ordinal = 1
  elsif AbstractBlock === parent
    @level = parent.level
  else
    @level = nil
  end
end

Instance Attribute Details

#blocks ⇒ Object (readonly)

Get the Array of Asciidoctor::AbstractBlock child blocks for this block. Only applies if content model is :compound.

# File 'lib/asciidoctor/abstract_block.rb', line 5

def blocks
  @blocks
end

#caption ⇒ String

Gets the caption for this block.

This method routes the deprecated use of the caption method on an admonition block to the textlabel attribute.

Returns:

• (String) —

  Returns the String caption for this block (or the value of the textlabel attribute if this is an admonition block).

# File 'lib/asciidoctor/abstract_block.rb', line 246

def caption
  @context == :admonition ? @attributes['textlabel'] : @caption
end

#content_model ⇒ Object

Describes the type of content this block accepts and how it should be converted. Acceptable values are:

• :compound - this block contains other blocks
• :simple - this block holds a paragraph of prose that receives normal substitutions
• :verbatim - this block holds verbatim text (displayed "as is") that receives verbatim substitutions
• :raw - this block holds unprocessed content passed directly to the output with no substitutions applied
• :empty - this block has no content

# File 'lib/asciidoctor/abstract_block.rb', line 16

def content_model
  @content_model
end

#level ⇒ Object

Set the Integer level of this Section or the level of the Section to which this Asciidoctor::AbstractBlock belongs.

# File 'lib/asciidoctor/abstract_block.rb', line 19

def level
  @level
end

#numeral ⇒ Object

Get/Set the String numeral of this block (if section, relative to parent, otherwise absolute). Only assigned to section if automatic section numbering is enabled. Only assigned to formal block (block with title) if corresponding caption attribute is present.

# File 'lib/asciidoctor/abstract_block.rb', line 24

def numeral
  @numeral
end

#source_location ⇒ Object

Gets/Sets the location in the AsciiDoc source where this block begins. Tracking source location is not enabled by default, and is controlled by the sourcemap option.

# File 'lib/asciidoctor/abstract_block.rb', line 28

def source_location
  @source_location
end

#style ⇒ Object

Get/Set the String style (block type qualifier) for this block.

# File 'lib/asciidoctor/abstract_block.rb', line 31

def style
  @style
end

#subs ⇒ Object (readonly)

Substitutions to be applied to content in this block.

# File 'lib/asciidoctor/abstract_block.rb', line 34

def subs
  @subs
end

Instance Method Details

#<<(block) ⇒ The Also known as: append

Append a content block to this block's list of blocks.

Examples:

block = Block.new(parent, :preamble, content_model: :compound)

block << Block.new(block, :paragraph, source: 'p1')
block << Block.new(block, :paragraph, source: 'p2')
block.blocks?
# => true
block.blocks.size
# => 2

Parameters:

• block —

  The new child block.

Returns:

• (The) —

  parent Block

# File 'lib/asciidoctor/abstract_block.rb', line 115

def << block
  block.parent = self unless block.parent == self
  @blocks << block
  self
end

#alt ⇒ String

Returns the converted alt text for this block image.

Returns:

• (String) —

  Returns the String value of the alt attribute with XML special character and replacement substitutions applied.

# File 'lib/asciidoctor/abstract_block.rb', line 226

def alt
  if (text = @attributes['alt'])
    if text == @attributes['default-alt']
      sub_specialchars text
    else
      text = sub_specialchars text
      (ReplaceableTextRx.match? text) ? (sub_replacements text) : text
    end
  else
    ''
  end
end

#assign_caption(value, caption_context = @context) ⇒ void

This method returns an undefined value.

Generate and assign caption to block if not already assigned.

If the block has a title and a caption prefix is available for this block, then build a caption from this information, assign it a number and store it to the caption attribute on the block.

If a caption has already been assigned to this block, do nothing.

The parts of a complete caption are: .