typos in the docs ...

[Comm@nder21]

hello nsis-developer-team!

i've found some bugs in the nsis-documentations:

4.5.3 Callbacks
[...]
Examples:

code:
[...]

Function skipLicense

   MessageBox MB_YES "Do you want to skip the license page?" IDNO no

     Abort

   no:

 FunctionEnd

Function stayInLicense

   MessageBox MB_YES "Do you want to stay in the license page?" IDNO no

     Abort

   no:

FunctionEnd

[...]

[...]

in the example-code there's the flag 'MB_YES' set for messageboxes. that must be 'MB_YESNO' instead.

5.4.3 !ifndef

code:
gflag [bcheck [gflag [...]]]

The opposite of !ifmacrodef. The lines will be compiled when the gflag has not been defined.

i think this is the opposite of '!ifdef', not of '!ifmacrodef'.

5.4.6 !else
[...]
This command is the opposite of !ifdef [...]

i'd say: it can be the opposite of "!ifdef, !ifndef, !ifmacrodef, !ifmacrondef".


hmm, that's it for now, i'll post more bugs in here, whenever i found some.

[Joost Verburg]

Thanks, fixed.

[Comm@nder21]

a typo:

4.9.3.2 CopyFiles
[...]You might see a Windows status window of the copy operation takes a lot of time (to disable this, use /SILENT).[...]

missing "if it" between "... copy operation" and "takes a lot ...". or is my english to bad?

[Joost Verburg]

Fixed again.

[Comm@nder21]

you fixed this one and implemented another :

You might see a Windows status window of the copy operation if the operation takes takes a lot of time (to disable this, use /SILENT).

[Joost Verburg]

Heh Fixed.

[Comm@nder21]

another typo:

4.9.3.2 CopyFiles
[...]The last parameter can be used to specify the size of the files that will be copies (in kilobytes), [...]

must be "copied"

[Joost Verburg]

Someone was definately not really awake when writing that line Fixed.

[Comm@nder21]

found some more.
usually default-settings are shown by underline and bold.
missing at the following topics:
- 4.9.14.10 SetAutoClose
- 4.9.14.12 SetDetailsView
- 4.9.14.13 SetDetailsPrint
- 4.9.14.15 SetSilent

[Joost Verburg]

That's because they are instructions, no attributes. There is no default.

AutoCloseWindow etc. do have a default.

[Comm@nder21]

ok, understood

[Comm@nder21]

some more:

C.5 Calling an external DLL using the System.dll plugin
[...]
... and head on over to the Contrib/System directory and read the doco there.
[...]
l - long & large integer (know as int64)
[...]

the bold words are wrong, i think.
must be docs and known.

[Joost Verburg]

Thanks, fixed.

[Comm@nder21]

to warm up this thread ...

4.10.3 RTL Languages
... current langaugeis RTL or not ...

[zimsms]

Wow.....someone actually reads the documentation.....

BTW:

4.9.3.2 CopyFiles
[...]You might see a Windows status window of the copy operation takes a lot of time (to disable this, use /SILENT).[...]

The only problem with the original was a single typo. 'of' should have read 'if'. Though long and drawn out, the one you changed it to makes sense as well.

Cheers,

ZIMSMS

[kichik]

Thanks, fixed.

[Comm@nder21]

aaah, zimsms, that was the other one i saw one time, but forgot to post

and another one:

5.1.8 !packhdr
This option makes the compiler an external EXE packer (such as Petite or UPX) to compress the executable header.

i think, between the two bold words, there's a word missing, like "use":
"This option makes the compiler use and external ..."

unlogical:

4.9.4.11 IfRebootFlag
[jump_if_set] [jump_if_not_set]
Atleast one parameter is required. ...

i'd remove the [] for "jump_if_set", because it is always required to be set.
same for "4.9.4.12 IfSilent"
see "4.9.4.9 IfErrors" for 'correct' example .

and wtf does this mean????

4.9.5.7 FileWriteByte
You can If an error occurs writing, the error flag will be set.

[kichik]

fixed.

[Comm@nder21]

time to raise up this topic again:

E.1.1.4 Utilities and Plug-ins
StartMenu: Added support for SetCtlColors (RFE #711900

missing )

4.6.1.5 SectionGroup
[/e] Caption [section_group_name index output]

should be index_output, to make clear, that this is ONE parameter.
also in the following explanation:

If section index output is specified

that's it for now

[kichik]

The missing parenthesis was fixed while 2.06 was being released. I didn't want to recompile the whole thing, so I've left it to the next version.

index output -> index_output. done.

[Jnuw]

Didn't want to tie up a new thread for this, but the special builds web page still says:

