Re: NSE Online Documentation - observations

[jah <jah () zadkiel plus com>]

Hi,

I notice that \n isn't handled inside doc comments for tables:
http://nmap.org/nsedoc/files/scripts/whois.html#data

An html anchor for the http scheme is created for email addresses
enclosed in <> in script author fields.  These could be made into
anchors for the mailto: scheme - or just not anchorified.

The attched is for whois.nse and reverts some comments [1] that are
using &lt; and &gt; which prevented the stuff inside them being hidden
in the source [2].  I've a suspicion that these will be turned into html
anchors too...

All of the nselibs that appear under Libraries in the left navigation
block are duplicated under Files which also contains C modules and scripts.
I reckon it would be nicer to have an additional heading for the C
modules, one for Scripts and then lose the Files section of the
navigation block.  The path and file extensions could then be removed
from these navigation links which would be easier to read.
The Categories header might be renamed to "Script Categories" too.

Also, it might be nicer to change the index page to either lose the left
navigation bar or to remove the links from the body and instead have a
few paragraphs to introduce the documentation pages, explain what the
different sections mean, and perhaps document the documentation system
so that future script writers have no excuse not to submit scripts
without beautifully formed documentation.

Nsedoc is cool.

I kinda miss the weird "lightning" background from the purple chrome
around the page.

Finally, would someone please point me to the current source for nsedoc
in svn - I've lost it.

Cheers,

jah


[1] http://nmap.org/nsedoc/files/scripts/whois.html#requires_updating
[2] http://seclists.org/nmap-dev/2008/q3/0394.html

--- whois.nse.orig      2008-10-16 23:35:00.062500000 +0100
+++ whois.nse   2008-10-16 23:34:43.390625000 +0100
@@ -1887,7 +1887,7 @@
 
 ---
 -- Checks whether a cached file requires updating via HTTP.
--- The cached file should contain the following string on the second line: 
"&lt;timestamp&gt;&lt;Last-Modified-Date&gt;&lt;Entity-Tag&gt;".
+-- The cached file should contain the following string on the second line: 
"<timestamp><Last-Modified-Date><Entity-Tag>".
 -- where timestamp is number of seconds since epoch at the time the file was last cached and
 -- Last-Modified-Date is an HTTP compliant date sting returned by an HTTP server at the time the file was last cached 
and
 -- Entity-Tag is an HTTP Etag returned by an HTTP server at the time the file was last cached.


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