typos in the docs ...
 

hello nsis-developer-team!

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

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


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


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.

Thanks, fixed.

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

Fixed again.

you fixed this one and implemented another :D:

Heh :) Fixed.

another typo:
must be "copied"
:D

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

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

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

AutoCloseWindow etc. do have a default.

ok, understood

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

Thanks, fixed.

to warm up this thread :) ...

Wow.....someone actually reads the documentation.....:D

BTW:
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

Thanks, fixed.

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

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

unlogical:
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????

fixed.

time to raise up this topic again:
missing )

should be index_output, to make clear, that this is ONE parameter.
also in the following explanation:
that's it for now :)

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.

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.

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

-Stu

Thanks, both fixed.

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

Thanks, fixed.

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

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

Thanks, all fixed but: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.

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

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.

"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

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

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

-Stu

And the error is? Don't leave me hanging :)

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

I think /USRNAME must be changed to /USERNAME.

Thanks, fixed.

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.

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

In section 8 of the MUI Readme, there is:

Which should be MUI_UNFUNCTION_DESCRIPTION_END, no s.

-auz