dragonleo/NSIS
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Latest documentation by flizebogen

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@2595 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
kichik 2003-05-30 11:42:06 +00:00
parent 4637b9f327
commit 38606c296e
4 changed files with 58 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Docs/src/attributes.but
View file

@ -152,7 +152,8 @@ Valid values for flag are "smooth" (smooth the progress bar) or "colored" (color
\c install_type_name | /NOCUSTOM | ([/LANG=lang_id] /CUSTOMSTRING=str) | /COMPONENTSONLYONCUSTOM
Adds an install type to the install type list, or disables the custom install type. There can be as many as 8 types, each one specifying the name of the install. The first type is the default (generally 'Typical'). Each type is numbered, starting at 1. See SectionIn for information on how those numbers are used. If the /NOCUSTOM switch is specified, then the "custom" install type is disabled, and the user has to choose one of the pre-defined install types. Alternatively, if the /CUSTOMSTRING switch is specified, the parameter will override the "Custom" install type text. Alternatively, if the /COMPONENTSONLYONCUSTOM flag is specified, the component list will only be shown if the "Custom" install type is selected.
Adds an install type to the install type list, or disables the custom install type. There can be as many as 32 types, each one specifying the name of the install. Instead of an "hard-coded" name you can use User Variables which are processed at Runtime. This allows you to change InstType name dynamically. Another way of changing the InstType name during runtime is the \R{sinsttypesettext}{InstTypeSetText} command. The difference is that with InstTypeSetText you are saving your precious user variables. The first type is the default (generally 'Typical'). Each type is numbered, starting at 1. See SectionIn for information on how those numbers are used. If the /NOCUSTOM switch is specified, then the "custom" install type is disabled, and the user has to choose one of the pre-defined install types. Alternatively, if the /CUSTOMSTRING switch is specified, the parameter will override the "Custom" install type text. Alternatively, if the /COMPONENTSONLYONCUSTOM flag is specified, the component list will only be show
n if the "Custom" install type is selected.
\S2{alicensebkcolor} LicenseBkColor
@ -280,4 +281,5 @@ Sets whether or not the installer's icon is being displayed.
\c on|\\<b\\>off\\</b\\>
Sets whether or not an XP manifest will be added to the installer. This affects the uninstaller too.
Sets whether or not an XP manifest will be added to the installer. This affects the uninstaller too.

12
Docs/src/history.but
View file

@ -3,6 +3,12 @@
\e{v2.0b4}
\b /o Switch for \R{ssection}{Section} provides ability to unselect the section by default
\b Increased amount of InstTypes to 32
\b Added \R{ssectionsetsize}{SectionSetSize}, \R{ssectiongetsize}{SectionGetSize}, \R{ssetcurinsttype}{SetCurInstType}, \R{sgetcurinsttype}{GetCurInstType}
\b InstallOptions PlugIn: Fixed bug [ 720332 ] ">301 Characters in State of List Box Bug in InstallOptions"
\b System PlugIn: Fixed a bug with calling proc(void) and added e switch to get GetLastError return value
@ -34,10 +40,10 @@
\b \R{ainsttype}{InstType} /NOCUSTOM and /COMPONENTSONLYONCUSTOM work together
\\<b\\>Notes:\\</b\\>
\R{page}{Custom Pages} now have a leave function. As this parameter is before the caption you have to add another "" empty string for the title to work.
\R{page}{Custom Pages} now have a leave function. As this parameter is before the caption you have to add another "" empty string for the title to work. \\<br\\>
\R{onselchange}{.onSelChange} is no longer called when the components page is created
\e{v2.0b3}

43
Docs/src/sec.but
View file

@ -26,7 +26,7 @@ Sets the description for the section section_index. To set a subsection, you mus
Stores the text description of the section section_index into the output. If the section is hidden, stores an empty string. The error flag will be set if an out of range section is specified.
\S2{SectionSetInstTypes} SectionSetInstTypes
\S2{sectionsetinsttypes} SectionSetInstTypes
\c section_index inst_types
@ -40,4 +40,43 @@ because the binary value for 5 is "00000101". The error flag will be set if the
\c section_index user_var(output)
Retrieves the install types flags array of a section. See above explanation about SectionSetInstTypes for a description of how to deal with the output. The error flag will be set if the section index specified is out of range.
Retrieves the install types flags array of a section. See above explanation about SectionSetInstTypes for a description of how to deal with the output. The error flag will be set if the section index specified is out of range.
\S2{ssectionsetsize} SectionSetSize
\c section_index new_size
Sets the Size of the section specified by section_index. Note that the Index starts with Zero. The Value for Size must be entered in KiloByte and supports only whole numbers.
\S2{ssectiongetsize} SectionGetSize
\c section_index user_var
Gets the Size of the section specified by section_index and stores the value in the given User Variable. Note that the Index starts with Zero.
\S2{ssetcurinsttype} SetCurInstType
\c inst_type_idx
Sets the current InstType. The Error Flag is \\<b\\>not\\</b\\> set if an out of range InstType was used.
\S2{sgetcurinsttype} GetCurInstType
\c user_var
Get the current InstType and stores the Value in the given User Variable. The value of $\{NSIS_MAX_INST_TYPES\} (32 by default) means that the custom installation type was selected.
\S2{sinsttypesettext} InstTypeSetText
\c inst_type_idx text
Sets the Text of the specified InstType. If the Text is empty than the InstType is removed. By using a previously unused inst_type_idx number you can create new InstTypes. To add/remove Sections to this new InstType see \R{sectionsetinsttypes}{SectionSetInstTypes}. Unlike \R{sectionin}{SectionIn} the index is zero based, which means the first installation type's index is 0.
\S2{sinsttypegettext} InstTypeGetText
\c inst_type_idx user_var
Gets the Text of the specified InstType.

7
Docs/src/sections.but
View file

@ -18,9 +18,9 @@ Tells the installer that the current section needs an additional "size_kb" kilob
\S2{ssection} Section
\c [/e] [([!]|[-])section_name] [section index output]
\c [/o] [([!]|[-])section_name] [section index output]
Begins and opens a new section. If section_name is empty, omitted, or begins with a -, then it is a required section and the user will not see it, nor have the option of disabling it. If the section name is 'Uninstall', then it is a special Uninstall Section. If section index output is specified, the parameter will be !defined with the section index (that can be used for \R{sectionsettext}{SectionSetText} etc). If the section name begins with a !, the section will be displayed as bold. If /e is present, the sub sections of the section will be expanded by default.
Begins and opens a new section. If section_name is empty, omitted, or begins with a -, then it is a hidden section and the user will not have the option of disabling it. If the section name is 'Uninstall', then it is a special Uninstall Section. If section index output is specified, the parameter will be !defined with the section index (that can be used for \R{sectionsettext}{SectionSetText} etc). If the section name begins with a !, the section will be displayed as bold. If the Switch /o is specified than the Section is unselected by default.
\S2{ssectionend} SectionEnd
@ -40,4 +40,5 @@ This command inserts a subsection. The subsection must be close with SubSectionE
\S2{ssubsectionend} SubSectionEnd
Closes a subsection opened with SubSection.
Closes a subsection opened with SubSection.