Installation Utility - Revision history

Janne Peräaho: Extended the alternatepath explanation

2022-07-29T19:43:42Z

Extended the alternatepath explanation

← Older revision		Revision as of 19:43, 29 July 2022
Line 231:		Line 231:

	; alternatepath		; alternatepath
	: Specifies an alternative installation path. ~~For~~ example, some files ~~might~~ need to be installed into LIBS: instead of the usual destination. This feature should be used with care.		: Specifies an alternative installation path. When an alternative path has been defined, Installation Utility ignores the target directory selected in the DESTINATION page and installs the package to the alternative path location. An alternative path can be used when, for example, some files need to be installed into LIBS: instead of the usual destination. This feature should be used with care.
	: Defaults to None (i.e. no alternate path)		: Defaults to None, i.e. no alternate path.

	; files		; files

Janne Peräaho: Documented tool types

2022-07-28T11:54:42Z

Documented tool types

@@ Line 23: / Line 23: @@
 === From the Workbench ===
-Add a project icon to your script and use ''SYS:Utilities/Installation utility'' as the default tool.
+Add a project icon to your script and use ''SYS:Utilities/Installation Utility'' as the default tool.
-==== Tooltypes ====
+==== Tool Types ====
 = Example Script =

Janne Peräaho: /* NewPage */

2022-07-28T06:51:03Z

NewPage

← Older revision		Revision as of 06:51, 28 July 2022
Line 97:		Line 97:
	; WELCOME		; WELCOME
	: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.		: A message page, usually used for displaying a "welcome" message, although other uses are perfectly possible as well.
	: ''Note:'' ~~this~~ page is mandatory.		: ''Note:'' This page is mandatory.

	; FINISH		; FINISH
Line 104:		Line 104:
	; DESTINATION		; DESTINATION
	: A page to select a directory to serve as the target for the installation.		: A page to select a directory to serve as the target for the installation.
	: ''Note:'' ~~this~~ page is mandatory.		: ''Note:'' This page is mandatory.

	; PACKAGESELECT		; PACKAGESELECT

Janne Peräaho: Edited notes

2022-07-28T06:50:41Z

Edited notes

← Older revision		Revision as of 06:50, 28 July 2022
Line 108:		Line 108:
	; PACKAGESELECT		; PACKAGESELECT
	: A page for selecting packages to be installed.		: A page for selecting packages to be installed.
	: ''~~Editor's note~~:'' ~~There~~ is a ~~reservation~~ ~~for~~ a page type PACKAGESELECT~~. However, NewPage can't create a PACKAGESELECT page~~.		: ''Note:'' Installation Utility version 53.18 does not support page type PACKAGESELECT.

	; INSTALL		; INSTALL
Line 118:		Line 118:
	; PROCESSING		; PROCESSING
	: A page to display a simple progress bar for doing some Python-scripted processing.		: A page to display a simple progress bar for doing some Python-scripted processing.
	: ''~~Editor's note~~:'' ~~The~~ page has no progress bar.		: ''Note:'' On Installation Utility version 53.18 the page has no progress bar.

	; LICENSE		; LICENSE
	: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.		: A brickwall page that displays a license agreement that only lets the user continue after accepting the license.
	: ''Note:'' ~~the~~ ~~installation~~ ~~utility~~ will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".		: ''Note:'' The Installation Utility will look for a text file called "license_''languagename''.language.txt", if not found, it will look for a file called "license.txt".

	; README		; README
	: A page that displays a text file from disk for reference/README purposes.		: A page that displays a text file from disk for reference/README purposes.
	: ''Note:'' ~~the~~ Installation Utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".		: ''Note:'' The Installation Utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

	If the page cannot be generated, an OSError exception is raised.		If the page cannot be generated, an OSError exception is raised.

Janne Peräaho: /* NewPage */

2022-07-28T06:44:53Z

NewPage

← Older revision		Revision as of 06:44, 28 July 2022
Line 126:		Line 126:
	; README		; README
	: A page that displays a text file from disk for reference/README purposes.		: A page that displays a text file from disk for reference/README purposes.
	: ''Note:'' the ~~installation~~ ~~utility~~ will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".		: ''Note:'' the Installation Utility will look for a text file called "readme_''languagename''.language.txt", if not found, it will look for a file called "readme.txt".

	If the page cannot be generated, an OSError exception is raised.		If the page cannot be generated, an OSError exception is raised.

Janne Peräaho: Added note on package types ARCHIVEPACKAGE and HANDLERPACKAGE

2022-07-28T06:39:59Z

Added note on package types ARCHIVEPACKAGE and HANDLERPACKAGE

← Older revision		Revision as of 06:39, 28 July 2022
Line 199:		Line 199:
	: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.		: The type of package. This can be either FILEPACKAGE, ARCHIVEPACKAGE or HANDLERPACKAGE. A file package copies a list of files to the destination. An archive package unpacks a list of archives at the destination. Finally, a handler package is an abstract package that executes a handler when it is installed or upon certain actions.
	: This argument MUST be given.		: This argument MUST be given.
			: ''Note:'' Installation Utility version 53.18 does not support package types ARCHIVEPACKAGE and HANDLERPACKAGE.

	; name		; name

Janne Peräaho: /* SetObject */

2022-07-28T06:28:52Z

SetObject

← Older revision		Revision as of 06:28, 28 July 2022
Line 161:		Line 161:
	\| '''message''' \|\| Page's header content (plain text).		\| '''message''' \|\| Page's header content (plain text).
	\|-		\|-
	\| '''processor''' \|\| ~~On a PROCESSOR type page, names~~ a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.		\| '''processor''' \|\| Names a subroutine that will be called when the user enters the page. The subroutine must return a boolean value.
	\|}		\|}

Janne Peräaho: /* From the Command Line */

2022-07-28T04:26:01Z

From the Command Line

← Older revision		Revision as of 04:26, 28 July 2022
Line 10:		Line 10:
	=== From the Command Line ===		=== From the Command Line ===

	Installation Utility PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K		"Installation Utility" PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

	In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:		In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:

Janne Peräaho: /* Tooltypes */

2022-07-28T04:24:35Z

Tooltypes

← Older revision		Revision as of 04:24, 28 July 2022
Line 28:		Line 28:

	* BACKFILL		* BACKFILL

	-

	* LANGUAGE		* LANGUAGE

	-

	* LOGO		* LOGO

Janne Peräaho: Added command template

2022-07-28T04:23:59Z

Added command template

← Older revision		Revision as of 04:23, 28 July 2022
Line 9:		Line 9:

	=== From the Command Line ===		=== From the Command Line ===

			Installation Utility PACKAGE/A,PACKAGENAME/K,LANG=LANGUAGE/K,LOGO/K,BACKFILL/K

	In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window:		In order to run an installation from the command line, invoke the installation utility giving your script file as an argument and if you want a logo to be displayed at the top of the window: