NSIS Wiki - User contributions [en]

Adding custom installer pages

2007-07-20T17:51:18Z

Cribe: /* InstallOptions Code Snippet #2 */

{{PageAuthor|Afrow UK}}

== Description ==

One of the more common questions that get asked is how to add custom pages/dialogs to one's installer. You may want to get some user input and take action depending on that input.

InstallOptions was the first way to add custom dialogs, with basic controls support such as text boxes, directory request fields and so on. There is also the [[InstallOptionsEx plug-in]] for more advanced dialogs with more controls and events.

There are other plug-ins out there now to display a range of dialogs, such as the [[nsWeb plug-in]], the [[PassDialog plug-in]], the [[EmbeddedLists plug-in]] and now the nsDialogs plug-in with NSIS (to serve as a replacement for InstallOptions).

To generate the InstallOptions INI files, [[List_of_InstallOptions_form_designers|see this list of form designers]].

== InstallOptions Code Snippet #1 ==
This is the least complicated script with no run-time events or dialog manipulation.
<highlight-nsis>
Page Custom MyCustomPage MyCustomLeave

Function MyCustomPage
# If you need to skip the page depending on a condition, call Abort.
ReserveFile "InstallOptionsFile.ini"
!insertmacro MUI_INSTALLOPTIONS_EXTRACT "InstallOptionsFile.ini"
!insertmacro MUI_INSTALLOPTIONS_DISPLAY "InstallOptionsFile.ini"
FunctionEnd

Function MyCustomLeave
# Form validation here. Call Abort to go back to the page.
# Use !insertmacro MUI_INSTALLOPTIONS_READ $Var "InstallOptionsFile.ini" ...
# to get values.
FunctionEnd
</highlight-nsis>

== InstallOptions Code Snippet #2 ==
This code demonstrates modifying the dialog at run time to highlight a field that has not been filled in.
<highlight-nsis>
!include LogicLib.nsh
...

Page Custom MyCustomPage MyCustomLeave

Function MyCustomPage
ReserveFile "InstallOptionsFile.ini"
!insertmacro MUI_INSTALLOPTIONS_EXTRACT "InstallOptionsFile.ini"
!insertmacro MUI_INSTALLOPTIONS_DISPLAY "InstallOptionsFile.ini"
FunctionEnd

Function MyCustomLeave
# Get control window handle.
!insertmacro MUI_INSTALLOPTIONS_READ $R0 "InstallOptionsFile.ini" "Field 1" "HWND"
# Check if text has been entered in field 1.
!insertmacro MUI_INSTALLOPTIONS_READ $R1 "InstallOptionsFile.ini" "Field 1" "State"
# Make field background red!
${If} $R1 == "" #! <-- {Is this correct I am getting an error on compile !?}
SetCtlColors $R1 0x000000 0xFF0000
Abort # Go back to page.
# Reset field colours.
${Else}
SetCtlColors $R1 0x000000 0xFFFFFF
${EndIf}
FunctionEnd
</highlight-nsis>

== InstallOptions Code Snippet #3 ==
This code demonstrates manipulating the dialog at run time before it is displayed. This works a bit like InstallOptions Code Snippet #2.
<highlight-nsis>
Page Custom MyCustomPage MyCustomLeave

Function MyCustomPage
ReserveFile "InstallOptionsFile.ini"
!insertmacro MUI_INSTALLOPTIONS_EXTRACT "InstallOptionsFile.ini"
!insertmacro MUI_INSTALLOPTIONS_INITDIALOG "InstallOptionsFile.ini"

# Get the control window handle.
!insertmacro MUI_INSTALLOPTIONS_READ $R0 "InstallOptionsFile.ini" "Field 1" "HWND"
# Make the field background colour red.
SetCtlColors $R0 0x000000 0xFF0000

!insertmacro MUI_INSTALLOPTIONS_SHOW
FunctionEnd

Function MyCustomLeave
# Form validation here. Call Abort to go back to the page.
# Use !insertmacro MUI_INSTALLOPTIONS_READ $Var "InstallOptionsFile.ini" ...
# to get values.
FunctionEnd
</highlight-nsis>

== InstallOptions Code Snippet #4 ==
This code shows how to do something when a button is pressed on your custom page. You need Flags=NOTIFY on your button field in the INI file.
<highlight-nsis>
!include LogicLib.nsh
...

Page Custom MyCustomPage MyCustomLeave

Function MyCustomPage
ReserveFile "InstallOptionsFile.ini"
!insertmacro MUI_INSTALLOPTIONS_EXTRACT "InstallOptionsFile.ini"
!insertmacro MUI_INSTALLOPTIONS_DISPLAY "InstallOptionsFile.ini"
FunctionEnd

Function MyCustomLeave
# Find out which field event called us. 0 = Next button called us.
!insertmacro MUI_INSTALLOPTIONS_READ $R0 "InstallOptionsFile.ini" "Settings" "State"
${If} $R0 == 1 # Field 1.
# Do something useful here and then go back to the page.
Abort
${EndIf}
FunctionEnd
</highlight-nsis>

[[Category:Tutorials]]

Talk:Adding custom installer pages

