HelpSource/Classes/SCDocRenderer.schelp

   1 class:: SCDocRenderer
   2 summary:: Abstract superclass for SCDoc renderers
   3 categories:: HelpSystem
   4 related:: Classes/SCDoc, Classes/SCDocParser
   5
   6 description::
   7 This is an abstract superclass for SCDoc renderers, like link::Classes/SCDocHTMLRenderer::.
   8
   9 instancemethods::
  10 The interface should look as follows:
  11
  12 method:: render
  13 Render a parsed document.
  14 argument:: parser
  15 An instance of link::Classes/SCDocParser:: holding a parsed document tree in code::.root::, which are to be rendered.
  16 argument:: outputFile
  17 The full path for the output filename.
  18 argument:: folder
  19 The directory part relative to the base directory of the help directory tree, like "Classes" or "Reference". This is used as a simple organization for document "kind".
  20 argument:: makeTOC
  21 if true, create a table-of-contents.
  22
  23 method:: findHelpFile
  24 Find help for string.
  25 returns:: the URL for help on given string, or the main help page if string was empty or nil.
  26