contrib/smjs/README

   1 Most of the SpiderMonkey scripting interface is documented in the
   2 ELinks manual.  This README describes only features added by
   3 contrib/smjs/*.js.
   4
   5
   6 Multiple functions in the same hook
   7 -----------------------------------
   8
   9 The default hooks file contrib/smjs/hooks.js assigns functions that
  10 provide a mechanism to register multiple functions to each hook. When
  11 these default hooks are called, they iterate over all functions that
  12 are registered to them, calling each one in serial.
  13
  14 If you want to register a preformat_html hook, for example,
  15 the preferred way to do so is not this:
  16
  17    elinks.preformat_html = foo;
  18
  19 but rather this:
  20
  21    elinks.preformat_html_hooks.push(foo);
  22
  23 which adds foo to an array of functions, over which the default
  24 elinks.preformat_html function will iterate.
  25
  26 If any function in that array returns false, the default hook
  27 will stop iteration, not calling any more handlers. This applies
  28 to all of the default hooks:
  29
  30 - elinks.preformat_html_hooks
  31 - elinks.goto_url_hooks
  32 - elinks.follow_url_hooks