org.specs2.html.TableOfContents.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of specs2_2.11 Show documentation

specs2

There is a newer version: 3.7

package org.specs2
package html

import scala.xml._
import NodeSeq._
import xml.Nodex._
import Htmlx._
import data.Trees._
import io.Paths._
/**
 * This trait checks for the presence of a  tag at the beginning of a xml document and replaces it
 * by a list of links to the headers of the document
 */
private[specs2]
trait TableOfContents { outer =>

  /**
   * Create a Table of contents by building a Tree of all the header elements contained into the "body" and mapping it to an  list
   *
   * The body can contain  elements showing where to insert sub-table of contents corresponding to linked documents
   *
   * @param body html where to extract the table of contents
   * @param url of the document linked to the root of the toc
   * @param id of the specification that is the root of the toc (it is used to "open" the toc list on the current specification).
   *        This id is generated by the specification SpecName
   * @param subTocs map of identifier -> toc for the sub-specifications. The subtocs are inserted where the  tag in present in the body
   *
   * @return the toc of a document
   */
  def tocItemList(body: NodeSeq, rootUrl: String, url: String, id: SpecId, subTocs: Map[SpecId, NodeSeq]): NodeSeq = {
    body.headersTree.
      bottomUp { (h: Header, s: Stream[NodeSeq]) =>
        if (h.isRoot)
      // 'id' is the name of the attribute expected by jstree to "open" the tree on a specific node
          s.reduceNodes.updateHeadAttribute("id", id.toString)
        else if (h.isSubtoc)
          subTocs.get(h.specId).getOrElse(Empty) ++ s.reduceNodes
        else
          {h.name}
            { {s.toSeq} unless (s.toSeq.isEmpty) }
          
    }.rootLabel
  }
}

private[specs2]
object TableOfContents extends TableOfContents