Public: Methods for managing sections of AsciiDoc content in a document. The section responds as an Array of content blocks by delegating block-related methods to its @blocks Array.
Examples
section = Asciidoctor::Section.new section.title = 'Section 1' section.id = 'sect1' section.size => 0 section.id => "sect1" section << new_block section.size => 1
Public: Get/Set the Integer index of this section within the parent block
Public: Get/Set the section name of this section
Public: Get/Set the flag to indicate whether this is a special section or a child of one
Public: Initialize an Asciidoctor::Section object.
parent - The parent Asciidoc Object.
# File lib/asciidoctor/section.rb, line 35 def initialize(parent = nil, level = nil) super(parent, :section) if level.nil? && !parent.nil? @level = parent.level + 1 end if parent.is_a?(Section) && parent.special @special = true else @special = false end @index = 0 end
Public: Get the String section content by aggregating rendered section blocks.
Examples
section = Section.new section << 'foo' section << 'bar' section << 'baz' section.content "<div class=\"paragraph\"><p>foo</p></div>\n<div class=\"paragraph\"><p>bar</p></div>\n<div class=\"paragraph\"><p>baz</p></div>"
# File lib/asciidoctor/section.rb, line 107 def content @blocks.map {|b| b.render }.join end
Public: Generate a String id for this section.
The generated id is prefixed with value of the 'idprefix' attribute, which is an underscore by default.
Section id synthesis can be disabled by undefining the 'sectids' attribute.
If the generated id is already in use in the document, a count is appended until a unique id is found.
Examples
section = Section.new(parent) section.title = "Foo" section.generate_id => "_foo" another_section = Section.new(parent) another_section.title = "Foo" another_section.generate_id => "_foo_1"
# File lib/asciidoctor/section.rb, line 72 def generate_id if @document.attr? 'sectids' separator = @document.attr('idseparator', '_') # FIXME define constants for these regexps base_id = @document.attr('idprefix', '_') + title.downcase.gsub(%r&#[0-9]+;/, separator). gsub(%r\W+/, separator).tr_s(separator, separator).chomp(separator) gen_id = base_id cnt = 2 while @document.references[:ids].has_key? gen_id gen_id = "#{base_id}#{separator}#{cnt}" cnt += 1 end gen_id else nil end end
Public: Get the rendered String content for this Section and all its child Blocks.
# File lib/asciidoctor/section.rb, line 92 def render @document.playback_attributes @attributes renderer.render('section', self) end
Public: Get the section number for the current Section
The section number is a unique, dot separated String where each entry represents one level of nesting and the value of each entry is the 1-based index of the Section amongst its sibling Sections
delimiter - the delimiter to separate the number for each level append - the String to append at the end of the section number
or Boolean to indicate the delimiter should not be appended to the final level (default: nil)
Examples
sect1 = Section.new(document) sect1.level = 1 sect1_1 = Section.new(sect1) sect1_1.level = 2 sect1_2 = Section.new(sect1) sect1_2.level = 2 sect1 << sect1_1 sect1 << sect1_2 sect1_1_1 = Section.new(sect1_1) sect1_1_1.level = 3 sect1_1 << sect1_1_1 sect1.sectnum # => 1. sect1_1.sectnum # => 1.1. sect1_2.sectnum # => 1.2. sect1_1_1.sectnum # => 1.1.1. sect1_1_1.sectnum(',', false) # => 1,1,1
Returns the section number as a String
# File lib/asciidoctor/section.rb, line 154 def sectnum(delimiter = '.', append = nil) append ||= (append == false ? '' : delimiter) if !@level.nil? && @level > 1 && @parent.is_a?(Section) "#{@parent.sectnum(delimiter)}#{@index + 1}#{append}" else "#{@index + 1}#{append}" end end
# File lib/asciidoctor/section.rb, line 163 def to_s if @title if @level && @index %Q[#{super.to_s} - #{sectnum} #@title [blocks:#{@blocks.size}]] else %Q[#{super.to_s} - #@title [blocks:#{@blocks.size}]] end else super.to_s end end