HtmlPrinter

case class HtmlPrinter(env: Env, searchPage: SearchPage, logger: Logger) extends Printer

Printer for html files

Companion:
object
trait Serializable
trait Product
trait Equals
trait Printer
class Object
trait Matchable
class Any

Value members

Concrete methods

def copyResources(env: Env, options: HtmlOptions): Operation[List[Unit]]
def copySpecResourcesDir(env: Env, base: DirectoryPath, outputDir: DirectoryPath, loader: ClassLoader)(src: DirectoryPath): Operation[Unit]
def finalize(specifications: List[SpecStructure]): Action[Unit]

create an index for all the specifications, if required

create an index for all the specifications, if required

def getHtmlOptions(arguments: Arguments): Operation[HtmlOptions]

Get html options, possibly coming from the command line

Get html options, possibly coming from the command line

def makeHtml(template: String, spec: SpecStructure, stats: Stats, timer: SimpleTimer, options: HtmlOptions, arguments: Arguments)(ee: ExecutionEnv): Operation[String]

Create the html file content from:

Create the html file content from:

  • the template
  • the body of the file (built from the specification execution)
def makePandocHtml(spec: SpecStructure, stats: Stats, timer: SimpleTimer, pandoc: Pandoc, options: HtmlOptions, env: Env): Operation[Unit]

Create the Html file by invoking Pandoc

Create the Html file by invoking Pandoc

def prepare(specifications: List[SpecStructure]): Action[Unit]
def printHtml(env: Env, spec: SpecStructure, stats: Stats, timer: SimpleTimer): Operation[Unit]

Print the execution results as an Html file

Print the execution results as an Html file

  • copy resources: css, javascript, template
  • create the file content using the template
  • output the file
def printHtmlWithPandoc(env: Env, spec: SpecStructure, stats: Stats, timer: SimpleTimer, pandoc: Pandoc): Operation[Unit]

Print the execution results as an Html file

Print the execution results as an Html file

  • copy resources: css, javascript, template
  • create the file content using the template and Pandoc (as an external process)
def reportMissingSeeRefs(specs: List[SpecStructure], outDir: DirectoryPath)(using ee: ExecutionEnv): Operation[Unit]
def sink(spec: SpecStructure): AsyncSink[Fragment]
Returns:

a SinkTask for the Html output

Inherited methods

def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product