[NSIS-Bugs] [ nsis-Feature Requests-1820488 ] integration of documentation into 1 .chm file

[SourceForge.net <no...@so...>]

Feature Requests item #1820488, was opened at 2007-10-26 00:23
Message generated for change (Comment added) made by jmichae3
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=373088&aid=1820488&group_id=22049

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Scripting
Group: None
Status: Closed
Priority: 1
Private: No
Submitted By: Jim Michaels (jmichae3)
Assigned to: Amir Szekely (kichik)
>Summary: integration of documentation into 1 .chm file

Initial Comment:
the examples are missing key elements. for example, MUI examples are missing the core installer piece, the part that *always* gets executed no matter what options you pick. and I can't grey out any options and leave them checked either, because there is no documentation.  

a manual section on "assignment" (at least in the index) would be helpful to language junkies.  after all, there is no assignment operator. so be nice and show someone how its done.  I had to find out the hard way you can't do it with a register (you must use a Var), and you have to use StrCpy $var 0.  I was pulling my hair out to figure this out.

have section on branching. and in it discuss the C-looking way with StrCmp, Goto, and then bring in 
!include "LogicLib.nsh"
and the ${If},  statement and the related statements.

MUI is insufficiently documented.  a beginner can't make anything out of it without getting help from a forum from an expert (and getting chastised).

with MUI there is no "main" installer section that gets executed before the options sections. There are only options.  this is unacceptable.

document the controls we get to work with.
we are supposed to be able to feed in an .INI file to give all the parameters for a checkbbox and all the other controls on a page.  but there is no documentation for this that I could find.  so what is left, right, top, bottom relative to?  what values can I use for State for which controls?  what are the available  settings for Flags and what do they mean?
what kind of output do these controls generate and how do I interpret those values?

document that fact that in .INI files the Fields must be [Field 1] [Field 2] [Field 3]  they must always be numbers starting with 1.  if you use text, the page will not display.

document nsdialogs.  The examples are missing important pieces.

etc.

----------------------------------------------------------------------

>Comment By: Jim Michaels (jmichae3)
Date: 2007-10-26 15:48

Message:
Logged In: YES 
user_id=1476673
Originator: YES

sorry, I tried to douse my attitude, but I was frustrated.
The documentation is not organized well enough as other documentation is. 
for instance, there are 2 sets of documentation (chm file and html
readme's).  there should only be 1: a single  .chm file that is indexed and
searchable.  otherwise it is a lot more work for the user trying to find
anything useful.  I would like to request that a single chm file be used
for all the documentation rather than having it split up.
it would make things easier for every user.

after your comment I found the docs directory and the things that I
thought needed to be documented.

----------------------------------------------------------------------

Comment By: Amir Szekely (kichik)
Date: 2007-10-26 03:02

Message:
Logged In: YES 
user_id=584402
Originator: NO

You, sir, get chastised because of your attitude which rears it head in
this feature request as well. Combine this attitude with requests for
existing documentation and you get a closed feature request. I'd tell you
where everything you are looking for can be found, but you'll probably
write it off as avoidance of the topic at hand.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=373088&aid=1820488&group_id=22049