abstract const class compilerDoc::DocEnv

sys::Obj
  compilerDoc::DocEnv

Source

DocEnv is the centralized glue class for managing documentation modeling and rendering:

• hooks for lookup and loading of spaces/pods
• hooks for theming HTML chrome and navigation
• hooks for renderering HTML pages
• hooks for hyperlink resolution

doc

virtual Doc? doc(Str spaceName, Str docName, Bool checked := true)

Source

Lookup a document by is spaceName and docName within that space. If not found then return null or raise UnknownDocErr. Default implementation delegates to space and DocSpace.doc.

err

DocErr err(Str msg, DocLoc loc, Err? cause := null)

Source

errReport

virtual DocErr errReport(DocErr err)

Source

link

virtual DocLink? link(Doc from, Str link, Bool checked := true)

Source

Resolve the link relative to the given from document. See DocLink for the built-in formats.

linkCheck

virtual Void linkCheck(DocLink link, DocLoc loc)

Source

Hook to perform extra DocLink checking such as links to NoDocs

linkUri

virtual Uri linkUri(DocLink link)

Source

Return URI used to link the from doc to the target doc. Also see linkUriExt.

linkUriExt

virtual Str? linkUriExt()

Source

Return the file extension (including the dot) to suffix all link URIs. Default returns ".html"

render

virtual Void render(WebOutStream out, Doc doc)

Source

Render the given document to the specified output stream. Default implementation uses Doc.renderer.

space

abstract DocSpace? space(Str name, Bool checked := true)

Source

Lookup a space by its space name. If not found then return null or raise UnknownDocErr. This method is called frequently during document rendering and linking so caching is expected.

theme

virtual DocTheme theme()

Source

Theme is responsible for the common chrome, styling, and navigation during rendering

topIndex

virtual DocTopIndex topIndex()

Source

Get the document which represents top level index.