Class: Paru::PandocFilter::Caption

Inherits:
Block
  • Object
show all
Includes:
InnerMarkdown
Defined in:
lib/paru/filter/caption.rb

Overview

A table or figure’s caption, can contain an optional short caption

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(contents) ⇒ Caption

Create a new Caption based on the contents

Parameters:

  • contents (Array) 


36
37
38
39
40
41
42
43
 
# File 'lib/paru/filter/caption.rb', line 36

def initialize(contents)
  @short = if contents[0].nil?
             nil
           else
             ShortCaption.new contents[0]
           end
  super(contents[1])
end

Instance Attribute Details

#short ⇒ Object

Returns the value of attribute short.



31
32
33
 
# File 'lib/paru/filter/caption.rb', line 31

def short
  @short
end

Instance Method Details

#ast_contents ⇒ Array

The AST contents of this Caption node

Returns:

  • (Array) 


62
63
64
65
66
67
 
# File 'lib/paru/filter/caption.rb', line 62

def ast_contents
  [
    has_short? ? @short.to_ast : nil,
    @children.map(&:to_ast)
  ]
end

#has_block? ⇒ Boolean

Has this node a block?

Returns:

  • (Boolean) —

    true



55
56
57
 
# File 'lib/paru/filter/caption.rb', line 55

def has_block?
  true
end

#has_short? ⇒ Boolean

Does this Caption have a short caption?

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/paru/filter/caption.rb', line 48

def has_short?
  !@short.nil?
end

#inner_markdown ⇒ String Originally defined in module InnerMarkdown

Get the markdown representation of this Node’s children.

Examples:

Replace all occurrences of “hello” by “world” in all paragraphs

Paru::Filter.run do
    with "Para" do |p|
        p.inner_markdown = p.inner_markdown.gsub "hello", "world"
    end
end

Returns:

  • (String) —

    the inner markdown representation of this Node

#inner_markdown=(markdown) ⇒ Object Originally defined in module InnerMarkdown

Replace this Node’s children with the Nodes represented by the markdown string

Examples:

Replace all occurrences of “hello” by “world” in all paragraphs

Paru::Filter.run do
    with "Para" do |p|
        p.inner_markdown = p.inner_markdown.gsub "hello", "world"
    end
end

Parameters:

  • markdown (String) —

    the markdown string to replace this Node’s children

#to_ast ⇒ Hash

Create an AST representation of this Node

Returns:

  • (Hash) 


72
73
74
 
# File 'lib/paru/filter/caption.rb', line 72

def to_ast
  ast_contents
end