Glossary - Revision history

Smartguy1196: Format as table for readability - content not changed

2020-12-30T09:49:37Z

Format as table for readability - content not changed

â† Older revision		Revision as of 09:49, 30 December 2020
Line 1:		Line 1:
	~~'''Glossary to assist newbies understand the NSIS User Manual''' (v2.38 on 8/29/08)~~

	:Attribute: Command that configures your installer's general behavior (unlike an Instruction): <code>AutoCloseWindow true</code>. Unless it's a Compiler Flag, it's not Section or Function specific and so is specified outside them		{\| style="border-collapse: collapse;" class="wikitable"
			\|- style="border: 1px solid #a2a9b1"
	:Callback: A Function called by the installer at certain points in the install, eg, <code>.onInit</code> is called when the installer is nearly finished initializing		\|
			! '''Glossary to assist newbies understand the NSIS User Manual''' (v2.38 on 8/29/08)
	:Command: Any non-comment line (possibly \-extended), ie, Compile Time Commands, Attributes (and Compiler Flags), Instructions, and commands related to the definition of Functions, Pages, Sections, and Variables		\|-
			\| style="border: 1px solid #a2a9b1" \| '''Attribute:'''
	:Comment: Text enclosed in /* ... */ or prefixed with ; or #		\| style="border: 1px solid #a2a9b1" \| Command that configures your installer's general behavior (unlike an Instruction): <code>AutoCloseWindow true</code>. Unless it's a Compiler Flag, it's not Section or Function specific and so is specified outside them
			\|-
	:Compile Time Command: Always starts with a bang, eg,		\| style="border: 1px solid #a2a9b1" \| '''Callback:'''
			\| style="border: 1px solid #a2a9b1" \| A Function called by the installer at certain points in the install, eg, <code>.onInit</code> is called when the installer is nearly finished initializing
			\|-
			\| style="border: 1px solid #a2a9b1" \| '''Command:'''
			\| style="border: 1px solid #a2a9b1" \| Any non-comment line (possibly \-extended), ie, Compile Time Commands, Attributes (and Compiler Flags), Instructions, and commands related to the definition of Functions, Pages, Sections, and Variables
			\|-
			\| style="border: 1px solid #a2a9b1" \| '''Comment:'''
			\| style="border: 1px solid #a2a9b1" \| Text enclosed in /* ... */ or prefixed with ; or #
			\|-
			\| style="border: 1px solid #a2a9b1" \| '''Compile Time Command:'''
			\| style="border: 1px solid #a2a9b1" \| Always starts with a bang, eg,
	<pre>!ifdef VERSION & NOVERSION		<pre>!ifdef VERSION & NOVERSION
	!error "Warning compile-person: both VERSION and NOVERSION are defined"		!error "Warning compile-person: both VERSION and NOVERSION are defined"
	!endif</pre>		!endif</pre>
			\|-
	:Compiler Flag: An Attribute that "affect[s] how the compiler generates code and compresses data": <code>SetCompressor zlib</code>		\| style="border: 1px solid #a2a9b1" \| '''Compiler Flag:'''
			\| style="border: 1px solid #a2a9b1" \| An Attribute that "affect[s] how the compiler generates code and compresses data": <code>SetCompressor zlib</code>
	:Constant: A case-insensitive, read-only variable with built-in value. Dereferenced as a variable: $EXEPATH		\|-
			\| style="border: 1px solid #a2a9b1" \| '''Constant:'''
	:Define: A symbol defined at runtime by NSIS (a Predefine), by <code>!define</code>, or by /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}		\| style="border: 1px solid #a2a9b1" \| A case-insensitive, read-only variable with built-in value. Dereferenced as a variable: $EXEPATH
			\|-
	:File ~~instruction~~: includes the named file(s) in the installer's data block at compile time for extraction to the /oname or SetOutPath folder at run time. (This is included here as hopefully an improvement to "Adds file(s) to be extracted to the current output path")		\| style="border: 1px solid #a2a9b1" \| '''Define:'''
			\| style="border: 1px solid #a2a9b1" \| A symbol defined at runtime by NSIS (a Predefine), by <code>!define</code>, or by /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}
	:Function: A user-created block of commands called explicitly (user function) or automatically (Callback)		\|-
			\| style="border: 1px solid #a2a9b1" \| '''File Instruction:'''
	:Installer: A wizard that MakeNSIS.exe compiles from a script		\| style="border: 1px solid #a2a9b1" \| includes the named file(s) in the installer's data block at compile time for extraction to the /oname or SetOutPath folder at run time. (This is included here as hopefully an improvement to "Adds file(s) to be extracted to the current output path")
			\|-
	:Instruction: A Function or Section command executed when your installer is run, eg, <code>FileClose $0</code>		\| style="border: 1px solid #a2a9b1" \| '''Function:'''
			\| style="border: 1px solid #a2a9b1" \| A user-created block of commands called explicitly (user function) or automatically (Callback)
	:Page: The <code>Page</code> family of commands typically specify either <code>Page custom ''creator_function'' ''leave_function''</code> or one of the internal page types, which are <code>license</code>, <code>components</code> (to select), <code>directory</code> (of installation), <code>instfiles</code> (where, installer configuration complete, the Sections are executed), <code>uninstConfirm</code>. These differ in some behaviors (e.g., <code>Section</code>s define components for the <code>components</code> page only) and the attributes that effect them. <code>LicenseText</code>'s setting, if any, is only used on the <code>license</code> page, for example		\|-
			\| style="border: 1px solid #a2a9b1" \| '''Installer:'''
	:Plug-in: A DLL file called using form <code>DLLName::FunctionName "param1" "param2" "param3"</code>		\| style="border: 1px solid #a2a9b1" \| A wizard that MakeNSIS.exe compiles from a script
			\|-
	:Predefine: A Define with built in value. Includes four underscores in its name: ${__<''UPCASE''>__}, eg, ${__FILE__}		\| style="border: 1px solid #a2a9b1" \| '''Instruction:'''
			\| style="border: 1px solid #a2a9b1" \| A Function or Section command executed when your installer is run, eg, <code>FileClose $0</code>
	:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9		\|-
			\| style="border: 1px solid #a2a9b1" \| '''Page:'''
	:Script: A (.nsi) text file that sets some attributes (minimally, <code>outfile</code>), usually declares/defines/assigns some Symbols, then lists the Pages, in order, to walk the (un)installing user through. Zero or more Functions and at least one Section follow. Plug-ins may be called and header (.nsh) scripts <code>!include</code>d		\| style="border: 1px solid #a2a9b1" \| The <code>Page</code> family of commands typically specify either <code>Page custom ''creator_function'' ''leave_function''</code> or one of the internal page types, which are <code>license</code>, <code>components</code> (to select), <code>directory</code> (of installation), <code>instfiles</code> (where, installer configuration complete, the Sections are executed), <code>uninstConfirm</code>. These differ in some behaviors (e.g., <code>Section</code>s define components for the <code>components</code> page only) and the attributes that effect them. <code>LicenseText</code>'s setting, if any, is only used on the <code>license</code> page, for example
			\|-
	:Section: A block of commands "executed in order by the resulting installer." "If [Attribute] ComponentText is set, the user will have the option of disabling/enabling each visible section. If a section's name is 'Uninstall' or is prefixed with 'un.', it's an uninstaller section."		\| style="border: 1px solid #a2a9b1" \| '''Plug-in:'''
			\| style="border: 1px solid #a2a9b1" \| A DLL file called using form <code>DLLName::FunctionName "param1" "param2" "param3"</code>
	:Symbol: Define (Predefine or user <code>!define</code>) or Variable		\|-
			\| style="border: 1px solid #a2a9b1" \| '''Predefine:'''
	:Variable: A globally-scoped constant, register, or user variable		\| style="border: 1px solid #a2a9b1" \| A Define with built in value. Includes four underscores in its name: ${__<''UPCASE''>__}, eg, ${__FILE__}
			\|-
			\| style="border: 1px solid #a2a9b1" \| '''Register:'''
			\| style="border: 1px solid #a2a9b1" \| A pre-declared variable, one of $0 - $9, $R0 - $R9
			\|-
			\| style="border: 1px solid #a2a9b1" \| '''Script:'''
			\| style="border: 1px solid #a2a9b1" \| A (.nsi) text file that sets some attributes (minimally, <code>outfile</code>), usually declares/defines/assigns some Symbols, then lists the Pages, in order, to walk the (un)installing user through. Zero or more Functions and at least one Section follow. Plug-ins may be called and header (.nsh) scripts <code>!include</code>d
			\|-
			\| style="border: 1px solid #a2a9b1" \| '''Section:'''
			\| style="border: 1px solid #a2a9b1" \| A block of commands "executed in order by the resulting installer." "If [Attribute] ComponentText is set, the user will have the option of disabling/enabling each visible section. If a section's name is 'Uninstall' or is prefixed with 'un.', it's an uninstaller section."
			\|-
			\| style="border: 1px solid #a2a9b1" \| '''Symbol:'''
			\| style="border: 1px solid #a2a9b1" \| Define (Predefine or user <code>!define</code>) or Variable
			\|-
			\| style="border: 1px solid #a2a9b1" \| '''Variable:'''
			\| style="border: 1px solid #a2a9b1" \| A globally-scoped constant, register, or user variable
			\|}

	[[Category:Help]]		[[Category:Help]]

Gherson: Added Category:Help

2008-09-15T01:00:28Z

Added Category:Help

â† Older revision		Revision as of 01:00, 15 September 2008
Line 43:		Line 43:

	:Variable: A globally-scoped constant, register, or user variable		:Variable: A globally-scoped constant, register, or user variable

			[[Category:Help]]

Gherson at 16:30, 29 August 2008

2008-08-29T16:30:28Z

â† Older revision		Revision as of 16:30, 29 August 2008
Line 20:		Line 20:
	:Define: A symbol defined at runtime by NSIS (a Predefine), by <code>!define</code>, or by /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}		:Define: A symbol defined at runtime by NSIS (a Predefine), by <code>!define</code>, or by /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}

	:File instruction: includes the named file(s) in the installer's data block at compile time for extraction to ~~$PLUGINSDIR~~ at run time. (~~Included~~ here as hopefully an improvement to "Adds file(s) to be extracted to the current output path")		:File instruction: includes the named file(s) in the installer's data block at compile time for extraction to the /oname or SetOutPath folder at run time. (This is included here as hopefully an improvement to "Adds file(s) to be extracted to the current output path")

	:Function: A user-created block of commands called explicitly (user function) or automatically (Callback)		:Function: A user-created block of commands called explicitly (user function) or automatically (Callback)

Gherson at 15:21, 29 August 2008

2008-08-29T15:21:27Z

â† Older revision		Revision as of 15:21, 29 August 2008
Line 1:		Line 1:
			'''Glossary to assist newbies understand the NSIS User Manual''' (v2.38 on 8/29/08)

	:Attribute: Command that configures your installer's general behavior (unlike an Instruction): <code>AutoCloseWindow true</code>. Unless it's a Compiler Flag, it's not Section or Function specific and so is specified outside them		:Attribute: Command that configures your installer's general behavior (unlike an Instruction): <code>AutoCloseWindow true</code>. Unless it's a Compiler Flag, it's not Section or Function specific and so is specified outside them

	:Callback: A Function called by the installer at certain points in the install, eg, <code>.onInit</code> is called when the installer is nearly finished initializing		:Callback: A Function called by the installer at certain points in the install, eg, <code>.onInit</code> is called when the installer is nearly finished initializing

	:Command: Any non-comment line (possibly \-extended), ie, Compile Time Commands, Attributes, Instructions, and commands related to the definition of Functions, Pages, Sections, and Variables		:Command: Any non-comment line (possibly \-extended), ie, Compile Time Commands, Attributes (and Compiler Flags), Instructions, and commands related to the definition of Functions, Pages, Sections, and Variables

	:Comment: Text enclosed in /* ... */ or prefixed with ; or #		:Comment: Text enclosed in /* ... */ or prefixed with ; or #
Line 17:		Line 19:

	:Define: A symbol defined at runtime by NSIS (a Predefine), by <code>!define</code>, or by /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}		:Define: A symbol defined at runtime by NSIS (a Predefine), by <code>!define</code>, or by /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}

			:File instruction: includes the named file(s) in the installer's data block at compile time for extraction to $PLUGINSDIR at run time. (Included here as hopefully an improvement to "Adds file(s) to be extracted to the current output path")

	:Function: A user-created block of commands called explicitly (user function) or automatically (Callback)		:Function: A user-created block of commands called explicitly (user function) or automatically (Callback)
Line 32:		Line 36:
	:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9		:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9

	:Script: A (.nsi) text file that sets some attributes (minimally, <code>outfile</code>), usually declares/defines/assigns some ~~symbols~~, then lists the ~~pages~~, in order, to walk the (un)installing user through. Zero or more Functions and at least one Section follow. ~~For increased power and flexibility,~~ Plug-ins ~~can~~ be called and "header" (.nsh) scripts <code>!include</code>d		:Script: A (.nsi) text file that sets some attributes (minimally, <code>outfile</code>), usually declares/defines/assigns some Symbols, then lists the Pages, in order, to walk the (un)installing user through. Zero or more Functions and at least one Section follow. Plug-ins may be called and header (.nsh) scripts <code>!include</code>d

	:Section: A block of commands "executed in order by the resulting installer." "If [Attribute] ComponentText is set, the user will have the option of disabling/enabling each visible section. If a section's name is 'Uninstall' or is prefixed with 'un.', it's an uninstaller section."		:Section: A block of commands "executed in order by the resulting installer." "If [Attribute] ComponentText is set, the user will have the option of disabling/enabling each visible section. If a section's name is 'Uninstall' or is prefixed with 'un.', it's an uninstaller section."

	:Symbol~~: General term meaning a define or variable. The taxonomy:~~		:Symbol: Define (Predefine or user <code>!define</code>) or Variable
	~~::Symbol~~
	:::Define
	~~::::~~Predefine
	~~::::User~~ define
	~~:::~~Variable
	~~::::Constant~~
	~~::::Register~~
	~~::::User variable~~

	:Variable: A globally-scoped constant, register, or user variable		:Variable: A globally-scoped constant, register, or user variable

Gherson at 20:26, 19 August 2008

2008-08-19T20:26:15Z

â† Older revision		Revision as of 20:26, 19 August 2008
Line 3:		Line 3:
	:Callback: A Function called by the installer at certain points in the install, eg, <code>.onInit</code> is called when the installer is nearly finished initializing		:Callback: A Function called by the installer at certain points in the install, eg, <code>.onInit</code> is called when the installer is nearly finished initializing

	:Command: Any non-comment line (possibly \-extended)		:Command: Any non-comment line (possibly \-extended), ie, Compile Time Commands, Attributes, Instructions, and commands related to the definition of Functions, Pages, Sections, and Variables

	:Comment: Text enclosed in /* ... */ or prefixed with ; or #		:Comment: Text enclosed in /* ... */ or prefixed with ; or #

Gherson at 20:54, 18 August 2008

2008-08-18T20:54:57Z

Gherson at 18:29, 18 August 2008

2008-08-18T18:29:21Z

â† Older revision		Revision as of 18:29, 18 August 2008
Line 1:		Line 1:
	:Attribute: ~~Commands~~ that ~~control~~ your installer: <code>AutoCloseWindow true</code>. ~~These are~~ not Section or Function specific and so ~~are~~ specified outside them		:Attribute: Command that configures your installer's general behavior (unlike an Instruction): <code>AutoCloseWindow true</code>. Unless it's a Compiler Flag, it's not Section or Function specific and so is specified outside them

	:Callback: A Function called by the installer at certain points in the install, eg, .onInit is called when the installer is nearly finished initializing		:Callback: A Function called by the installer at certain points in the install, eg, <code>.onInit</code> is called when the installer is nearly finished initializing

			:Command: Any non-comment line (possibly \-extended)

			:Compile Time Command: Always starts with a bang, eg,
			<pre>!ifdef VERSION & NOVERSION
			!error "Warning compile-person: both VERSION and NOVERSION are defined"
			!endif</pre>

			:Compiler Flag: An Attribute that "affect[s] how the compiler generates code and compresses data": <code>SetCompressor zlib</code>

	:Constant: A read-only variable with built-in value. Dereferenced as a variable: $EXEPATH		:Constant: A read-only variable with built-in value. Dereferenced as a variable: $EXEPATH
Line 7:		Line 16:
	:Define: A symbol that is predefined or created with <code>!define</code> or /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}		:Define: A symbol that is predefined or created with <code>!define</code> or /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}

	:Function: A user-created code block called explicitly (user function) or automatically (~~callback~~)		:Function: A user-created code block called explicitly (user function) or automatically (Callback)

			:Installer: A wizard that NSIS compiles from a script

	:~~Installer~~: ~~An executable compiled from a script~~		:Instruction: A Function or Section command executed when your installer is run, eg, <code>FileClose $0</code>

	:Page: The <code>Page</code> family of commands typically specify either <code>Page custom ''creator_function'' ''leave_function''</code> or one of the internal page types, which are <code>license</code>, <code>components</code> (to select), <code>directory</code> (of installation), <code>instfiles</code> (where the Sections are executed), <code>uninstConfirm</code>. These differ in some behaviors (e.g., <code>Section</code>s define components for the <code>components</code> page only) and the attributes that effect them. <code>LicenseText</code>'s setting, if any, is only used on the <code>license</code> page, for example		:Page: The <code>Page</code> family of commands typically specify either <code>Page custom ''creator_function'' ''leave_function''</code> or one of the internal page types, which are <code>license</code>, <code>components</code> (to select), <code>directory</code> (of installation), <code>instfiles</code> (where, installer configuration complete, the Sections are executed), <code>uninstConfirm</code>. These differ in some behaviors (e.g., <code>Section</code>s define components for the <code>components</code> page only) and the attributes that effect them. <code>LicenseText</code>'s setting, if any, is only used on the <code>license</code> page, for example

	:Predefine: A built-in ~~define~~, eg, ${__FILE__}		:Predefine: A Define with built in value. Includes four underscores in its name: ${__<''UPCASE''>__}, eg, ${__FILE__}

	:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9		:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9

Gherson at 00:50, 9 August 2008

2008-08-09T00:50:33Z

â† Older revision		Revision as of 00:50, 9 August 2008
Line 19:		Line 19:
	:Script: A (.nsi) text file that sets some attributes (minimally, <code>outfile</code>), usually declares/defines/assigns some symbols, then lists the pages, in order, to walk the (un)installing user through. Zero or more Functions and at least one Section follow. For increased power and flexibility, plug-in DLLs can be called and "header" (.nsh) scripts <code>!include</code>d		:Script: A (.nsi) text file that sets some attributes (minimally, <code>outfile</code>), usually declares/defines/assigns some symbols, then lists the pages, in order, to walk the (un)installing user through. Zero or more Functions and at least one Section follow. For increased power and flexibility, plug-in DLLs can be called and "header" (.nsh) scripts <code>!include</code>d

	:Section: A code block to ~~allow the installing user to select and install one~~ component ~~via~~ the <code>components</code> page		:Section: A code block corresponding to an installable component on the <code>components</code> page

	:Symbol: General term meaning a define or variable. The taxonomy:		:Symbol: General term meaning a define or variable. The taxonomy:

Gherson at 14:04, 8 August 2008

2008-08-08T14:04:14Z

Gherson at 13:32, 8 August 2008

2008-08-08T13:32:05Z

â† Older revision		Revision as of 13:32, 8 August 2008
Line 1:		Line 1:
	:Callback: A function called by the installer at certain points in the install, eg, .onInit is called when the installer is nearly finished initializing		:Callback: A function called by the installer at certain points in the install, eg, .onInit is called when the installer is nearly finished initializing
	:Constant: A read-only variable with built-in value. Dereferenced as a variable~~, eg,~~ $EXEPATH
	:Define: A symbol that is predefined or created with !define or /D at the command line. Dereferenced with $ and curly brackets~~, eg,~~ ${VERSION}		:Constant: A read-only variable with built-in value. Dereferenced as a variable: $EXEPATH

			:Define: A symbol that is predefined or created with !define or /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}

	:Function: A user-created code block called explicitly (user function) or automatically (callback)		:Function: A user-created code block called explicitly (user function) or automatically (callback)

			:Installer: An executable compiled from a script

			:Page: The <code>Page</code> command names either a <code>Page custom ''pagename''</code> or one of the internal page types, which are <code>license</code>, <code>components</code> (to select), <code>directory</code> (of installation), <code>instfiles</code> (where the sections are executed), <code>uninstConfirm</code>. These differ in some behaviors (e.g., <code>section</code>s define components for the <code>components</code> page only) and the attributes that effect them. <code>LicenseText</code>'s setting, if any, is only used on the <code>license</code> page, for example

	:Predefine: A built-in define, eg, ${__FILE__}		:Predefine: A built-in define, eg, ${__FILE__}

	:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9		:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9

			:Script: A (.nsi) text file that defines some global attributes (eg, <code>outfile</code>) and, typically, symbols, then the pages to walk the (un)installing user through. Functions and at least one section follow. Also, plug-in DLLs can be called and "header" (.nsh) scripts <code>!include</code>d

			:Section: A code block to allow the installing user to select and install one component via the <code>components</code> page

	:Symbol: General term meaning a define or variable. The taxonomy:		:Symbol: General term meaning a define or variable. The taxonomy:
	::Symbol		::Symbol
Line 14:		Line 28:
	::::Register		::::Register
	::::User variable		::::User variable
	:Variable: A constant, register, or user variable
			:Variable: A globally-scoped constant, register, or user variable

â† Older revision		Revision as of 20:54, 18 August 2008
Line 4:		Line 4:

	:Command: Any non-comment line (possibly \-extended)		:Command: Any non-comment line (possibly \-extended)

			:Comment: Text enclosed in /* ... */ or prefixed with ; or #

	:Compile Time Command: Always starts with a bang, eg,		:Compile Time Command: Always starts with a bang, eg,
Line 12:		Line 14:
	:Compiler Flag: An Attribute that "affect[s] how the compiler generates code and compresses data": <code>SetCompressor zlib</code>		:Compiler Flag: An Attribute that "affect[s] how the compiler generates code and compresses data": <code>SetCompressor zlib</code>

	:Constant: A read-only variable with built-in value. Dereferenced as a variable: $EXEPATH		:Constant: A case-insensitive, read-only variable with built-in value. Dereferenced as a variable: $EXEPATH

	:Define: A symbol ~~that is predefined or created with~~ <code>!define</code> or /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}		:Define: A symbol defined at runtime by NSIS (a Predefine), by <code>!define</code>, or by /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}

	:Function: A user-created ~~code~~ block called explicitly (user function) or automatically (Callback)		:Function: A user-created block of commands called explicitly (user function) or automatically (Callback)

	:Installer: A wizard that ~~NSIS~~ compiles from a script		:Installer: A wizard that MakeNSIS.exe compiles from a script

	:Instruction: A Function or Section command executed when your installer is run, eg, <code>FileClose $0</code>		:Instruction: A Function or Section command executed when your installer is run, eg, <code>FileClose $0</code>

	:Page: The <code>Page</code> family of commands typically specify either <code>Page custom ''creator_function'' ''leave_function''</code> or one of the internal page types, which are <code>license</code>, <code>components</code> (to select), <code>directory</code> (of installation), <code>instfiles</code> (where, installer configuration complete, the Sections are executed), <code>uninstConfirm</code>. These differ in some behaviors (e.g., <code>Section</code>s define components for the <code>components</code> page only) and the attributes that effect them. <code>LicenseText</code>'s setting, if any, is only used on the <code>license</code> page, for example		:Page: The <code>Page</code> family of commands typically specify either <code>Page custom ''creator_function'' ''leave_function''</code> or one of the internal page types, which are <code>license</code>, <code>components</code> (to select), <code>directory</code> (of installation), <code>instfiles</code> (where, installer configuration complete, the Sections are executed), <code>uninstConfirm</code>. These differ in some behaviors (e.g., <code>Section</code>s define components for the <code>components</code> page only) and the attributes that effect them. <code>LicenseText</code>'s setting, if any, is only used on the <code>license</code> page, for example

			:Plug-in: A DLL file called using form <code>DLLName::FunctionName "param1" "param2" "param3"</code>

	:Predefine: A Define with built in value. Includes four underscores in its name: ${__<''UPCASE''>__}, eg, ${__FILE__}		:Predefine: A Define with built in value. Includes four underscores in its name: ${__<''UPCASE''>__}, eg, ${__FILE__}
Line 28:		Line 32:
	:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9		:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9

	:Script: A (.nsi) text file that sets some attributes (minimally, <code>outfile</code>), usually declares/defines/assigns some symbols, then lists the pages, in order, to walk the (un)installing user through. Zero or more Functions and at least one Section follow. For increased power and flexibility, ~~plug~~-~~in DLLs~~ can be called and "header" (.nsh) scripts <code>!include</code>d		:Script: A (.nsi) text file that sets some attributes (minimally, <code>outfile</code>), usually declares/defines/assigns some symbols, then lists the pages, in order, to walk the (un)installing user through. Zero or more Functions and at least one Section follow. For increased power and flexibility, Plug-ins can be called and "header" (.nsh) scripts <code>!include</code>d

	:Section: A ~~code~~ block ~~corresponding to an installable component on~~ the ~~<code>components<~~/~~code> page~~		:Section: A block of commands "executed in order by the resulting installer." "If [Attribute] ComponentText is set, the user will have the option of disabling/enabling each visible section. If a section's name is 'Uninstall' or is prefixed with 'un.', it's an uninstaller section."

	:Symbol: General term meaning a define or variable. The taxonomy:		:Symbol: General term meaning a define or variable. The taxonomy:

â† Older revision		Revision as of 14:04, 8 August 2008
Line 1:		Line 1:
	:Callback: A ~~function~~ called by the installer at certain points in the install, eg, .onInit is called when the installer is nearly finished initializing		:Attribute: Commands that control your installer: <code>AutoCloseWindow true</code>. These are not Section or Function specific and so are specified outside them

			:Callback: A Function called by the installer at certain points in the install, eg, .onInit is called when the installer is nearly finished initializing

	:Constant: A read-only variable with built-in value. Dereferenced as a variable: $EXEPATH		:Constant: A read-only variable with built-in value. Dereferenced as a variable: $EXEPATH

	:Define: A symbol that is predefined or created with !define or /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}		:Define: A symbol that is predefined or created with <code>!define</code> or /D at the command line. Dereferenced with $ and curly brackets: ${VERSION}

	:Function: A user-created code block called explicitly (user function) or automatically (callback)		:Function: A user-created code block called explicitly (user function) or automatically (callback)
Line 9:		Line 11:
	:Installer: An executable compiled from a script		:Installer: An executable compiled from a script

	:Page: The <code>Page</code> ~~command names~~ either a <code>Page custom ''~~pagename~~''</code> or one of the internal page types, which are <code>license</code>, <code>components</code> (to select), <code>directory</code> (of installation), <code>instfiles</code> (where the ~~sections~~ are executed), <code>uninstConfirm</code>. These differ in some behaviors (e.g., <code>~~section~~</code>s define components for the <code>components</code> page only) and the attributes that effect them. <code>LicenseText</code>'s setting, if any, is only used on the <code>license</code> page, for example		:Page: The <code>Page</code> family of commands typically specify either <code>Page custom ''creator_function'' ''leave_function''</code> or one of the internal page types, which are <code>license</code>, <code>components</code> (to select), <code>directory</code> (of installation), <code>instfiles</code> (where the Sections are executed), <code>uninstConfirm</code>. These differ in some behaviors (e.g., <code>Section</code>s define components for the <code>components</code> page only) and the attributes that effect them. <code>LicenseText</code>'s setting, if any, is only used on the <code>license</code> page, for example

	:Predefine: A built-in define, eg, ${__FILE__}		:Predefine: A built-in define, eg, ${__FILE__}
Line 15:		Line 17:
	:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9		:Register: A pre-declared variable, one of $0 - $9, $R0 - $R9

	:Script: A (.nsi) text file that ~~defines~~ some ~~global~~ attributes (eg, <code>outfile</code>) ~~and, typically~~, symbols, then the pages to walk the (un)installing user through. Functions and at least one ~~section~~ follow. ~~Also~~, plug-in DLLs can be called and "header" (.nsh) scripts <code>!include</code>d		:Script: A (.nsi) text file that sets some attributes (minimally, <code>outfile</code>), usually declares/defines/assigns some symbols, then lists the pages, in order, to walk the (un)installing user through. Zero or more Functions and at least one Section follow. For increased power and flexibility, plug-in DLLs can be called and "header" (.nsh) scripts <code>!include</code>d

	:Section: A code block to allow the installing user to select and install one component via the <code>components</code> page		:Section: A code block to allow the installing user to select and install one component via the <code>components</code> page