2007-07-20T17:04:55Z

Cribe: Wow great !

== Wow great ! ==

Thanks Afrow, great detailed to the point explanation of the custom pages and how to use them. Hey you saved me the trouble of writing it too !

Talk:Main Page

2007-07-19T14:17:37Z

Cribe: What links here ...

I get the following virus message when i install any application using the Nullsoft installer:

c:\docume~1\Karl\Temp\nsd4C.tmp\nsisdl.dll was infected by the downloader-og trojan and has been deleted to complete the clean process.

This file isn't a virus (Symantec have fixed this issue in their virus definitions dated 9 August 2004).

See the nullsoft website for more info: http://nsis.sourceforge.net/index.php?id=2&backPID=2&tt_news=14

hopefully someone will do something about this.

== NSISdl: why it gets labeled a trojan ==

NSISdl is a plugin that can download files from the Internet. While a spyware programmer can use it to download malware, it does not contain any malicious code.

You should probably post in the forums when you have a problem like that - I've seen people complaining about the same thing before.

-[[User:Dandaman32|Dandaman32]] 22:46, 25 January 2006 (PST)

An installer is not only the first experience of a user with your product

eh, shouldn't this be
An installer is not only the first experience of a product with your user --Djon
:It sounds right to me. The user is having an experience with the product, not the other way around. But I'm not a native English speaker, so I might be wrong. --[[User:Kichik|kichik]] 00:03, 19 May 2006 (PDT)

:: Both are wrong, or at least ambiguous, it should be '''"An installer is not only a user's first experience with your product"''' or '''"An installer is not only the first experience a user has with your product"'''. [[User:217.206.93.34|217.206.93.34]] 08:23, 31 May 2006 (PDT)

== Question ==

Hi. I noticed this website look and feel is exactly that of Wikipedia. Is this website, Nulsoft, or NSIS associated with Wikipedia or the Wikimedia Foundation?
:It uses the same software, but it's in no way associated.--[[User:Kichik|kichik]] 02:22, 3 June 2006 (PDT)
:The NSIS site uses [http://www.mediawiki.org MediaWiki], a popular FOSS CM and wiki solution. A lot of websites use it nowadays; Wikipedia provides a (far from complete) list of [http://en.wikipedia.org/wiki/List_of_wikis websites using wiki software], and the vast majority of these wikis use MediaWiki. --[[User:Dandaman32|Dandaman32]] 09:18, 9 August 2006 (PDT)

== NSIS Eclipse link in the Main page ==

Joost quote: "EclipseNSIS link is back (this is the place for a "featured contribution" that's inside the Developer Center)"

I don't see a "Developers Center featured contribution" tag, indicating that's the place for that... Also, where is the "featured contributions" section in the Developers Center? So there's actually no featured contributions! :o

I removed this link before because I wanted featured contributions to appear only on the Developers Center. [[User:Deguix|deguix]]

:The Developer Center is indeed the place for contributions, but some of the best ones that are important for many people in the community can get some additional promotion on the main page :) [[User:Joost|Joost]] 02:53, 11 June 2006 (PDT)

::Understood, but my request for "Developers Center featured contribution" tag is still up. [[User:Deguix|deguix]] 12:35, 12 June 2006 (PDT)

(forgot my user tag... my bad)

== Why is this page protected? ==

I noticed that this talk page is semi-protected so that only registered users can post - IMHO this isn't a great idea, after looking through the page history I couldn't find any spam or anything so I would suggest that this page be unprotected. --[[User:Dandaman32|Dandaman32]] 09:09, 9 August 2006 (PDT)
:MediaWiki probably does this automatically for protected pages. And the main page must be protected... --[[User:Kichik|kichik]] 02:33, 18 August 2006 (PDT)

==Insert the link==

Insert the link to Italian NSIS Portal. [[Pagina Principale]]. Thank you. --[[User:GiancyNSIS|GiancyNSIS]] 12:55, 19 September 2006 (PDT)
:Where do you think a good place for this would be? --[[User:Kichik|kichik]] 03:27, 22 September 2006 (PDT)
::kichik, putting it in "In other languages" bar would be great. But this would require some prefix like "it/" to be in the title AFAIK. [[User:Deguix|deguix]] 11:43, 22 September 2006 (PDT)
:::it does seem to require more than simply adding a link in to "it:Pagina_Principale". I haven't dug in enough to find out where it gets the mapping of it: prefix to it.wikipedia.org. Anyway, it seems a bit too complicated for just a simple link. A simple link on the bottom would do for now. --[[User:Kichik|kichik]] 09:27, 29 September 2006 (PDT)

== What links here ... ==

Why was the "What links here" option of the navigation pane removed ? I find it very helpfull and use it a lot to trace back where an article is linked from.

--[[User:Cribe|Cribe]] 07:17, 19 July 2007 (PDT)

User talk:Cribe

2006-10-23T20:58:22Z

Cribe: Wow nice site

== Wow nice site ==

Finally a site where I can get some info to start using NSIS2.
I find NSIS2 just to complicated for the 1st time user but I see there are graphic UI that can be used cant wait to start testing them.... :)