Contents

require 'jsduck/util/html'

module JsDuck

  # Adds Table of Contents section to guide HTML.
  class GuideToc

    # Inserts table of contents at the top of guide HTML by looking
    # for <h2> elements.
    def self.inject(html, guide_name)
      toc = []
      new_html = []

      html.each_line do |line|
        if line =~ /^\s*<(h[1-6])>(.*?)<\/h[1-6]>$/
          tag = $1
          text = Util::HTML.strip_tags($2)
          id = guide_name + "-section-" + title_to_id(text)
          if tag == "h2"
            toc << "<li><a href='#!/guide/#{id}'>#{text}</a></li>\n"
          end
          new_html << "<#{tag} id='#{id}'>#{text}</#{tag}>\n"
        else
          new_html << line
        end
      end

      # Inject TOC below first heading if at least 2 items in TOC
      if toc.length >= 2
        new_html.insert(1, [
            "<div class='toc'>\n",
            "<p><strong>Contents</strong></p>\n",
            "<ol>\n",
            toc,
            "</ol>\n",
            "</div>\n",
        ])
      end

      new_html.flatten.join
    end

    def self.title_to_id(title)
      CGI::escape(title.downcase.gsub(/ /, "-"))
    end

  end

end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
jsduck-5.3.4	lib/jsduck/guide_toc.rb
jsduck-5.3.3	lib/jsduck/guide_toc.rb
jsduck-5.3.2	lib/jsduck/guide_toc.rb
jsduck-5.3.1	lib/jsduck/guide_toc.rb
jsduck-5.3.0	lib/jsduck/guide_toc.rb
jsduck-5.2.0	lib/jsduck/guide_toc.rb
jsduck-5.1.0	lib/jsduck/guide_toc.rb
jsduck-5.0.1	lib/jsduck/guide_toc.rb