NSE Online Documentation Portal Launched

[Fyodor <fyodor () insecure org>]

Hi All.  As one of his SoC projects, Patrick Donnelly put a lot of
time this summer developing a documentation system for NSE scripts.
This lets you document scripts and libraries within the code itself
rather than trying to keep docs/scripting.xml constantly up-to-date
with a changing codebase.  This is useful for developers, and even
more useful for users who need to know what scripts do, what arguments
they accept, etc.  Those of you who have been writing scripts are
likely already familiar with the system's structure:

http://nmap.org/book/nse-documentation.html

One of the most important aspects of the system is that it can be
automatically parsed to create online documentation of every script
and library.  I have generated the current doc tree based on the
latest SVN and posted it here:

http://nmap.org/nsedoc/

I expect this to be a big help for everyone who writes or uses NSE
scripts.  Please look through it and mail nmap-dev if you find any
problems or have ideas for improvements.

As part of making this new NSEDoc portal work, I had to hack some CSS
scripts and decided to make the changes site-wide.  So you'll note
some changes on all the insecure.org/nmap.org pages.  For example, the
"lightning" background is gone from the purple chrome around the page.
Also, links are no longer underlined except when you hover your mouse
over them (or print the page).  That is the style Wikipedia and many
other sites use now.

Cheers,
Fyodor


_______________________________________________
Sent through the nmap-dev mailing list
http://cgi.insecure.org/mailman/listinfo/nmap-dev
Archived at http://SecLists.Org