Module plugin.html

Turns Lua 5.1 source code into HTML files.

WARNING: highly experimental! interface liable to change

Notes:

  • This HTML highlighter marks globals brightly so that their usage can be manually optimized.
  • Either uses a .html extension for output files or it follows the -o option.
  • The HTML style tries to follow that of the Lua wiki.

Functions

init (_option, _srcfl) Initialization.
post_load () Message display, post-load processing.
post_lex (_toklist, _seminfolist) Post-lexing processing, can work on lexer table output.
post_parse (globalinfo, localinfo) Post-parsing processing, gives globalinfo, localinfo.

Local Functions

do_entities (z) Escapes the usual suspects for HTML/XML.


Functions

init (_option, _srcfl)
Initialization.

Parameters:

  • _option
  • _srcfl
post_load ()
Message display, post-load processing.
post_lex (_toklist, _seminfolist)
Post-lexing processing, can work on lexer table output.

Parameters:

  • _toklist
  • _seminfolist
post_parse (globalinfo, localinfo)
Post-parsing processing, gives globalinfo, localinfo.

Parameters:

  • globalinfo
  • localinfo

Local Functions

do_entities (z)
Escapes the usual suspects for HTML/XML.

Parameters:

  • z
generated by LDoc 1.4.6