Class Asciidoctor::AbstractBlock
In: lib/asciidoctor/abstract_block.rb
Parent: AbstractNode

Methods

Attributes

blocks  [R]  Public: Get the Array of Asciidoctor::AbstractBlock sub-blocks for this block
caption  [W]  Public: Set the caption for this block
content_model  [RW]  Public: The types of content that this block can accomodate
level  [RW]  Public: Set the Integer level of this Section or the Section level in which this Block resides
number  [RW]  Public: Get/Set the number 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
source_location  [RW]  Public: Gets/Sets the location in the AsciiDoc source where this block begins
style  [RW]  Public: Get/Set the String style (block type qualifier) for this block.
subs  [R]  Public: Substitutions to be applied to content in this block

Public Class methods

Public Instance methods

Public: Append a content block to this block‘s list of blocks.

block - The new child block.

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

Returns The parent Block

Public: Returns the converted alt text for this block image.

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

append(block)

Alias for #<<

Public: 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: <prefix> <number>. <title> This partial caption represents the part the precedes the title.

value - The explicit String caption to assign to this block (default: nil). key - The String prefix for the caption and counter attribute names.

        If not provided, the name of the context for this block is used.
        (default: nil)

Returns nothing.

Public: Determine whether this Block contains block content

Returns A Boolean indicating whether this Block has block content

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 the [String] caption for this block (or the value of the textlabel attribute if this is an admonition block).

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

Concatenates the value of this Block‘s caption instance variable and the return value of this Block‘s title method. No space is added between the two values. If the Block does not have a caption, the interpreted title is returned.

Returns the converted String title prefixed with the caption, or just the converted String title if no caption is set

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

Public: Update the context of this block.

This method changes the context of this block. It also updates the node name accordingly.

Public: Get the converted String content for this Block. If the block has child blocks, the content method should cause them to be converted and returned as content that can be included in the parent block‘s template.

Internal: Assign the next index (0-based) and number (1-based) to the section

Assign to the specified section the next index and, if the section is numbered, number within this block (its parent).

Returns nothing

Public: Get the source file where this block started

Public: Query for all descendant block-level nodes in the document tree that match the specified selector (context, style, id, and/or role). If a Ruby block is given, it‘s used as an additional filter. If no selector or Ruby block is supplied, all block-level nodes in the tree are returned.

Examples

  doc.find_by context: :section
  #=> Asciidoctor::Section@14459860 { level: 0, title: "Hello, AsciiDoc!", blocks: 0 }
  #=> Asciidoctor::Section@14505460 { level: 1, title: "First Section", blocks: 1 }

  doc.find_by(context: :section) {|section| section.level == 1 }
  #=> Asciidoctor::Section@14505460 { level: 1, title: "First Section", blocks: 1 }

  doc.find_by context: :listing, style: 'source'
  #=> Asciidoctor::Block@13136720 { context: :listing, content_model: :verbatim, style: "source", lines: 1 }

Returns An Array of block-level nodes that match the filter or an empty Array if no matches are found

Public: Get the source line number where this block started

Public: Retrieve the list marker keyword for the specified list type.

For use in the HTML type attribute.

list_type - the type of list; default to the @style if not specified

Returns the single-character [String] keyword that represents the marker for the specified list type

Move to the next adjacent block in document order. If the current block is the last item in a list, this method will return the following sibling of the list block.

query(selector = {})

Alias for find_by

Internal: Reassign the section indexes

Walk the descendents of the current Document or Section and reassign the section 0-based index value to each Section as it appears in document order.

IMPORTANT You must invoke this method on a node after removing child sections or else the internal counters will be off.

Returns nothing

Public: Remove a substitution from this block

sub - The Symbol substitution name

Returns nothing

render()

Alias for convert

Public: Get the Array of child Section objects

Only applies to Document and Section instances

Examples

  doc << (sect1 = Section.new doc, 1, false)
  sect1.title = 'Section 1'
  para1 = Block.new sect1, :paragraph, :source => 'Paragraph 1'
  para2 = Block.new sect1, :paragraph, :source => 'Paragraph 2'
  sect1 << para1 << para2
  sect1 << (sect1_1 = Section.new sect1, 2, false)
  sect1_1.title = 'Section 1.1'
  sect1_1 << (Block.new sect1_1, :paragraph, :source => 'Paragraph 3')
  sect1.blocks?
  # => true
  sect1.blocks.size
  # => 3
  sect1.sections.size
  # => 1

Returns an [Array] of Section objects

Public: Check whether this block has any child Section objects.

Only applies to Document and Section instances

Returns A [Boolean] to indicate whether this block has child Section objects

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

name - The Symbol substitution name

Returns A Boolean indicating whether the specified substitution is enabled for this block

Public: Get the String title of this Block with title substitions applied

The following substitutions are applied to block and section titles:

:specialcharacters, :quotes, :replacements, :macros, :attributes and :post_replacements

Examples

  block.title = "Foo 3^ # {two-colons} Bar(1)"
  block.title
  => "Foo 3^ # :: Bar(1)"

Returns the converted String title for this Block, or nil if the source title is falsy

Public: Set the String block title.

Returns the new String title assigned to this Block

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

Returns a [Boolean] indicating whether this block has a title.

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

Use the explicit reftext for this block, if specified, retrieved from the {reftext} method. Otherwise, if this is a section or captioned block (a block with both a title and caption), generate the xreftext according to the value of the xrefstyle argument (e.g., full, short). This logic may leverage the {Substitutors#sub_quotes} method to apply formatting to the text. If this is not a captioned block, return the title, if present, or nil otherwise.

xrefstyle - An optional String that specifies the style to use to format

            the xreftext ('full', 'short', or 'basic') (default: nil).

Returns the generated [String] xreftext used to refer to this block or nothing if there isn‘t sufficient information to generate one.

[Validate]