Configuration company version of the InstalSystem 5: Difference between revisions

From HelpSystem
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
==Purpose==
==Purpose==
The article describes the possibilities of configuring the company version of the InstalSystem 5 package.
This article describes the possibilities of customizing the appearance of the company version of the InstalSystem 5 package.




<br clear=all>
<br clear=all>
===Splash screen===
===Splash screen===
[[File:Company_version_1.png|550 px|thumb|1. Splash screen]]
[[Plik:Company_version_11.png|350 px|thumb|1.1. Splash screen - example]]
[[Plik:Company_version_1.png|350 px|thumb|1.2. Splash screen - configuration options]]
   
   
Guidelines:
Guidelines:
*Maximum size 800x600 px.
*Separate files for the Package Manager and Editor due to different names of the software portions
*Layout and colours of graphic elements within the window:  
*Minimum size 600x400 pixels
** Package name/Editor name – main element
*Maximum size 800x600 pixels
** Space must be provided for placing dynamic texts
*File format - bitmap graphics (PNG, JPG, BMP)
** Colour of dynamic elements:
*Layout and colours of graphic elements within the window:  
**# Version
** Software name, e.g. InstalSystem 5 Manager / Editor
** Space must be provided for inserting dynamic texts
** Colour of dynamic elements (ARGB format - e.g. #AARRGGBB, where AA,RR,GG,BB are the hexadecimal values of the individual components - alpha,red,green,blue):
**#Version
**#Rev  
**#Rev  
**#Text of info on loading
**#Loading information text
**# Loading progress indicator (rotating circle) (optionally: another colour and another position in relation to 1 can be specified.)
**# Loading progress indicator (spinner) (options: change colour and position in relation to 1.)
**Optionally: another colour can be set for the splash screen of the Manager and Editor.
**Option: set different colours for the Manager and Editor splash screens.
**Optionally: the location of the dynamic texts can be specified.
**Option: select position for placing dynamic texts.
*Colours should be adjusted to the background of the splash screen to make the texts and the indicator visible.  
*All elements, except for dynamic elements (dynamic texts and loading progress indicator) should be placed in their proper positions in the layout (do not send them separately)
*Colours should match the background of the splash screen so that the text and indicator are clearly discernible.
<br clear=all>
<br clear=all>
===Manager background===
===Manager background===
[[File:Company_version_2.png|550 px|thumb|2. InstalSystem Manager - basic]]
[[Plik:Company_version_21.png|350 px|thumb|2.1. InstalSystem Manager - example]]
[[Plik:Company_version_2.png|350 px|thumb|2.2. InstalSystem Manager - basic]]


Guidelines:
Guidelines:
*Background (StartupWindowBackgroundPictureIndex) and top part (banner) (StartupWindowBannerPictureIndex + StartupWindowBannerHeight) are configured separately
*Background (identified as ''StartupWindowBackgroundPictureIndex'' in fig. 2.2.) and banner in the top part (identified as ''StartupWindowBannerPictureIndex'' in fig. 2.2.)
*Banner is drawn on top and is resized separately when the window size is changed. For this reason, it is recommended to have a transparent banner background that will match well with the main background
*File format - bitmap graphics (PNG, JPG, BMP)
*The background occupies all of the window space and it is placed under all control elements, it is therefore recommended that it has its graphics placed in the top and left-hand parts whereas the bottom right-hand part is empty or very delicate so that the texts are clearly visible.
*The banner of specified height (''StartupWindowBannerHeight'' in fig. 2.2.) is placed in the top part and is scaled separately when changing window size. The banner usually includes a logo (without its background, so the underlying background picture is not obscured)
*The graphic content of the banner/logo is scaled proportionally to the specified height.
*The background is spread over the entire window (it is scalable) and lies underneath all control elements, therefore it is recommended that it has visible graphic elements in its top and left portions, while the bottom right corner remains clear or subtle to make the text clearly discernible. The background should not include logo/banner, as it is scaled separately!
*As both graphics (banner/logo and background) are scalable, the original images should have a good resolution to avoid pixellation after rescaling. The minimum background size is 1024/768. If the banner is a separate graphic, its width should be at least 512 pixels.
<br clear=all>
<br clear=all>


===Additional Manager appearance configuration possibilities===
===Additional options for configuring Manager appearance===
[[File:Company_version_3.png|550 px|thumb|3. InstalSystem Manager - advanced]]
[[Plik:Company_version_3.png|350 px|thumb|2.3. InstalSystem Manager - advanced]]
   
   
Configuration of small buttons:
Configurable small button features:
* StartupWindowTabCorners - shape of corners in the button frame (rounded with a defined radius or square).
*shape of corners of button border(round, with specified radius, or square) - see ''StartupWindowTabCorners'' in fig. 2.3.
* StartupWindowTabBorderColor - button border colour (RGB).
*button border colour (RGB palette) - see ''StartupWindowTabBorderColor'' in fig. 2.3.
* StartupWindowTabXXXColor - button background colour (RGB).
*button background colour (RGB palette) - see ''StartupWindowTabXXXColor'' in fig. 2.3.
* StartupWindowTabBorderThickness - button border thickness.
*button border thickness - see ''StartupWindowTabBorderThickness'' in fig. 2.3.  
* StartupWindowTabUnselectedMargin- size of margin to button border
*margin size from button border - see ''StartupWindowTabUnselectedMargin'' in fig. 2.3.
* StartupWindowTabMaxWidth - button width
*button width - see ''StartupWindowTabMaxWidth'' in fig. 2.3.
Configuration of windows in the Manager:
Configuration options of inset windows in the Manager:
* StartupWindowSubTabXXXColor - colour of window switches.
*window switch colours - see ''StartupWindowSubTabXXXColor'' in fig. 2.3.  
* StartupWindowTabInteriorBorderColor - colour of window border
*inset window border colour - see ''StartupWindowTabInteriorBorderColor'' in fig. 2.3.
* StartupWindowTabInteriorBackgroundColor - colour of window background 
*window background colour - see ''StartupWindowTabInteriorBackgroundColor'' in fig. 2.3.


<br clear=all>
<br clear=all>
===Printout layout===
===Option: bar in the "About..." tab===
[[File:Company_version_4.png|550 px|thumb|4. Print compositions]]
[[Plik:Company_version_51.png|350 px|thumb|3.1. "About..." tab of the Manager]]
Printout layout other than the standard layout can be set. The layouts include groups of indicated printout pages without affecting their content and graphical style. In order to define such an expected layout, access to any InstalSystem 5 version is necessary.
[[Plik:Company_version_52.png|350 px|thumb|3.2. "About..." window of the Editor]]
*A separate graphic element can be defined as the top bar in the "About..." window
*The ratio of the longer (horizontal/graphics width) side to the shorter (vertical/graphics height) side not less than 4.
*File format - bitmap graphics (PNG, JPG, BMP)
*Example size: 1250x150 ''NOTE! These values are intended as a guide only.''
*If no graphic element is defined, the logo will be used


[[pl:Konfiguracja wersji firmowej InstalSystem 5]]
<br clear=all>
===Print compositions===
[[Plik:Company_version_4.png|550 px|thumb|4. Print compositions]]
Additional print compositions can be set up. The compositions aggregate the indicated output pages, without interfering with their contents and graphic style. To define expectations, access to InstalSystem 5 software in any version is required.
 
[[en:Configuring the InstalSystem 5 company version]]

Revision as of 09:20, 4 August 2021

Purpose

This article describes the possibilities of customizing the appearance of the company version of the InstalSystem 5 package.



Splash screen

350 px|thumb|1.1. Splash screen - example 350 px|thumb|1.2. Splash screen - configuration options

Guidelines:

  • Separate files for the Package Manager and Editor due to different names of the software portions
  • Minimum size 600x400 pixels
  • Maximum size 800x600 pixels
  • File format - bitmap graphics (PNG, JPG, BMP)
  • Layout and colours of graphic elements within the window:
    • Software name, e.g. InstalSystem 5 Manager / Editor
    • Space must be provided for inserting dynamic texts
    • Colour of dynamic elements (ARGB format - e.g. #AARRGGBB, where AA,RR,GG,BB are the hexadecimal values of the individual components - alpha,red,green,blue):
      1. Version
      2. Rev
      3. Loading information text
      4. Loading progress indicator (spinner) (options: change colour and position in relation to 1.)
    • Option: set different colours for the Manager and Editor splash screens.
    • Option: select position for placing dynamic texts.
  • All elements, except for dynamic elements (dynamic texts and loading progress indicator) should be placed in their proper positions in the layout (do not send them separately)
  • Colours should match the background of the splash screen so that the text and indicator are clearly discernible.


Manager background

350 px|thumb|2.1. InstalSystem Manager - example 350 px|thumb|2.2. InstalSystem Manager - basic

Guidelines:

  • Background (identified as StartupWindowBackgroundPictureIndex in fig. 2.2.) and banner in the top part (identified as StartupWindowBannerPictureIndex in fig. 2.2.)
  • File format - bitmap graphics (PNG, JPG, BMP)
  • The banner of specified height (StartupWindowBannerHeight in fig. 2.2.) is placed in the top part and is scaled separately when changing window size. The banner usually includes a logo (without its background, so the underlying background picture is not obscured)
  • The graphic content of the banner/logo is scaled proportionally to the specified height.
  • The background is spread over the entire window (it is scalable) and lies underneath all control elements, therefore it is recommended that it has visible graphic elements in its top and left portions, while the bottom right corner remains clear or subtle to make the text clearly discernible. The background should not include logo/banner, as it is scaled separately!
  • As both graphics (banner/logo and background) are scalable, the original images should have a good resolution to avoid pixellation after rescaling. The minimum background size is 1024/768. If the banner is a separate graphic, its width should be at least 512 pixels.


Additional options for configuring Manager appearance

350 px|thumb|2.3. InstalSystem Manager - advanced

Configurable small button features:

  • shape of corners of button border(round, with specified radius, or square) - see StartupWindowTabCorners in fig. 2.3.
  • button border colour (RGB palette) - see StartupWindowTabBorderColor in fig. 2.3.
  • button background colour (RGB palette) - see StartupWindowTabXXXColor in fig. 2.3.
  • button border thickness - see StartupWindowTabBorderThickness in fig. 2.3.
  • margin size from button border - see StartupWindowTabUnselectedMargin in fig. 2.3.
  • button width - see StartupWindowTabMaxWidth in fig. 2.3.

Configuration options of inset windows in the Manager:

  • window switch colours - see StartupWindowSubTabXXXColor in fig. 2.3.
  • inset window border colour - see StartupWindowTabInteriorBorderColor in fig. 2.3.
  • window background colour - see StartupWindowTabInteriorBackgroundColor in fig. 2.3.


Option: bar in the "About..." tab

350 px|thumb|3.1. "About..." tab of the Manager 350 px|thumb|3.2. "About..." window of the Editor

  • A separate graphic element can be defined as the top bar in the "About..." window
  • The ratio of the longer (horizontal/graphics width) side to the shorter (vertical/graphics height) side not less than 4.
  • File format - bitmap graphics (PNG, JPG, BMP)
  • Example size: 1250x150 NOTE! These values are intended as a guide only.
  • If no graphic element is defined, the logo will be used


Print compositions

550 px|thumb|4. Print compositions Additional print compositions can be set up. The compositions aggregate the indicated output pages, without interfering with their contents and graphic style. To define expectations, access to InstalSystem 5 software in any version is required.