HelpSource/Classes/SCDocHTMLRenderer.schelp

   1 class:: SCDocHTMLRenderer
   2 summary:: Render SCDoc markup text to HTML
   3 categories:: HelpSystem
   4 related:: Classes/SCDoc, Classes/SCDocParser, Guides/WritingHelp, Reference/SCDocSyntax
   5
   6 description::
   7 This class is part of the SCDoc help system, and handles the rendering of the parsed document tree into HTML output.
   8
   9 In normal cases you won't need to use this class directly, link::Classes/SCDoc:: uses this class by default to render help files.
  10
  11 classmethods::
  12
  13 method:: renderOnStream
  14 Renders a parsed document as HTML onto given stream.
  15 argument:: stream
  16 A stream, for example a link::Classes/File:: instance.
  17 argument:: doc
  18 An instance of link::Classes/SCDocEntry::
  19 argument:: root
  20 An instance of link::Classes/SCDocNode::
  21
  22 method:: renderToFile
  23 Opens a file and passes it to link::#*renderOnStream::
  24
  25 method:: htmlForLink
  26 Create a html string for the given scdoc link.
  27 argument:: link
  28 An scdoc link, such as a document key like "Classes/SinOsc", or an URL, or link to other file installed with the help.
  29 returns::
  30 A String
  31
  32 method:: makeArgString
  33 Used internally.
  34 Returns:: A link::Classes/String:: representing the arguments (with defaults) for a link::Classes/Method::.
  35
  36
  37 section:: CSS styling
  38 The rendered HTML reads the global style from teletype::scdoc.css::, but also reads teletype::frontend.css:: and teletype::custom.css:: (in that order) if available, to enable specific frontends and users to override the CSS.
  39
  40 So to customise the CSS, the user can create a teletype::custom.css:: in their link::Classes/SCDoc#*helpTargetDir:: or at the root of any HelpSource directory (for example in teletype::YourExtension/HelpSource/custom.css:: ).
  41