Fan

 

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

compilerSource

DocCompiler compiler

contentSource

virtual Void content()

Generate the content section of the document.

docHomeSource

Str docHome := "Doc Home"

elemStartSource

override Void elemStart(DocElem elem)

facetValToStrSource

static Str facetValToStr(Obj? val)

facetsSource

Void facets(Symbol:Obj? facets, Bool wrap := true, Bool br := true)

virtual Void footer()

Generate the footer section of the document.

generateSource

Void generate()

virtual Void header()

Generate the header section of the document.

locSource

Location loc

makeSource

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

pathToRootSource

virtual Str pathToRoot()

Returnt the relative path to the document root.

Void searchBox()

Generate the search box.

showByDefaultSource

static Bool showByDefault(Type t, Slot s)

showSlotSource

static Bool showSlot(Type t, Slot s)

showTypeSource

static Bool showType(Type t)

virtual Void sidebar()

Generate the sidebar section of the document.

titleSource

virtual Str title()

Return the title for this document.