1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-10-12 05:33:36 -04:00
elinks/contrib/smjs/README
Kalle Olavi Niemitalo 9954d37a68 Move most of contrib/smjs/README into the manual.
Also document elinks.vs and elinks.action.

<kahmalo> Miciah: IMO most of contrib/smjs/README should be moved into
    the ELinks manual.  Specifically the parts that do not depend on
    contrib/smjs/hooks.js.  However manual.txt contains a notice:
    "Hold blameless the authors.  Any lawful use is allowed."  Will
    you allow that also for what is now in contrib/smjs/README?
<Miciah> Absolutely.
<Miciah> In fact, I would allow some lawless uses.
<Miciah> It seems a little silly to say that lawful uses are allowed.
2008-07-10 20:31:22 +03:00

33 lines
1023 B
Plaintext

Most of the SpiderMonkey scripting interface is documented in the
ELinks manual. This README describes only features added by
contrib/smjs/*.js.
Multiple functions in the same hook
-----------------------------------
The default hooks file contrib/smjs/hooks.js assigns functions that
provide a mechanism to register multiple functions to each hook. When
these default hooks are called, they iterate over all functions that
are registered to them, calling each one in serial.
If you want to register a preformat_html hook, for example,
the preferred way to do so is not this:
elinks.preformat_html = foo;
but rather this:
elinks.preformat_html_hooks.push(foo);
which adds foo to an array of functions, over which the default
elinks.preformat_html function will iterate.
If any function in that array returns false, the default hook
will stop iteration, not calling any more handlers. This applies
to all of the default hooks:
- elinks.preformat_html_hooks
- elinks.goto_url_hooks
- elinks.follow_url_hooks