paperlined.org
dev > oss > others
document updated 16 years ago, on Mar 18, 2008
==== Main documentation ====

The Wireshark LUA API documentation in HTML-chunked format is REALLY hard to read:
    http://www.wireshark.org/docs/wsug_html_chunked/wsluarm_modules.html

However, it doesn't have to be.  If you look at the .pdf version, it's much easier to read for two
reasons:

    1. there's a more detailed TOC, so you can jump around and see the deeper hierarchy much better
    2. the styling makes it much clearer what the <h4>/<h5>/<h6>'s are



It should be possible to change the DocBook configuration to incorporate some of these changes into
the HTML-changed only (and possibly HTML-single as well).



(if this were fixed, then I think a huge impediment to user-uptake of Lua scripts would be
removed...  it really is a damn useful feature, but almost nobody has successfully gotten it working
yet because the docs are such a PITA)




==== Lua generally ====

Generally, Lua needs a lot of work, because not many people have started using it yet.

- the wiki documentation/examples need to be updated to make sure they work with the latest API
  (it's changed a lot)


- the API was pretty well done, but still has a few small quirks/inconsistencies/incompletenesses