"...These builds are only compatible with NSIS 2.05..."

But it looks like the downloadable builds are 2.06, thanks.

[Afrow UK]

Just noticed a small typo under CallInstDLL in the example: anoter

-Stu

[kichik]

Thanks, both fixed.

[deguix]

There is a typo under "4.11.2 Disabling Plugin Unloading" example:

dll:function /NOUNLOAD "param"

Forgot a ":".

[kichik]

Thanks, fixed.

[Afrow UK]

Under 1.1 (about NSIS)
unsuccesful should be spelt unsuccessful (it is in native English anyway).
In the second paragraph support should have an s on the end.

Under 1.2 under "Custom dialogs and interfaces" in the last sentence, a should be your.
Under "Easy and human readable file formats" human would make more sense as humanly.

Under 2.1 in the last paragraph and last sentence, have should be has.

Under 2.3.6, in the second code example for macro's, a !macroend is missing.

Under 2.4, in the third paragraph at the start of the thrid sentence, error should be errors.

Under 2.6 in the last paragraph, there's a repetition of in after plug-in.

Under 3.1, /NOCD, disabled I think should be disables.

That's it for now. I will read up more later
This is the first time I've actually read the NSIS documentation from the start!

-Stu

[Afrow UK]

Under 4.1, just before the Plug-ins heading, 'you' is missing from the sentence.
Under the Long commands heading, 'to' should be after 'concatenated'.

Under 4.2.3, $EXEDIR, the full stop needs to be moved to the end.
$WINDIR, $SYSDIR and $TEMP are missing full stops.

-Stu

[kichik]

Thanks, all fixed but:

Under 2.1 in the last paragraph and last sentence, have should be has.

Are you sure about this one? The sentence already has one "has".

For more than a couple of changes, it'd be nice if you edit the .but files and submit a patch.

[Afrow UK]

Yes it doesn't make sense with 'have'. You could only use have there if it were past tense (ie "it would still have") but in this case it isn't so it doesn't quite make sense.

Everything else is perfect though. Whoever wrote the docs would all get A grades in English class for writing

For patches: Roger, will do. I will read the rest of the documents tomorrow.

-Stu

[kichik]

I am pretty sure I remember my English teacher saying you can't have more than one "has" in a sentence. I'll to check it a bit more thoroughly over the weekend.

[Afrow UK]

"The dog has a bone, and the dog has a phone". I don't see anything wrong with that (apart from having a phone lol!)

If we were to put 'have' in there, we'd have to change it to:
"The dog has a bone, and the dog used to have a phone"; in order for it to make sense, but then that changes it completely (to past tense).

The only thing that sounds bad when used more than once in the same sentence is 'and' (which is where we use commas).

Hope that makes sense

-Stu

[kichik]

It appears you were right. However, while checking it, I got a suggestion for a better sentence which I eventually used.

NSIS boasts the smallest overhead available while still providing a lot of options thanks to its powerful scripting language and support of external plug-ins.

[Afrow UK]

I found a small error at the end of Chapter 4 contents (HTML error):
http://nsis.sourceforge.net/Docs/Chapter4.html

-Stu

[kichik]

And the error is? Don't leave me hanging

[Afrow UK]

Sorry Kichik, I couldn't reproduce the HTML error at home. It must have been the college computers at fault (with their stupid content blockers which probably meant only half the page was loading or something.)

-Stu

[glory_man]

4.12 Silent Installers/Uninstallers
[...]The above example will copy the value the user passes on after /USRNAME= into $0.[...]

I think /USRNAME must be changed to /USERNAME.

[kichik]

Thanks, fixed.

[Comm@nder21]

I found a small error at the end of Chapter 4 contents (HTML error):
http://nsis.sourceforge.net/Docs/Chapter4.html

-Stu

ran the file through html-tidy from w3c.
found two fixable mistakes:

code:
<address>

</address>

<a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=22049&amp;type=1" alt="SourceForge Logo"></a></body>

> the adress tag is emtpy
> the img tag is not closed.

there were lots of other warnings too, but i dont think, they make sense.

[Afrow UK]

If you are unsure how to close the img tag, it should be:
<img border=0 src="http://sourceforge.net/sflogo.php?group_id=22049&amp;amp;type=1" alt="SourceForge Logo" />

Not to mension & should be &amp;amp; too (if it isn't already).

-Stu

[Auz]

In section 8 of the MUI Readme, there is:

For the uninstaller, use the MUI_UNFUNCTION_DESCRIPTION_BEGIN and MUI_UNFUNCTIONS_DESCRIPTION_END macros.

Which should be MUI_UNFUNCTION_DESCRIPTION_END, no s.

-auz