typos in the docs ...

95 posts

Comm@nder21January 29, 2004 at 5:09 PM#

typos in the docs ...

hello nsis-developer-team!

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

4.5.3 Callbacks
[...]
Examples:

[...]

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
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 VerburgJanuary 29, 2004 at 5:32 PM#

Thanks, fixed.

Comm@nder21February 2, 2004 at 11:59 AM#

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 VerburgFebruary 2, 2004 at 1:44 PM#

Fixed again.

Comm@nder21February 2, 2004 at 4:49 PM#

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 VerburgFebruary 2, 2004 at 5:01 PM#

Heh 🙂 Fixed.

Comm@nder21February 3, 2004 at 6:50 PM#

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 VerburgFebruary 3, 2004 at 8:20 PM#

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

Comm@nder21February 9, 2004 at 12:18 PM#

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 VerburgFebruary 9, 2004 at 1:38 PM#

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

AutoCloseWindow etc. do have a default.

Comm@nder21February 10, 2004 at 3:42 PM#

ok, understood

Comm@nder21February 20, 2004 at 3:14 PM#

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 VerburgFebruary 20, 2004 at 3:32 PM#

Thanks, fixed.

Comm@nder21September 8, 2004 at 3:57 PM#

to warm up this thread 🙂 ...

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

zimsmsSeptember 8, 2004 at 4:35 PM#

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

kichikSeptember 9, 2004 at 3:19 PM#

Thanks, fixed.

Comm@nder21September 10, 2004 at 11:05 AM#

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.

kichikSeptember 10, 2004 at 11:54 AM#

fixed.

Comm@nder21March 20, 2005 at 7:51 PM#

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 🙂

kichikMarch 22, 2005 at 4:53 PM#

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.

JnuwMarch 23, 2005 at 1:04 AM#

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 UKMarch 23, 2005 at 7:22 AM#

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

-Stu

kichikMarch 24, 2005 at 1:21 PM#

Thanks, both fixed.

deguixMarch 28, 2005 at 6:47 AM#

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

dll:function /NOUNLOAD "param"

Forgot a ":".

kichikMarch 29, 2005 at 3:09 PM#

Thanks, fixed.

Afrow UKMarch 29, 2005 at 5:06 PM#

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 UKMarch 29, 2005 at 5:37 PM#

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

kichikMarch 29, 2005 at 5:59 PM#

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 UKMarch 29, 2005 at 6:34 PM#

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

kichikMarch 29, 2005 at 6:46 PM#

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.