logo

abstract class

docCompiler::HtmlGenerator

sys::Obj
  fandoc::HtmlDocWriter
    docCompiler::HtmlGenerator

HtmlGenerator is the base class for HTML generation which handles all the navigation and URI concerns

Slots

compiler

DocCompiler compiler

content

virtual Void content()

Generate the content section of the document.

docHome

Str docHome

elemStart

override Void elemStart(DocElem elem)

virtual Void footer()

Generate the footer section of the document.

generate

Void generate()

virtual Void header()

Generate the header section of the document.

isInnherited

static Bool isInnherited(Type t, Slot s)

loc

Location loc

make

new make(DocCompiler compiler, Location loc, OutStream out)

pathToRoot

virtual Str pathToRoot()

Returnt the relative path to the document root.

Void searchBox()

Generate the search box.

showByDefault

static Bool showByDefault(Type t, Slot s)

showSlot

static Bool showSlot(Type t, Slot s)

showType

static Bool showType(Type t)

virtual Void sidebar()

Generate the sidebar section of the document.

title

virtual Str title()

Return the title for this document.