Glossary: Difference between revisions
From NSIS Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
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 | :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 | :Function: A user-created block of commands called explicitly (user function) or automatically (Callback) | ||
:Installer: A wizard that | :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, | :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 | :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: |
Revision as of 20:54, 18 August 2008
- Attribute: Command that configures your installer's general behavior (unlike an Instruction):
AutoCloseWindow true
. 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
- Command: Any non-comment line (possibly \-extended)
- Comment: Text enclosed in /* ... */ or prefixed with ; or #
- Compile Time Command: Always starts with a bang, eg,
!ifdef VERSION & NOVERSION !error "Warning compile-person: both VERSION and NOVERSION are defined" !endif
- Compiler Flag: An Attribute that "affect[s] how the compiler generates code and compresses data":
SetCompressor zlib
- Constant: A case-insensitive, read-only variable with built-in value. Dereferenced as a variable: $EXEPATH
- Define: A symbol defined at runtime by NSIS (a Predefine), by
!define
, 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)
- Installer: A wizard that MakeNSIS.exe compiles from a script
- Instruction: A Function or Section command executed when your installer is run, eg,
FileClose $0
- Page: The
Page
family of commands typically specify eitherPage custom creator_function leave_function
or one of the internal page types, which arelicense
,components
(to select),directory
(of installation),instfiles
(where, installer configuration complete, the Sections are executed),uninstConfirm
. These differ in some behaviors (e.g.,Section
s define components for thecomponents
page only) and the attributes that effect them.LicenseText
's setting, if any, is only used on thelicense
page, for example
- Plug-in: A DLL file called using form
DLLName::FunctionName "param1" "param2" "param3"
- 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
- Script: A (.nsi) text file that sets some attributes (minimally,
outfile
), 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!include
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."
- Symbol: General term meaning a define or variable. The taxonomy:
- Symbol
- Define
- Predefine
- User define
- Variable
- Constant
- Register
- User variable
- Define
- Symbol
- Variable: A globally-scoped constant, register, or user variable