SCDocHTMLRenderer:
Filter:
Classes | HelpSystem

SCDocHTMLRenderer : Object

Render SCDoc markup text to HTML

Description

This class is part of the SCDoc help system, and handles the rendering of the parsed document tree into HTML output.

In normal cases you won't need to use this class directly, SCDoc uses this class by default to render help files.

Class Methods

SCDocHTMLRenderer.renderOnStream(stream, doc, root)

Renders a parsed document as HTML onto given stream.

Arguments:

stream

A stream, for example a File instance.

doc

An instance of SCDocEntry

root

An instance of SCDocNode

SCDocHTMLRenderer.renderToFile(filename, doc, root)

Opens a file and passes it to *renderOnStream

SCDocHTMLRenderer.htmlForLink(link, escape: true)

Create a html string for the given scdoc link.

Arguments:

link

An scdoc link, such as a document key like "Classes/SinOsc", or an URL, or link to other file installed with the help.

escape

a boolean to set whether to escape special characters.

Returns:

A String

SCDocHTMLRenderer.makeArgString(m, par: true)

Used internally.

Returns:

A String representing the arguments (with defaults) for a Method.

Inherited class methods

Undocumented class methods

SCDocHTMLRenderer.addUndocumentedMethods(list, body, id2, id, title)

SCDocHTMLRenderer.binaryOperatorCharacters

SCDocHTMLRenderer.escapeSpacesInAnchor(str)

SCDocHTMLRenderer.escapeSpecialChars(str)

SCDocHTMLRenderer.prLinkTargetForExternalLink(linkBase, linkAnchor)

SCDocHTMLRenderer.prLinkTargetForInternalLink(linkBase, linkAnchor, originalLink)

SCDocHTMLRenderer.prLinkTextForInternalLink(linkBase, linkAnchor, linkText)

SCDocHTMLRenderer.renderChildren(stream, node)

SCDocHTMLRenderer.renderClassTree(stream, cls)

SCDocHTMLRenderer.renderFootNotes(stream)

SCDocHTMLRenderer.renderFooter(stream, doc)

SCDocHTMLRenderer.renderHeader(stream, doc, body)

SCDocHTMLRenderer.renderMethod(stream, node, methodType, cls, icls)

SCDocHTMLRenderer.renderSubTree(stream, node)

SCDocHTMLRenderer.renderTOC(stream, node)

Instance Methods

Inherited instance methods

CSS styling

The rendered HTML reads the global style from scdoc.css, but also reads frontend.css and custom.css (in that order) if available, to enable specific frontends and users to override the CSS.

So to customise the CSS, the user can create a custom.css in their SCDoc: *helpTargetDir or at the root of any HelpSource directory (for example in YourExtension/HelpSource/custom.css ).

helpfile source: https://github.com/supercollider/supercollider/tree/3.13/HelpSource/Classes/SCDocHTMLRenderer.schelp
link::Classes/SCDocHTMLRenderer::