specs2-html/org.specs2.html/TableOfContents

TableOfContents

trait TableOfContents

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

Companion:
object
class Object
trait Matchable
class Any
object TableOfContents.type

Value members

Concrete methods

def createHeadersSubtoc(page: SpecHtmlPage, entryMaxSize: Int): NodeSeq
def createSpecPages(paths: List[FilePath], specifications: List[SpecStructure], outDir: DirectoryPath, fileSystem: FileSystem): Operation[List[SpecHtmlPage]]
def createToc(env: Env, specifications: List[SpecStructure], outDir: DirectoryPath, entryMaxSize: Int, fileSystem: FileSystem): Operation[Unit]

create a table of contents for all the specifications

create a table of contents for all the specifications

def createToc(pages: List[SpecHtmlPage], outDir: DirectoryPath, entryMaxSize: Int)(using ee: ExecutionEnv): SpecHtmlPage => NodeSeq
def li(outDir: DirectoryPath, entryMaxSize: Int)(page: SpecHtmlPage)(nested: NodeSeq): NodeSeq
def linkIndexIn(s1Refs: Seq[SpecificationRef]): SpecHtmlPage => Int
Returns:

the index of a linked specification in 'main'

def pagesTree(page: SpecHtmlPage, pages: List[SpecHtmlPage])(using ee: ExecutionEnv): TreeLoc[SpecHtmlPage]
def readHtmlPages(specifications: List[SpecStructure], outDir: DirectoryPath, fileSystem: FileSystem): Operation[List[SpecHtmlPage]]

read the generated html pages and return them as a tree, based on the links relationships between them

read the generated html pages and return them as a tree, based on the links relationships between them

def saveHtmlPages(pages: List[SpecHtmlPage], fileSystem: FileSystem): Operation[Unit]