Overview of Components | |
Components are special categories that you can define in order to group related files together. You can have as many components in a package as you want. Each component has a name, an optional description, a unique custom variable that determines whether the component is installed or not, and a file list that of course indicates the files grouped into the component. Components can be created, removed or edited using the component manager (list on the left) from the file manager window:
Components are useful if you want to group files together (for example you can group of picture files into a component called "Pictures") or in case you want to let end users decide the components that should be installed on their computer.
Component PropertiesTo edit the properties of a given component, highlight its title in the component list and press the Properties button
This window contains three tabs: "Global Properties", "Component Variable" and "Selection Dialog". Global PropertiesPaquet Builder supports linking a component to a source folder. This means that the contents of the source folder will be considered as the contents of the component; in other words, all files found in the source folder will be automatically added to the component's file list, and all files not found will be removed from the file list (optional) when the component is refreshed. It is a synchronization. This feature is useful if you want Paquet Builder to automatically manage its file lists according to the contents of the source folders. For instance, if you add files to a source folder, you do not need to also add these files to the component file list manually: just click on the "Live-Update"
Note: Paquet Builder displays a missing icon when a file is not found.
If your source files are coming from different source folders, then the path in addition to the filename of each file should be stored within the archive. When a file is unpacked, the folder corresponding to the stored path is first created and then the file is placed in it. Paquet Builder already provides global path information storing properties but if your files come from different folders, you may override these global settings using "local" ones related to the component.
Component Variable
Each component has a unique Boolean custom variable that can be set to either "1" (true) or "0" (false). When a component should be installed (i.e. its files may be extracted), the variable of that component is set to "1" (true). Otherwise the variable is set to "0" (false) and no file is extracted. Component variables should always begin by "VCOMP", and once a component is created, its associated variable is automatically listed in the Variable Manager. The value of a component variable can be set by end users thanks to the "Select Components" dialog or by the package itself thanks to custom actions (especially with the "perform operation on a variable" action type).
This option indicates whether the component should be installed or not by default: if the option is enabled, the component variable will be initialized to "1" (true) so, unless you change the variable's value yourself, the component will be installed. If you disable this option, the component will normally not be installed unless you change the value of its associated variable. By default, always leave this option turned on unless you do not plan to use the component ("main" for example) in your package. Selection DialogThis tab contains properties related to the component selection dialog box only. If you do not plan to use this dialog box in your package, then you do not need to configure these options. The component selection dialog displays a list of check boxes that let your users select the components they want to be installed on their computer. They can read a description of a given component and decide whether the latter should be installed or not by turning on/off its checkbox as you can see below:
The component title may be different from the component name (which identifies the component and will never be displayed to end users). The component title appears near the check box and consists in a short sentence that describes the group of files belonging to it, such as "Help files", "Additional Movies"...
The component description may be used to provide end users with a further description of the component and its files. "This will install the help system files and additional documentation files." is an example of what you can enter.
If you disable this option, then the component will not appear in the selection list at all. End users cannot consequently decide whether the component will be installed or not.
If you want your end users not to change the state of the component (whether it will be installed or not) and that the component remain in the selection list (the option above is not turned off), then enable this option. In this case the check box related to the component will be disabled (grayed). Paquet Builder Help - Copyright © G.D.G. Software. All rights reserved. |