You are currently viewing a snapshot of www.mozilla.org taken on April 21, 2008. Most of this content is highly out of date (some pages haven't been updated since the project began in 1998) and exists for historical purposes only. If there are any pages on this archive site that you think should be added back to www.mozilla.org, please file a bug.



INI file syntax


INI file contains 4 major sections. They are Local Variables, Navigation Controls, Sub Pages, Widgets.

Local Variables : These are the variables that are specific to the corresponding INI file. Local Variables allow each page to define it's own properties like title, font, caption, etc., If an INI file misses a common property like title, Wizard Machine travels up in the tree to get the corresponding value and the value thus obtained will be used as local variable. A global defaults node will be defined in the beginning (which can't be modified by the user) and it will serve as ultimate destination in case no node contains the required information.

Navigation Controls : We can make Wizard Machine to jump from one node to another node (not to it's sibling as moving to sibling is default) by mentioning information of desired transfer of control under this section. For example, if we want wizard to from a particular node to the end of the session, we can associate path to be jumped with onNext action. Similarly, we can mention the name of the help file to be loaded in this section.

Sub Pages : We have a hierarchical structure with respect to the data maintenance of CCK components. A node can contains sub nodes. For example, CCK as main node can have Shell, Install Builder, etc. as sub nodes. This information is represented under this section. When a page has no more sub pages, it is considered as a leaf node and will be displayed according to the widgets defined on the page.

Widgets : Widgets are the fields that are presented to the end user to collect the information required by the CCK wizard to create a build of customized communicator. Each widget will have standard features like name, value, coordinates, type, etc.,. One can also associate an action with a widget that can generate an event via certain actions (for example a click on button). Not every INI file will have widgets. A page with no widgets is considered as container as container page and wizard machine moves to the next/previous displayable page in the sequence as a result next/previous actions carrying the information offered by the container page.


Skeleton INI file :

[Local Varaibles]
Name=name
Title=title
Visisbility=show/hide

[Navigation Controls]
OnNext=node path
Help=help file

#Represents any sub pages under this component
 [Sub Pages]
page1=show/hide
page2=show/hide
.
.
.

#Represents all fields that go on to the dialog pertained to this page
[Widget1]
type=widget type
name=name of widget
value=value
start_X=beginning X coordinate
start_Y=beginning Y coordinate
Width=widget width
Height=widget height

.
.
.

[Widget'n']


Here is the sample INI file :

#Variables that are specific to the page. Scoped variables.
[Local Variables]
Name=page1
Title=Sample Page
Visibility=show

[Navigation Controls]
OnNext=Install Builder, Done Page
Help=Convert.txt

#Represents any sub pages under this component
 [Sub Pages]
No sub pages defined. A leaf node.

#Represents all fields that go on to the dialog pertained to this page
[Widget1]
type=Text
name=Text1
value=Converting JSC File to CFG file.
start_X=7
start_Y=15
Width=25
Height=25

[Widget2]
type=Button
name=Button1
value=Convert
start_X=23
start_Y=31
Width=63
Height=45
onClick=ce.dll, ConvertJSCtoCFG