|
|
|
Who and what is it for?
Skin developers use the skinfo.ini file to set several options to organize their skin resources and customize program behavior. It is suggested that you read through the Skin Developer Tutorial first before reading about the skinfo.ini file.
Skinfo format
Just like the skintab.rc file the skinfo.ini file is a plain text file that can be created and edited with Windows Notepad. The skinfo.ini file always starts with "[settings]" on the first line. After the first line you may enter a number of name=value pairs separated by the equal sign. The skinfo.ini file should be placed into your skin folder.
|
example skinfo.ini |
|
[settings] UseIcons=1 Template=contents.tpl |
All possible options for the skinfo.ini file are discussed below.
|
BannerFrame |
|
|
BannerFrame=banner (default) |
The name of the frame where the Favorez banner should be inserted. This option is only relevant in combination with UseFrames=1 |
|
|
|
|
FindWindow |
|
|
FindWindow=1 |
Ensures that the user closes the program with a previously generated Favorez page. This option is used for the Document (RTF) skin to suppress a Windows error message. Instead the end user is informed that any changes made to the current page will be lost. |
|
Findwindow=0 (default) |
Switch off this function. |
|
|
|
|
Folder |
|
|
Folder=Favorez Website (no default) |
Determines which favorites folder should be processed. This is a standard option available in the Settings tab of the skin Properties dialog box. This option is used for the Website skin to let end users start off with an empty list of favorites. The specified folder will be created by Favorez if it cannot be found in your IE favorites panel. |
|
|
|
|
IconBkColor |
|
|
IconBkColor={COLOR_BG} |
Sets the background color for link icons. Although Favorez icons appear to be transparent they are actually opaque. Usually you would want the icon backgound color to blend in with the background of your page. If the background of your page has a fixed color you can specify that color here using HTML syntacs, e.g.: IconBkColor=#851A9F. If you have defined a Favorez tag (e.g. COLOR_BG) to enable the end user to customize the background color then you should use that tag here as well, e.g.: IconBkColor={COLOR_BG} |
|
IconBkColor=#FFFFFF (default) |
|
|
|
|
|
IndexFile |
|
|
IndexFile=index.html (no default) |
Specifies the file to be opened by Favorez after your page has been generated. Usually you do not need to set this option, see Template= for default behavior. If your skin uses frames (UseFrames=1) then IndexFile is the file with the frames. |
|
|
|
|
RootInPaths |
|
|
RootInPaths=1 |
This option is used in conjunction with the {TPL:path} tag. Include RootInPaths=1 in your skinfo.ini file if you want Favorez to print the root name in the path to the current folder. The Root name can be adjusted by the end user in the Settings tab of the skin Properties dialog box. This option is used in the Blue Mountain skin. |
|
RootInPaths=0 (default) |
Switch off this function. |
|
|
|
|
Scheme |
|
|
Scheme=default (default) |
With this option you may set the Design that should be selected by default. Just specify the name of an existing design after Scheme=. Do not forget to ship the design file (name_of_design.scm) with your skin. The Scheme option is relevant only if you have created a Design tab for your skin. |
|
|
|
|
TargetExtension |
|
|
TargetExtension=html (default) |
After your template file has been parsed Favorez saves the file to the skin output folder. Instead of .tpl (for template) another extension is used. The default extension is .html but e.g. for the Document (RTF) skin the extension is .rtf. |
|
|
|
|
Template |
|
|
Template=index.tpl (default) |
Specifies the file to be parsed. This is the file with your {TPL:FOLDER} tags. If Template=contents.tpl then the resulting page will be named contents.html. |
|
|
|
|
TooltipText |
|
|
TooltipText=Update [name of skin] web page (default) |
Specifies the text to be displayed when your mouse hovers over the last button in the Favorez toolbar. It is the button you use to update a web page. |
|
|
|
|
TrimTree |
|
|
TrimTree=1 (default) |
Clean up redundant line feeds and spaces between favorites items. |
|
TrimTree=0 |
Switch off this function. |
|
|
|
|
UseIcons |
|
|
UseIcons=1 (default) |
Creates png graphics files using your favorites icons and copies them to the skin output folder. |
|
UseIcons=0 |
Switch off this function. |
|
|
|
|
UseFrames |
|
|
UseFrames=1 |
Indicates that your main HTML-file contains frames. |
|
UseFrames=0 (default) |
Switch off this function. |
|
|
|
|
User |
|
|
User=username |
This option is used by Favorez, please do not use it. Favorez needs to remember which user created the last page to correctly handle multi-user environments. |
The following options concern defaults for the Settings tab of the Properties dialog box. Each option can also be disabled, preventing the end user from editing that option.
Test your defaults
To see your specified defaults work it is necessary to delete the current user settings. User settings are saved to the Windows registry at the following location: HKEY_CURRENT_USER\Software\WarpGear Software\Favorez\Skins\Example 4, where "Example 4" is the name of your skin. Simply delete all registry entries below this path, then open the Favorez Properties dialog box and click the Settings tab to see your defaults in action. Naturally editing the Windows registry is at your own risk.
|
FoldersOnTop=0 (default) |
|
|
DisableFoldersOnTop=0 (default) |
|
|
|
|
|
GroupFolders=1 (default) |
|
|
DisableGroupFolders=0 (default) |
|
|
|
|
|
InclKeywords=1 (default) |
|
|
DisableInclKeywords=0 (default) |
|
|
|
|
|
LinkTarget=_blank (default) |
|
|
DisableLinkTarget=0 (default) |
|
|
|
|
|
MaxItemLength=45 (default) |
|
|
DisableMaxItemLength=0 (default) |
|
|
|
|
|
NoEmptyFolders=0 (default) |
If your skin template file (index.tpl) uses JavaScript to create a collapsible tree of favorites items then use NoEmptyFolders=1 and DisableNoEmptyFolders=1 to prevent end users from accidentally pruning a branch from their tree of favorites items. |
|
DisableNoEmptyFolders=0 (default) |
|
|
|
|
|
RootName=Main Links (default) |
|
|
DisableRootName=0 (default) |
|
|
|
|
|
Sort=0 (default) |
|
|
DisableSort=0 (default) |
|