typos in the docs ...

[kichik]

Thanks, fixed.

[Anders]

4.8.1.21 InstallDir:
"Sets the default installation directory is." remove is (doh)

[kichik]

Thanks, fixed.

[BioDuo]

4.9.14.5 FindWindow

FIndWindow $0 "my window class" "my window title"
It should be Findwindow

[glory_man]

4.9.14.1 BringToFront
... If the user if working with another ...

I think it should be - If the user is working

[kichik]

Thanks, fixed.

[Anders]

4.7.2.1.6 .onMouseOverSection
STR: prefix is missing from lparam (in example code)

the docs also needs to be more clear about the description label, eg you actually have to use resource hacker to add a label (or use a existing label like in the ugly hack i did here: http://www.rafb.net/paste/results/XTG9Pd58.html )

[kichik]

Thanks, fixed.

[glory_man]

And what about

Variables

Variables start with $. User variables should be declared and are case-sensitive.

Is this mean - variables names are case-sensitive?
This code work fine:

code:


var vv1

...

StrCpy $Vv1 "1 string 1"

MessageBox MB_OK "$vV1"

Is this typo, or NSIS bug, or I misunderstood something in docs?

[kichik]

Just a relic from the old days when variables were case sensitive. Fixed, thanks.

[Afrow UK]

This isn't really an issue with the manual, but I noticed that there's no shortcut to the InstallOptions manual in the start menu shortcuts group.
Or is it just me?

-Stu

[kichik]

Thanks, fixed.

[Comm@nder21]

file:
INSTALL

This is a trimmed version of Appendix F of the documentation.

should be Appedix G

[DrO]

Appedix?

-daz

[Afrow UK]

In the modern UI readme, under 3. Pages > Page Settings > Finish Page Settings > MUI_FINISHPAGE_RUN_FUNCTION:

Call a function instead of executing an application (define MUI_FINISHPAGE_RUN without parameters). You can use the function to exectute multiple applications or you can change the checkbox name and use it for other things.

-Stu

[Comm@nder21]

Appedix?

well, yea ....
you pwned me

[kichik]

Thanks, fixed.

[Jamyn]

I've attached the typos I found. Hope it helps.

-J

[Jamyn]

Oops, I just saw the message on the first page of this thread that asks for large corrections to be presented as a patch. I can't edit my post above to delete it, but anyway...

I have attached a diff to this message, with all the corrections listed in the above message, plus one or two others I ran across. I'm not sure if the way I did it is the preferred way, but if not - just let me know and I'll change it.

I attached it as .txt because the forum doesn't allow the .diff extension. Thanks,

-J

[kichik]

Awesome, thanks! All committed.

[o_owd]

in the Install Options readme,

(NSIS\Docs\InstallOptions\Readme.html)
"Call the DLL
You can call InstallOptions in a page function, check the NSIS documentation for information about the page system."

the link "NSIS documentation" points to "file:///C:/Program%20Files/NSIS/Docs/Chapter4.html#4.5"
the file does not exist.

OJi.

[kichik]

Thanks, fixed.

[Jnuw]

This is not a typo, but a suggestion for clarity. Under the 4.9.1.5 File section, on the /nonfatal bullet, it currently states:

"If the /nonfatal switch is used and no files are found, a warning will be issued instead of an error."

I think it would be good to add that if the /nonfatal switch is activate or invoked (no files found), the line will no longer be a run-time instruction, and Relative Jumps will not see the line (per jump info below). It would be best to use regular labels around File /nonfatal commands to be safe.

"4.4 Relative jump of +2 will skip one instruction and go to the second instruction from the current instruction...An instruction is every command that is executed at run-time, when the installer is running. MessageBox, Goto, GetDLLVersion, FileRead, SetShellVarContext are all instructions. AddSize, Section, SectionGroup, SectionEnd, SetOverwrite (and everything under Compiler Flags), Name, SetFont, LangString, are not instructions because they are executed at compile time."

Thanks for your time!

[kichik]

That's a bug, not a documentation problem. Please submit a bug report.

[Jnuw]

Logged as a bug, 1299100. Thanks for looking at this, and your help on my 2.09 questions from a few minutes ago.

Jnuw

[Afrow UK]

I know that in the history of NSIS we've always had the "NSIS Examples Directory" shortcut, but I think a "NSIS Directory" shortcut would be more helpful as I myself have my projects in a Projects sub-folder.

-Stu

[kichik]

I don't think that's necessary. The start menu is meant for a quick start and that folder contains nothing that's not already linked. In your case, I think you'd even do better with a direct link to that projects folder.

[Anders]

4.6.1.5 SectionGroup

[/e] Caption [section_group_name index_output]

should be

[/e] section_group_name [index_output]

[JasonFriday13]

I found a few typos:

4.8.2.3
Typically the SetCompress flag will effect the commands after it,
should be 'affect'.

Also found that this code changes the compression status:
SetCompress off
SetCompressor lzma

Setcompressor switches SetCompress back to the default compression status (auto). This should be documented or bugfixed.

5.4
!define symbol1 ${symbol2}
After copying and pasting the code, I found that this typo has a 1 after symbol. I thought it was two l's. Maybe it should be changed to symbol_1 and symbol_2 or somthing similar (for clarity).

B2
To ask the user for a reboot if required,
should be 'To ask the user for a reboot, if required,' or 'If required, you can ask the user for a reboot.'

D2
For Windows NT (NT4/2000/XP), it's also possible to create the key in the HKCU hive,
Should this be hive, or should it be changed to folder/directory?

[kichik]

Thanks, fixed.

SetCompress off followed by SetCompressor worked fine for me. Please include a complete example.

It should indeed be HKCU hive. That's how the registry objects are called [MSDN].

[JasonFriday13]

My bad on SetCompressor. It does work. Maybe instead of saying 'Using lzma compression', it could say 'Using no compression', because I look at this line when I compile my installers with SetCompress off, and I think 'Oh, it's using lzma compression' when it is really not compressed.

[glory_man]

From MUI doc:

...
Language Selection Dialog Settings

To remember to users preference, you can define a registry key.
...

Is this correct? I think this is must be:

To remember the...

4.9.13.1 SectionSetFlags

... The first bit (lowest) represents whether the section is currently enabled,

I suggest "enabled" --> "selected"

This will also make it consistent with wording in Sections.nsh, e.g. SF_SELECTED

[kichik]

Thanks, fixed.

[Wladimir Mutel]

In section 4.9.14.2, CreateFont :

GetDlgItem $$0 $HWNDPARENT 1

Should there really be two '$' signs ?
And if yes, then why ?

[Comm@nder21]

nope there should not, its definetly a typo.

[kichik]

Thanks, fixed.

[{_trueparuex^}]

In section 4.8.1.30, Name :
'CrapSoft MyApp'
==> 'MySoft MyApp'

In section C.1, Get parent directory :
; input, top of stack (e.g. C:\Program Files\Poop)
==> ; input, top of stack (e.g. C:\Program Files\foo)

[{_trueparuex^}]

Aannd there was also some poo in the examples.

In these files:
Examples\bigtest.nsi
Examples\InstallOptions\test.ini
Examples\InstallOptions\testnotify.ini

(Not sure if the bigtest.nsi needs fixin)
StrCpy $1 "POOOOOOOOOOOP"
==> StrCpy $1 "FOOOOOOOOOOOO"

Heres a patch anyway.

[iceman_k]

Not actually a typo, but missing documentation. The LockWindow command is supported but not documented anywhere.
What exactly does it do? I am guessing it enables or prevents window repainting.
Why would it be needed in an installer? I am not quite sure.