specs2-html
API
Generated with
specs2-html/org.specs2/org.specs2.html/TableOfContents

TableOfContents

org.specs2.html.TableOfContents
See theTableOfContents companion object
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

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TableOfContents.type

Members list

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

Attributes

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

Attributes

Returns

the index of a linked specification in 'main'

def pagesTree(page: SpecHtmlPage, pages: List[SpecHtmlPage])(implicit 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

Attributes

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