Archive: nub - 3 NSIS doc 'bugs', + praise


nub - 3 NSIS doc 'bugs', + praise
firstly NSIS is like a golden shower after rolling in the sh*t pile that is ms's P&DW ( ie good, real good ;)

but three things that took me more time than they should have in a perfect world :

problem
the 'Add uninstall information to Add/Remove Programs' code from http://nsis.sourceforge.net/Docs/AppendixC.html#C.3 failed on my system ( xp ). the call compiles fine and sets the error flag at runtime.

sol'n
change the '/'s in the examples to '\'s. solved this by looking at example .nsi files included with NSIS, ie doc's and product say two different things.


problem
no visible way to reliably contact the author of each page of the NSIS docs. some sections seem to have authors - but that might just be the code authors, not too sure.

suggested solution
Some pages note no author, some note several authors through the page. when saying 'author' say author of what: code, section, page etc. also list way to contact doc author in 'contacts' page, or if unavailable so say.


problem
took me ages to find out how to access the error flag, and even then it was by accident.

suggested solution
add one small section to the NSIS doc's outlining all of the flags in NSIS, and the way(s) to access them.


and one thing I haven't had a problem with personally. I think that just a single line example for each NSIS instruction would help a lot. It can make NSIS a lot easier to learn first time round ( for some who learn like me ), and it also helps as a quick refresher. The example .nsi's help a lot in this dept' but I think this is the only thing missing from the NSIS docs overall.

Thanks a lot for reading all this.

Overall i'd have to give NSIS a 9/10. I've found the code a tad iffy to use ( mmm spagetti code ), and the docs could use a little polish. But that is all but forgotten with the ease of use and power this thing brings, not to mention the nice looking 'modern ui'.

Seriously, as soon as I make some money off the product i'm shipping with NSIS there's some beerage going nullsofts way ( at least i hear that's something you don't totally hate :)

-blayde

ps i would volunteer to maintain the docs on sourceforge, but like i said i'm busy ATM, but i'd like to later on - having paid my rent first. even just for a small section of it, under the head doc' guy.


Fixed first one, thanks.

The documentation was written by pretty much everyone, there is no one author for each page. The only place authors are mentioned is in the useful information page where some of the scripts were taken from the archive.

There is no doubt the documentation needs some work, but currently we only have a very busy part time documentation writer and no full time writer.

Thank you for your comments.