Glossary: Difference between revisions

From NSIS Wiki
Jump to navigationJump to search
No edit summary
No edit summary
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  

Revision as of 14:04, 8 August 2008

Attribute: Commands that control your installer: AutoCloseWindow true. 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
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)
Installer: An executable compiled from a script
Page: The Page family of commands typically specify either Page custom creator_function leave_function or one of the internal page types, which are license, components (to select), directory (of installation), instfiles (where the Sections are executed), uninstConfirm. These differ in some behaviors (e.g., Sections define components for the components page only) and the attributes that effect them. LicenseText's setting, if any, is only used on the license page, for example
Predefine: A built-in define, 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-in DLLs can be called and "header" (.nsh) scripts !included
Section: A code block to allow the installing user to select and install one component via the components page
Symbol: General term meaning a define or variable. The taxonomy:
Symbol
Define
Predefine
User define
Variable
Constant
Register
User variable
Variable: A globally-scoped constant, register, or user variable